gopher-proxy 0.1.0.0 → 0.1.0.1

raw patch · 3 files changed

+42/−2 lines, 3 files

Files

• ChangeLog.md +4/−0
• README.md +33/−0
• gopher-proxy.cabal +5/−2

@@ -1,5 +1,9 @@ # Revision history for gopher-proxy +## 0.1.0.1  -- 2017-01-04++* Updated package metadata+ ## 0.1.0.0  -- 2017-01-04  * First version. Released on an unsuspecting world.

@@ -0,0 +1,33 @@+# gopher-proxy++gopher-proxy is a tiny [wai](https://hackage.haskell.org/package/wai) application running on top of [warp](https://hackage.haskell.org/package/warp). It acts as a gopher-over-http proxy for a specific server, e. g. to http-ify a gopher space.++## Usage++Example usage:++    gopher-proxy --host foo.org --http-port 8080++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).+`--default-mime-type` | Mime type to use if spacecookie can't guess it, defaults to "application/octet-stream"+`--timeout`           | Timeout when connecting in milliseconds, defaults to 10 seconds.++## Things to keep in mind++* Your gopher server must send UTF-8-encoded gopher menus+* gopher-proxy might misinterpret certain content, because of the context-sensitive nature of gopher+* gopher-proxy does not support Gopher+++## Roadmap++[ ] Add Logging

@@ -2,7 +2,7 @@ -- documentation, see http://haskell.org/cabal/users-guide/  name:                gopher-proxy-version:             0.1.0.0+version:             0.1.0.1 synopsis:            proxy gopher over http description:         A simple gopher-over-http proxy to http-ify gopher spaces. license:             GPL-3@@ -11,9 +11,12 @@ maintainer:          git@lukasepple.de category:            Network build-type:          Simple-extra-source-files:  ChangeLog.md cabal-version:       >=1.10 data-files:          gopher-proxy.css+extra-source-files:  ChangeLog.md+                     README.md+homepage:            https://github.com/sternenseemann/gopher-proxy+bug-reports:         https://github.com/sternenseemann/gopher-proxy/issues  executable gopher-proxy   main-is:             Main.hs