From 258b68cbe8e12e8a8134044a156e0e190fd33441 Mon Sep 17 00:00:00 2001 From: ryluth <38672086+ryluth@users.noreply.github.com> Date: Sat, 11 May 2019 01:05:14 +0200 Subject: [PATCH 1/4] Update README.md --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cc32b0e..8106abb 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 + - `$SERVER_PORT` | Port for server communications + - `$SERVER_P2P_PORT` | Port for peer2peer communications + +Optional environment variables are: + - `$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 + +# 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. From b8061bd5730b45c9079df75c9bb3842dc7c296cd Mon Sep 17 00:00:00 2001 From: ryluth <38672086+ryluth@users.noreply.github.com> Date: Sat, 11 May 2019 02:01:52 +0200 Subject: [PATCH 2/4] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8106abb..5dc1241 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # docker-tmserver Docker image for simple or customizable Trackmania Nations Forever server -# How to use this image +## 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: @@ -20,6 +20,6 @@ Optional environment variables are: - `$SERVER_NAME` | Server name in ingame browser - `$SERVER_COMMENT` | Server description -# Running this image with `docker-compose` +## 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. From e552d08036fb87dee6b338bf057b3f768ad64f4a Mon Sep 17 00:00:00 2001 From: ryluth <38672086+ryluth@users.noreply.github.com> Date: Sat, 11 May 2019 02:03:22 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5dc1241..fd228a1 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ 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: +### 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 @@ -14,7 +14,7 @@ There are several required environment variables that you need to set: - `$SERVER_PORT` | Port for server communications - `$SERVER_P2P_PORT` | Port for peer2peer communications -Optional environment variables are: +### Optional environment variables are: - `$SERVER_SA_PASSWORD` | Password for SuperAdmin credential - `$SERVER_ADM_PASSWORD` | Password for Admin credential - `$SERVER_NAME` | Server name in ingame browser From 1eb9bd71b379270b3ab33c297b293243e1069377 Mon Sep 17 00:00:00 2001 From: ryluth <38672086+ryluth@users.noreply.github.com> Date: Sat, 11 May 2019 02:08:45 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fd228a1..8bf2d9d 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,14 @@ Docker image for simple or customizable Trackmania Nations Forever 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 ### Optional environment variables are: - - `$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 + - `$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.