gopherproxy

README

Gopher (RFC 1436) Web Proxy

gopherproxy is a Gopher (RFC 1436) Web Proxy that acts as a gateway into Gopherspace by proxying standard Web HTTP requests to Gopher requests of the target server.

gopherproxy is written in Go (#golang) using the go-gopher library.

Demo: https://gopher.mills.io/

Installation

$ go install git.mills.io/prologic/gopherproxy/cmd/gopherproxy

Docker

Run directly from a prebuild image from the Docker Hub:

$ docker run -p 8000:8000 prologic/gopherproxy

Or build your own custom image from a source checkout:

$ docker build -t gopherproxy .
$ docker run -p 80:80 gopherproxy -uri floodgap.com

Usage

$ gopherproxy

Then simply visit: http://localhost/gopher.floodgap.com

Related

Related projects:

• go-gopher go-gopher is the Gopher client and server library used by gopherproxy

• gopherclient gopherclient is a cross-platform QT/QML GUI Gopher Client using the gopherproxy library as its backend.

License

MIT

Documentation

Index

• Variables
• func FullVersion() string
• func GopherHandler(tpl *template.Template, robotsdata *robotstxt.RobotsData, uri string) http.HandlerFunc
• func ListenAndServe(bind, robotsfile, uri string) error
• func RobotsTxtHandler(robotstxtdata []byte) http.HandlerFunc
• type Item

Variables

var (
	// Version release version
	Version = "0.0.1"

	// Commit will be overwritten automatically by the build system
	Commit = "HEAD"
)

Functions

func FullVersion

func FullVersion() string

FullVersion display the full version and build

func GopherHandler

func GopherHandler(tpl *template.Template, robotsdata *robotstxt.RobotsData, uri string) http.HandlerFunc

GopherHandler returns a Handler that proxies requests to the specified Gopher server as denoated by the first argument to the request path and renders the content using the provided template. The optional robots parameters points to a robotstxt.RobotsData struct to test user agents against a configurable robotst.txt file.

func ListenAndServe

func ListenAndServe(bind, robotsfile, uri string) error

ListenAndServe creates a listening HTTP server bound to the interface specified by bind and sets up a Gopher to HTTP proxy proxying requests as requested and by default will prozy to a Gopher server address specified by uri if no servers is specified by the request. The robots argument is a pointer to a robotstxt.RobotsData struct for testing user agents against a configurable robots.txt file.

func RobotsTxtHandler

func RobotsTxtHandler(robotstxtdata []byte) http.HandlerFunc

RobotsTxtHandler returns the contents of the robots.txt file if configured and valid.

Types

type Item

type Item struct {
	Link template.URL
	Type string
	Text string
}