diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/README.md b/README.md index 58c48c7..04e407c 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,16 @@ gopher-proxy is a tiny [wai](https://hackage.haskell.org/package/wai) applicatio Example usage: - gopher-proxy --host foo.org --http-port 8080 --css-path ./gopher-proxy.css + gopher-proxy --host foo.org --http-port 8080 -In this particular example, gopher-proxy would proxy the foo.org gopher server, bind its http service on `127.0.0.1:8080` (to be proxied to by another web server like `nginx`) and use the specified css file. +In this particular example, gopher-proxy would proxy the foo.org gopher server and bind its http service on `127.0.0.1:8080` (to be proxied to by another web server like `nginx`). There are these additional flags which allow tweaking of exact behavior as well: option | meaning ------------------|-------------------------------------------------------------------------------------------------------- `--port` | The port of the gopher server, defaults to `70` +`--css-url` | Use some specific css file instead of the default one. `--css-url` | The http path of the css file, defaults to `/gopher-proxy.css` (should be changed, if your gopher server has a file with the same name `--base-url` | The path of the directory which will appear as root directory of gopher-proxy to the user, defaults to `/`. Should be changed if you configured your proxying web server to expose gopher-proxy as, say `/gopher-space/`. `--listen-public` | If this flag is set, gopher-proxy will accept connections on its public IP address(es). |