From d066de14c408671d8a8f6aca135e6b5ed2628497 Mon Sep 17 00:00:00 2001 From: Marten <43725244+Tiyn@users.noreply.github.com> Date: Fri, 13 Nov 2020 13:17:05 +0100 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 467b471..8e11e78 100644 --- a/README.md +++ b/README.md @@ -4,23 +4,27 @@ 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= -d tiynger/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= -d tiynger/gopherserver`