fanyx
/
docker-tmserver
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update README.md

This commit is contained in:
ryluth 2019-05-12 22:19:06 +02:00 committed by GitHub
parent 6e02d28160
commit 6fcdf6c0e8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,33 +1,34 @@
# docker-tmserver # docker-tmserver
Docker image for simple or customizable Trackmania Nations Forever server Docker images for simple or customizable Trackmania Nations Forever server.
## How to use this image ## How to use this repo:
```docker run -e {required environment variables} -p {selected ports} fanyx/tmserver``` Run the images in this repo with `docker-compose`.
I've included a template [`docker-compose.yml`](https://github.com/ryluth/docker-tmserver/blob/master/docker-compose.yml) in this repo to get you going.
### There are several required environment variables that you need to set: ### Required:
#### tmserver:
- `$SERVER_LOGIN` | Server account login - `$SERVER_LOGIN` | Server account login
- `$SERVER_LOGIN_PASSWORD` | Server account password - `$SERVER_LOGIN_PASSWORD` | Server account password
- `$SERVER_SA_PASSWORD` | Password for SuperAdmin credential
- `$SERVER_ADM_PASSWORD` | Password for Admin credential
#### xaseco:
- `$SERVER_SA_PASSWORD` | Password for SuperAdmin credential
- `$DB_HOST` | -> subject to deletion since i'm gonna lock it down
- `$DB_LOGIN` | ^
- `$DB_LOGIN_PASSWORD` | ^
- `$DB_NAME` | ^
### Optional environment variables are: ### Optional environment variables are:
#### tmserver:
- `$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
- `$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_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`
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 ## Configuring the Trackmania server
Without manual configuration the server launches with Nadeo's default config. Without manual configuration the server launches with Nadeo's default config.
This means round based driving.
To configure the server on your own demands edit the `config.txt` file in `tmserver/GameData/Config`. To configure the server on your own demands edit the `config.txt` file in `tmserver/GameData/Config`.
To configure the tracklist edit the `playlist.txt` in `tmserver/GameData/Tracks/MatchSettings/`. To configure the tracklist edit the `playlist.txt` in `tmserver/GameData/Tracks/MatchSettings/`.
**IMPORTANT!!**
## Further information After making changes to the server configuration run `docker-compose build` to rebuild the container images, otherwise the changes won't be in effect.
You can open volumes to the Trackmania server files and Xaseco files (`docker-compose` does this per default) and edit configuration files.
This is needed since the default track playlist just runs the white Nadeo tracks so i advise examining the config volumes to adjust the track playlist.
Furthermore you can edit the Xaseco plugins to your need and adjust ingame administrator accounts and so on.