From 761f47d6b7dada2636006f1555c6f0b7c4683166 Mon Sep 17 00:00:00 2001 From: nzambello Date: Fri, 7 Jul 2023 08:25:39 +0200 Subject: [PATCH] update readme --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index eaaf160..d544043 100644 --- a/README.md +++ b/README.md @@ -22,13 +22,19 @@ open http://localhost:7878 and you will be redirected to `REDIRECT_URL` from your env. -## Configuration +### Configuration It loads configuration from environment variables: -- `REDIRECT_URL`: the url to redirect to +- `REDIRECT_URL`: (**required**) the url to redirect to - `PERMANENT`: if true, it will return a 301 status code, otherwise 302 +## Docker example + +``` +docker run -p 7878:7878 -e REDIRECT_URL=https://nzambello.dev -e PERMANENT=true nzambello/redirector:latest +``` + ## Docker compose example ```yaml