diff --git a/README.md b/README.md index 9944e24..8c5345f 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,10 @@ Install Standalone # v1 in npm npm install -g goldilocks -# master in git (via ssh) +# v1 in git (via ssh) npm install -g git+ssh://git@git.daplie.com:Daplie/goldilocks.js#v1 -# master in git (unauthenticated) +# v1 in git (unauthenticated) npm install -g git+https://git@git.daplie.com:Daplie/goldilocks.js#v1 ``` @@ -73,7 +73,7 @@ Goldilocks has several core systems, which all have their own configuration and The HTTP system handles plain http (TLS / SSL is handled by the tls system) -``` +```yml http: trust_proxy: true # allow localhost, 192.x, 10.x, 172.x, etc to set headers allow_insecure: false # allow non-https even without proxy https headers @@ -108,7 +108,7 @@ root The path to serve as a string. Example config: -``` +```yml http: modules: - name: static @@ -135,7 +135,7 @@ port The port on said system to which the request will be proxied Example config: -``` +```yml http: modules: - name: proxy @@ -168,7 +168,7 @@ to The new URL path which should be used. Example config: -``` +```yml http: modules: - name: proxy @@ -272,14 +272,14 @@ or traffic sniffing to determine how the connection should be handled. It has the following options: -```yml +``` bind An array of numeric ports on which to bind ex: 80 ``` Example Config -``` +```yml tcp: bind: - 22 @@ -308,7 +308,7 @@ address The destination hostname and port Example Config -``` +```yml tcp: bind: - 22 @@ -340,7 +340,7 @@ servernames An array of string servernames that should be captured as the tu Example config: -``` +```yml tunnel_server: secret: abc123def456ghi789 servernames: @@ -363,7 +363,7 @@ Although it does not announce itself, Goldilocks is discoverable via mDNS with t This is so that it can be easily configured via Desktop and Mobile apps when run on devices such as a Raspberry Pi or SOHO servers. -``` +```yaml mdns: disabled: false port: 5353