Changeset 138 in code for trunk/README.md

Timestamp:

Apr 4, 2021, 3:55:25 AM (4 years ago)

Author:

3nprob

Message:

Update README

• Include parameters
• Remove unused Docker volume from example

File:

• trunk/README.md (modified) (2 diffs)

trunk/README.md

@@ -31 +31 @@
 ```
 
+### Usage
+
+```
+  -debug
+        Debug mode (default true)
+  -followredirect
+        Follow HTTP GET redirect
+  -ipv6
+        Allow IPv6 HTTP requests (default true)
+  -key string
+        HMAC url validation key (base64 encoded) - leave blank to disable validation
+  -listen string
+        Listen address (default "127.0.0.1:3000")
+  -proxy string
+        Use the specified HTTP proxy (ie: '[user:pass@]hostname:port'). Overrides -socks5, -ipv6.
+  -proxyenv
+        Use a HTTP proxy as set in the environment (HTTP_PROXY, HTTPS_PROXY and NO_PROXY). Overrides -proxy, -socks5, -ipv6.
+  -socks5 string
+        Use a SOCKS5 proxy (ie: 'hostname:port'). Overrides -ipv6.
+  -timeout uint
+        Request timeout (default 5)
+  -version
+        Show version
+```
+
 ### Environment variables
 
-Morty can be configured using the following environment variables:
+Morty can additionally 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.
@@ -41 +66 @@
 
 ```
-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 -e MORTY_ADDRESS=0.0.0.0:3000 dalf/morty
 ```
 
 ```
-docker run -e DEBUG=false -v ./rules.json:/etc/filtron/rules.json:rw dalf/morty -listen 0.0.0.0:3000
+docker run -e DEBUG=false dalf/morty -listen 0.0.0.0:3000
 ```