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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
```
ad88888ba 88 ad88
d8" "8b "" d8" ,d
Y8, 88 88
`Y8aaaaa, 8b db d8 88 MM88MMM MM88MMM
`"""""8b, `8b d88b d8' 88 88 88
`8b `8b d8'`8b d8' 88 88 88
Y8a a8P `8bd8' `8bd8' 88 88 88,
"Y88888P" YP YP 88 88 "Y888
,ad8888ba, 88
d8"' `"8b 88
d8' 88
88 ,adPPYba, 8b,dPPYba, 88,dPPYba, ,adPPYba, 8b,dPPYba,
88 88888 a8" "8a 88P' "8a 88P' "8a a8P_____88 88P' "Y8
Y8, 88 8b d8 88 d8 88 88 8PP""""""" 88
Y8a. .a88 "8a, ,a8" 88b, ,a8" 88 88 "8b, ,aa 88
`"Y88888P" `"YbbdP"' 88`YbbdP"' 88 88 `"Ybbd8"' 88
88
88
```
# Swift-Gopher
You can interact with my hosted gopher server at [gopher://gopher.navan.dev](gopher://gopher.navan.dev) or [https://gopher.navan.dev](https://gopher.navan.dev)
```
USAGE: swift-gopher [--gopher-host-name <gopher-host-name>] [--host <host>] [--port <port>] [--gopher-data-dir <gopher-data-dir>] [--disable-search] [--disable-gophermap]
OPTIONS:
-g, --gopher-host-name <gopher-host-name>
Hostname used for generating selectors (default: localhost)
-h, --host <host> (default: 0.0.0.0)
-p, --port <port> (default: 8080)
-d, --gopher-data-dir <gopher-data-dir>
Data directory to map (default: ./example-gopherdata)
--disable-search Disable full-text search feature
--disable-gophermap Disable reading gophermap files to override automatic generation
-h, --help
```
## Get Started
```
git clone https://github.com/navanchauhan
cd swift-gopher
swift build -c release && swift run swift-gopher
```
Then, you can either use lynx or curl (or other Gopher clients) to connect to the server.
```
lynx gopher://localhost:8080
# Or,
curl gopher://localhost:8080
```
**Note: Depending on user privileges, you may not be able to bind to port 70.**
To give privilege to the binary on Linux, you can use the following command:
```bash
sudo setcap CAP_NET_BIND_SERVICE=+eip ./.build/release/swift-gopher
```
## Deploying
### Systemd
Sample systemd file:
```
[Unit]
Description=Swift-Gopher
[Service]
ExecStart=/home/swift-gopher/swift-gopher/.build/release/swift-gopher --port 70 --gopher-host-name gopher.navan.dev --gopher-data-dir /home/swift-gopher/gopher_data
User=swift-gopher
Group=swift-gopher
AmbientCapabilities=CAP_NET_BIND_SERVICE
NoNewPrivileges=true
[Install]
WantedBy=multi-user.target
```
## HTTP Proxy
Although, `swift-gopher` does not currently have a native HTTP handler, you can use self host some of the following packages to proxy the Gopher server to HTTP:
* [gophper-proxy](https://github.com/muffinista/gophper-proxy) + Caddy is what I use to host the HTTPS version of my Gopher server at [https://gopher.navan.dev](https://gopher.navan.dev)
* [gopher-proxy](https://hackage.haskell.org/package/gopher-proxy)
* [gopherproxy-c](https://git.codemadness.org/gopherproxy-c/)
## TODO:
- [ ] Add Tests
- [ ] Add CI
- [ ] Add more documentation
- [ ] Automatic Versioning
- [ ] Verify Compatibility with other Gopher Clients
- [ ] Support Gemini Protocol
- [ ] Add a client library
- [ ] Add native HTTP handler
## Generating Docs
```bash
swift package --allow-writing-to-directory docs generate-documentation --transform-for-static-hosting --target swift-gopher --output-path docs --hosting-base-path swift-gopher
```
|
