swiftGopher

1.1.5

Star

Gopher server / client implementation written in Swift (RFC 1436 and More)

gopher gopher-protocol server swift

What's New

1.1.5

2024-03-09T02:12:31Z

Now handles Backspace and Delete characters in active connections, and keeps connection alive until \r\n \n or \r is in the request

                                                   
 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

swift-gopher : Gopher server implementation written in Swift
swiftGopherClient: Gopher client library written in Swift ( w/ Support for Network.Framework on Apple platforms)

This package also provides GopherHelpers which may be useful while building a client. A PoC client for iOS/macOS/iPadOS called iGopherBrowser uses both GopherHelpers and swiftGopherClient

You can interact with my hosted gopher server at gopher://gopher.navan.dev or 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:

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 + Caddy is what I use to host the HTTPS version of my Gopher server at https://gopher.navan.dev
gopher-proxy
gopherproxy-c

TODO:

Generating Docs

./generate_docs.sh swiftGopherClient swift-gopher GopherHelpers

Reference Documentation

Reference Documentation is hosted at https://web.navan.dev/swift-gopher

Description

Swift Tools 5.7.0

View More Packages from this Author

Dependencies

Last updated: Sat Oct 19 2024 08:38:01 GMT-0900 (Hawaii-Aleutian Daylight Time)