Update README.md

This commit is contained in:
ryluth 2019-05-11 01:05:14 +02:00 committed by GitHub
parent dd34ae8939
commit 258b68cbe8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 1 deletions

View File

@ -1,2 +1,25 @@
# docker-tmserver
Docker image for simple or customizable Trackmania Nations/United Forever server
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
- `$DB_HOST` | Hostname of the MySQL-Server
- `$DB_NAME` | Name of the MySQL-Database
- `$DB_LOGIN` | Name of the database user
- `$DB_LOGIN_PASSWORD` | Password to the database user
- `$SERVER_PORT` | Port for server communications
- `$SERVER_P2P_PORT` | Port for peer2peer communications
Optional environment variables are:
- `$SERVER_SA_PASSWORD` | Password for SuperAdmin credential
- `$SERVER_ADM_PASSWORD` | Password for Admin credential
- `$SERVER_NAME` | Server name in ingame browser
- `$SERVER_COMMENT` | Server description
# Running this image with `docker-compose`
I have a default 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.