Browse Source

minor structural changes to readme

master
TiynGER 9 months ago
parent
commit
6bbc83a384
1 changed files with 9 additions and 14 deletions
  1. +9
    -14
      README.md

+ 9
- 14
README.md

@ -1,31 +1,26 @@
# 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 |
| 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 |
| 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 |
| Container port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ---------------------------- |
| 70 | 70 | TCP | port for the gopher-protocol |
## Example run-command
``` docker run --name gopherserver -v gopherwebdir:/var/gopher -p 70:70 --restart unless-stopped -e SERVER_NAME=<domain/ip_here> -d tiynger/gopherserver ```

Loading…
Cancel
Save