updates including README

This commit is contained in:
Hendrik Boll 2019-09-17 19:58:11 +02:00
parent 90b29439d0
commit 37233499e9
1 changed files with 26 additions and 0 deletions

26
README.md Normal file
View File

@ -0,0 +1,26 @@
# docker-tmserver
Docker image for simple or customizable Trackmania Nations Forever server
## How to use this image
```docker run -e {required environment variables} -p {selected ports} fanyx/tmserver```
### There are several required environment variables that you need to set:
- $SERVER_LOGIN | Server account login
- $SERVER_LOGIN_PASSWORD | Server account password
### Optional environment variables are:
- $SERVER_PORT | Port for server communications -> Default : 2350
- $SERVER_P2P_PORT | Port for peer2peer communication -> Default : 3450
- $SERVER_SA_PASSWORD | Password for SuperAdmin credential -> when left empty will be randomly generated
- $SERVER_ADM_PASSWORD | Password for Admin credential -> when left empty will be randomly generated
- $SERVER_NAME | Server name in ingame browser -> Default : "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
## 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.
You can adjust this file to your needs but running with docker-compose is more comfortable in general.
## Configuring the Trackmania server
Without manual configuration the server launches with Nadeo's default config.
This means round based driving.