From 37233499e94a5a48581eda3a90e3b0fe1759b415 Mon Sep 17 00:00:00 2001 From: Hendrik Boll Date: Tue, 17 Sep 2019 19:58:11 +0200 Subject: [PATCH] updates including README --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..682d707 --- /dev/null +++ b/README.md @@ -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.