docker-tmserver/README.md

26 lines
1.3 KiB
Markdown
Raw Normal View History

2019-05-09 14:21:12 +02:00
# docker-tmserver
2019-05-11 01:05:14 +02:00
Docker image for simple or customizable Trackmania Nations Forever server
2019-05-11 02:01:52 +02:00
## How to use this image
2019-05-11 01:05:14 +02:00
```docker run -e {required environment variables} -p {selected ports} fanyx/tmserver```
2019-05-11 02:03:22 +02:00
### There are several required environment variables that you need to set:
2019-05-11 01:05:14 +02:00
- `$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
2019-05-11 02:03:22 +02:00
### Optional environment variables are:
2019-05-11 01:05:14 +02:00
- `$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
2019-05-11 02:01:52 +02:00
## Running this image with `docker-compose`
2019-05-11 01:05:14 +02:00
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.