diff --git a/README.md b/README.md index cc32b0e..8bf2d9d 100644 --- a/README.md +++ b/README.md @@ -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 + +### 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" + +## 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.