README.rst

cgod

cgod is a Gopher Daemon with a similar feature set to Gophernicus and Motsognir and is fully "Dockerized" with Docker. cgod is written in Python using the circuits Application Framework.

Full documentation can be found on Gopherspace at:

gopher://daisy.shortcircuit.net.au/1~prologic/projects/cgod/

Installation

Either pull the prebuilt Docker image:

$ docker pull prologic/cgod

Or install from the development repository:

$ git clone https://github.com/prologic/cgod
$ cd cgod
$ pip install .

Usage

Using Docker:

$ docker run -d 70:70 -v /var/gopher:/var/gopher -H domain.com -r /var/gopher

Or via a local install:

# cgod -H domain.com -r /var/gopher

Note

It is important to configure the -H/--hostname properly and set

this to the hostname that remote Gopher clients will connect to your Gopher server with.

For other configuration options:

$ docker run prologic/cgod --help

or:

$ cgod --help

A path to a configuration file can also be specified with the -c/--config option. The file format is INI-style and takes all of the same long options as the command-line.

Example Configuration:

[globals]
rootdir = '/var/gopher'
host = 'domain.com'

Demo

A full production version of cgod can be found at the following Gopher URI:

gopher://daisy.shortcircuit.net.au/

This is configured and managed with the following fig <http://fig.sh> configuration:

cgod:
    image: prologic/cgod
    environment:
      - CGOD_HOST=arrow.shortcircuit.net.au
      - CGOD_ROOTDIR=/var/gopher
    volumes:
      - /home:/home
      - /var/gopher:/var/gopher
    ports:
      - "70:70"