update readme

This commit is contained in:
Nicola Zambello 2023-07-07 08:25:39 +02:00
parent 09f3e623a8
commit 761f47d6b7
Signed by: nzambello
GPG key ID: 56E4A92C2C1E50BA

View file

@ -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