Changeset 101 in code for trunk/README.md

Timestamp:

Oct 16, 2019, 11:41:24 AM (6 years ago)

Author:

mathieu.brunot

Message:

:memo: Add sample env var and docker doc

Signed-off-by: mathieu.brunot <mathieu.brunot@…>

File:

• trunk/README.md (modified) (1 diff)

trunk/README.md

@@ -30 +30 @@
 ```
 
+### Environment variables
+
+Morty can be configured using the following environment variables:
+- `MORTY_ADDRESS`: Listen address (default to `127.0.0.1:3000`)
+- `MORTY_KEY`: HMAC url validation key (base64 encoded) to prevent direct URL opening. Leave blank to disable validation. Use `openssl rand -base64 33` to generate.
+- `DEBUG`: Enable/disable proxy and redirection logs (default to `true`). Set to `false` to disable.
+
+### Docker
+
+```
+docker run -e DEBUG=false -e MORTY_ADDRESS=0.0.0.0:3000 -v ./rules.json:/etc/filtron/rules.json:rw dalf/morty
+```
+
+```
+docker run -e DEBUG=false -v ./rules.json:/etc/filtron/rules.json:rw dalf/morty -listen 0.0.0.0:3000
+```
+
 
 ### Test