docker-tmserver/README.md

27 lines
1.5 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-09-17 19:40:48 +02:00
- $SERVER_LOGIN | Server account login
- $SERVER_LOGIN_PASSWORD | Server account password
2019-05-11 01:05:14 +02:00
2019-05-11 02:03:22 +02:00
### Optional environment variables are:
2019-09-17 19:40:48 +02:00
- $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
2019-05-11 01:05:14 +02:00
2019-05-11 02:01:52 +02:00
## Running this image with `docker-compose`
2019-05-11 02:37:07 +02:00
I have a default [`docker-compose.yml`](https://github.com/ryluth/docker-tmserver/blob/master/docker-compose.yml) included in this repository.
2019-05-11 01:05:14 +02:00
You can adjust this file to your needs but running with docker-compose is more comfortable in general.
2019-05-11 14:17:57 +02:00
2019-05-12 11:09:18 +02:00
## Configuring the Trackmania server
Without manual configuration the server launches with Nadeo's default config.
This means round based driving.