updates including README

This commit is contained in:
Hendrik Boll 2019-09-17 19:59:28 +02:00
parent 37233499e9
commit 6674d7ff7a
1 changed files with 7 additions and 1 deletions

View File

@ -5,9 +5,13 @@ Docker image for simple or customizable Trackmania Nations Forever server
```docker run -e {required environment variables} -p {selected ports} fanyx/tmserver``` ```docker run -e {required environment variables} -p {selected ports} fanyx/tmserver```
### There are several required environment variables that you need to set: ### There are several required environment variables that you need to set:
```
- $SERVER_LOGIN | Server account login - $SERVER_LOGIN | Server account login
- $SERVER_LOGIN_PASSWORD | Server account password - $SERVER_LOGIN_PASSWORD | Server account password
```
```
### Optional environment variables are: ### Optional environment variables are:
- $SERVER_PORT | Port for server communications -> Default : 2350 - $SERVER_PORT | Port for server communications -> Default : 2350
- $SERVER_P2P_PORT | Port for peer2peer communication -> Default : 3450 - $SERVER_P2P_PORT | Port for peer2peer communication -> Default : 3450
@ -16,6 +20,8 @@ Docker image for simple or customizable Trackmania Nations Forever server
- $SERVER_NAME | Server name in ingame browser -> Default : "Trackmania Server" - $SERVER_NAME | Server name in ingame browser -> Default : "Trackmania Server"
- $SERVER_COMMENT | Server description -> Default : "This is a Trackmania Server" - $SERVER_COMMENT | Server description -> Default : "This is a Trackmania Server"
- $SERVER_PASSWORD | If you want to secure your server against unwanted logins, set a server password - $SERVER_PASSWORD | If you want to secure your server against unwanted logins, set a server password
```
## Running this image with `docker-compose` ## Running this image with `docker-compose`
I have a default [`docker-compose.yml`](https://github.com/ryluth/docker-tmserver/blob/master/docker-compose.yml) included in this repository. I have a default [`docker-compose.yml`](https://github.com/ryluth/docker-tmserver/blob/master/docker-compose.yml) included in this repository.