From 112fdc54f4b987516a5f9469d2f055a36025097c Mon Sep 17 00:00:00 2001 From: Dmitry Sichkar <20076745+dmmeteo@users.noreply.github.com> Date: Sun, 7 Jan 2024 16:07:58 +0200 Subject: [PATCH] update readme file --- README.md | 23 +++++++++-------------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7768106..cbec9b5 100644 --- a/README.md +++ b/README.md @@ -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/) -[![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/) +# Shlink Web Client with Basic HTTP Auth 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 - SHLINK_SERVER_URL: The fully qualified URL for the Shlink server. - SHLINK_SERVER_API_KEY: The API key. - 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_USERS: A comma separated list of users in the form of `user:password` (default: shlink:shlink). +- SHLINK_SERVER_URL: The fully qualified URL for the Shlink server. +- SHLINK_SERVER_API_KEY: The API key. +- 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_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 -[2]: https://shlink.io \ No newline at end of file +[1]: https://hub.docker.com/r/dmmeteo/docker-shlink-web-client +[2]: https://shlink.io