n/docker-shlink-web-client
1
0
Fork 0
mirror of https://github.com/dmmeteo/docker-shlink-web-client.git synced 2025-05-01 00:32:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

update readme file

Browse Source
This commit is contained in:
Dmitry Sichkar 2024-01-07 16:07:58 +02:00
parent cb0294d8fe
commit 112fdc54f4
1 changed files with 9 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,11 +1,6 @@
# Shlink Web Client with Basic HTTP Auth [![Docker build images](https://github.com/dmmeteo/docker-shlink-web-client/actions/workflows/docker.yml/badge.svg)](https://github.com/dmmeteo/docker-shlink-web-client/actions/workflows/docker.yml)
[![Docker Pulls](https://img.shields.io/docker/pulls/dmmeteo/shlink-web-client.svg)](https://hub.docker.com/r/dmmeteo/shlink-web-client/) # Shlink Web Client with Basic HTTP Auth
[![Docker Stars](https://img.shields.io/docker/stars/dmmeteo/shlink-web-client.svg)](https://hub.docker.com/r/dmmeteo/shlink-web-client/)
[![Docker Build](https://img.shields.io/docker/automated/dmmeteo/shlink-web-client.svg)](https://hub.docker.com/r/dmmeteo/shlink-web-client/)
[![Docker Build Status](https://img.shields.io/docker/build/dmmeteo/shlink-web-client.svg)](https://hub.docker.com/r/dmmeteo/shlink-web-client/)
[![Docker Image Size](https://img.shields.io/microbadger/image-size/dmmeteo/shlink-web-client.svg)](https://hub.docker.com/r/dmmeteo/shlink-web-client/)
[![Docker Image Layers](https://img.shields.io/microbadger/layers/dmmeteo/shlink-web-client.svg)](https://hub.docker.com/r/dmmeteo/shlink-web-client/)
This repository adds Basic HTTP Auth to the web client of [Shlink][2]. This repository adds Basic HTTP Auth to the web client of [Shlink][2].
@ -13,11 +8,11 @@ For further documentation see [the official Shlink Dockerhub page][1].
## Environment variables ## Environment variables
SHLINK_SERVER_URL: The fully qualified URL for the Shlink server. - SHLINK_SERVER_URL: The fully qualified URL for the Shlink server.
SHLINK_SERVER_API_KEY: The API key. - SHLINK_SERVER_API_KEY: The API key.
SHLINK_SERVER_NAME: The name to be displayed. Defaults to Shlink if not provided. - SHLINK_SERVER_NAME: The name to be displayed. Defaults to Shlink if not provided.
SHLINK_BASIC_AUTH_NAME: The name to be displayed in the basic auth dialog (default: Shlink). - SHLINK_BASIC_AUTH_NAME: The name to be displayed in the basic auth dialog (default: Shlink).
SHLINK_BASIC_AUTH_USERS: A comma separated list of users in the form of `user:password` (default: shlink:shlink). - SHLINK_BASIC_AUTH_USERS: A comma separated list of users in the form of `user:password` (default: shlink:shlink).
[1]: https://hub.docker.com/r/dmmeteo/shlink-web-client [1]: https://hub.docker.com/r/dmmeteo/docker-shlink-web-client
[2]: https://shlink.io [2]: https://shlink.io