jshaver/goldilocks.js
1
0
Fork 0
forked from coolaj86/goldilocks.js
Code Issues Pull Requests Releases Wiki Activity

changed formatting for several of the code blocks

Browse Source
This commit is contained in:
tigerbot 2017-07-26 11:32:33 -06:00
parent 388ce522ae
commit 49474fd413
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -22,10 +22,10 @@ Install Standalone
# v1 in npm # v1 in npm
npm install -g goldilocks 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 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 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) The HTTP system handles plain http (TLS / SSL is handled by the tls system)
``` ```yml
http: http:
trust_proxy: true # allow localhost, 192.x, 10.x, 172.x, etc to set headers 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 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: Example config:
``` ```yml
http: http:
modules: modules:
- name: static - name: static
@ -135,7 +135,7 @@ port The port on said system to which the request will be proxied
Example config: Example config:
``` ```yml
http: http:
modules: modules:
- name: proxy - name: proxy
@ -168,7 +168,7 @@ to The new URL path which should be used.
Example config: Example config:
``` ```yml
http: http:
modules: modules:
- name: proxy - name: proxy
@ -272,14 +272,14 @@ or traffic sniffing to determine how the connection should be handled.
It has the following options: It has the following options:
```yml ```
bind An array of numeric ports on which to bind bind An array of numeric ports on which to bind
ex: 80 ex: 80
``` ```
Example Config Example Config
``` ```yml
tcp: tcp:
bind: bind:
- 22 - 22
@ -308,7 +308,7 @@ address The destination hostname and port
Example Config Example Config
``` ```yml
tcp: tcp:
bind: bind:
- 22 - 22
@ -340,7 +340,7 @@ servernames An array of string servernames that should be captured as the tu
Example config: Example config:
``` ```yml
tunnel_server: tunnel_server:
secret: abc123def456ghi789 secret: abc123def456ghi789
servernames: 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 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. SOHO servers.
``` ```yaml
mdns: mdns:
disabled: false disabled: false
port: 5353 port: 5353