docker-gopher-server/README.md

# DockerGopherServer

This is a dockerized version of a gopher server.

## Environment-variables

Set the following variables with the -e tag.

| Name          | Usage                                               | Default     |
| ------------- | --------------------------------------------------- | ----------- |
| `SERVER_NAME` | set this to your IP/Domain (no "gopher://" needed!) | `localhost` |

## Volumes

Set the following volumes with the -v tag.

| Volume-Name    | Container mount | Description                   |
| -------------- | --------------- | ----------------------------- |
| `gopherwebdir` | `/var/gopher`   | directory for the gopher page |

## Ports

Set the following ports with the -p tag.

| Container port | Recommended outside port | Protocol | Description                  |
| -------------- | ------------------------ | -------- | ---------------------------- |
| `70`           | `70`                     | TCP      | port for the gopher-protocol |

## Example run-command

Either use the docker image `tiynger/gopherserver` or run
`docker build . -t gopherserver` in the top directory of this repository.
If so you need to change the command below apropiately
(`tiynger/gopherserver` to `gopherserver`).

`docker run --name gopherserver -v gopherwebdir:/var/gopher -p 70:70 --restart unless-stopped -e SERVER_NAME=<domain/ip_here> -d tiynger/gopherserver`