aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 4b89136dde11cdbbac40f02ee9eb596764620bae (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# Gopher (RFC 1436) Web Proxy

[![Build Status](https://cloud.drone.io/api/badges/prologic/gopherproxy/status.svg)](https://cloud.drone.io/prologic/gopherproxy)
[![CodeCov](https://codecov.io/gh/prologic/gopherproxy/branch/master/graph/badge.svg)](https://codecov.io/gh/prologic/gopherproxy)
[![Go Report Card](https://goreportcard.com/badge/prologic/gopherproxy)](https://goreportcard.com/report/prologic/gopherproxy)
[![GoDoc](https://godoc.org/git.feuerfuchs.dev/Feuerfuchs/gopherproxy?status.svg)](https://godoc.org/git.feuerfuchs.dev/Feuerfuchs/gopherproxy) 
[![Sourcegraph](https://sourcegraph.com/git.feuerfuchs.dev/Feuerfuchs/gopherproxy/-/badge.svg)](https://sourcegraph.com/git.feuerfuchs.dev/Feuerfuchs/gopherproxy?badge)

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](https://github.com/prologic/go-gopher) library.

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

## Installation
  
  $ go install git.feuerfuchs.dev/Feuerfuchs/gopherproxy/...

### Docker

Run directly from a prebuild image from the [Docker Hub](https://hub.docker.com):

```#!bash
$ docker run -p 8000:8000 prologic/gopherproxy
```

Or build your own custom image from a source checkout:

```#!bash
$ docker build -t gopherproxy .
$ docker run -p 80:80 gopherproxy -uri floodgap.com
```

## Usage

```#!bash
$ gopherproxy
```

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

## Related

Related projects:

- [go-gopher](https://github.com/prologic/go-gopher)
  go-gopher is the Gopher client and server library used by gopherproxy

- [gopherclient](https://github.com/prologic/gopherclient)
  gopherclient is a cross-platform QT/QML GUI Gopher Client
  using the gopherproxy library as its backend.

## License

MIT