Browse Source

bugfixes: README.md reformatted

master
TiynGER 1 month ago
parent
commit
fb147c5ea9
1 changed files with 17 additions and 11 deletions
  1. +17
    -11
      README.md

+ 17
- 11
README.md

@ -1,30 +1,36 @@
# DockerGopherServer # DockerGopherServer
This is a dockerized version of a gopher server. This is a dockerized version of a gopher server.
## Environment-variables ## Environment-variables
Set the following variables with the -e tag. 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 ## Volumes
Set the following volumes with the -v tag. 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 ## Ports
Set the following ports with the -p tag. 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 ## 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`).
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` `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