diff --git a/README.md b/README.md index f220a86..f16b54c 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,14 @@ Docker build for managing an ARK: Survival Evolved server. This image uses [Ark Server Tools](https://github.com/FezVrasta/ark-server-tools) to manage an ark server. *If you use an old volume, delete arkmanager.cfg to get the new configuration file.* +__Don't forget to use `docker pull turzam/ark` to get the latest version of the image__ ## Features - Easy install (no steamcmd / lib32... to install) - Use Ark Server Tools : update/install/start/backup/rcon - - Auto update (on start or on timer) - - Auto backup (on start or on timer) + - Easy crontab configuration + - Easy access to ark config file - Mods handling (via Ark Server Tools) - `Docker stop` is a clean stop @@ -21,14 +22,11 @@ Fast & Easy server setup : You can map the ark volume to access config files : `docker run -d -p 7778:7778 -p 7778:7778/udp -p 27015:27015 -p 27015:27015/udp -e SESSIONNAME=myserver -v /my/path/to/ark:/ark --name ark turzam/ark` -Then you can edit */my/path/to/ark/arkcmanager.cfg* (the values override GameUserSetting.ini) and */my/path/to/ark/server/ShooterGame/Saved/Config/LinuxServer/[GameUserSetting.ini/Game.ini]* +Then you can edit */my/path/to/ark/arkcmanager.cfg* (the values override GameUserSetting.ini) and */my/path/to/ark/[GameUserSetting.ini/Game.ini]* You can manager your server with rcon if you map the rcon port (you can rebind the rcon port with docker): `docker run -d -p 7778:7778 -p 7778:7778/udp -p 27015:27015 -p 27015:27015/udp -p 32330:32330 -e SESSIONNAME=myserver --name ark turzam/ark` -You can define a server that updates itself every 2 hours (with 1 hour warning) and backups itself every hours: -`docker run -d -p 7778:7778 -p 7778:7778/udp -p 27015:27015 -p 27015:27015/udp -e SESSIONNAME=myserver -e AUTOBACKUP=60 -e AUTOUPDATE=120 -e WARNMINUTE=60 --name ark turzam/ark` - You can change server and steam port to allow multiple servers on same host: *(You can't just rebind the port with docker. It won't work, you need to change STEAMPORT & SERVERPORT variable)* `docker run -d -p 7779:7779 -p 7779:7779/udp -p 27016:27016 -p 27016:27016/udp -p 32331:32330 -e SESSIONNAME=myserver2 -e SERVERPORT=27016 -e STEAMPORT=7779 --name ark2 turzam/ark` @@ -54,13 +52,25 @@ You can use rcon command via docker : __You can check all available command for arkmanager__ [here](https://github.com/FezVrasta/ark-server-tools/blob/master/README.md) +You can easily configure automatic update and backup. +If you edit the file `/my/path/to/ark/crontab` you can add your crontab job. +For example : +`# Update the server every hours` +`0 * * * * arkmanager update --warn --update-mods >> /ark/log/crontab.log 2&>1` + `# Backup the server each day at 00:00 ` + `0 0 * * * arkmanager backup >> /ark/log/crontab.log 2&>1` +*You can check [this website](http://www.unix.com/man-page/linux/5/crontab/) for more information on cron.* + --- ## Recommended Usage - First run `docker run -it -p 7778:7778 -p 7778:7778/udp -p 27015:27015 -p 27015:27015/udp -p 32330:32330 -e SESSIONNAME=myserver -e ADMINPASSWORD="mypasswordadmin" -e AUTOUPDATE=120 -e AUTOBACKUP=60 -e WARNMINUTE=30 -v /my/path/to/ark:/ark --name ark turzam/ark` - Wait for ark to be downloaded installed and launched, then Ctrl+C to stop the server. -- Modify */my/path/to/ark/server/ShooterGame/Saved/Config/LinuxServer/GameUserSetting.ini and Game.ini* +- Modify */my/path/to/ark/GameUserSetting.ini and Game.ini* +- Add auto update every day and autobackup by editing */my/path/to/ark/crontab* with this lines : +`0 0 * * * arkmanager update --warn --update-mods >> /ark/log/crontab.log 2&>1 + 0 0 * * * arkmanager backup >> /ark/log/crontab.log 2&>1 ` - `docker start ark` - Check your server with : `docker exec ark arkmanager status` @@ -84,11 +94,6 @@ Steam server port (can't rebind with docker, it doesn't work) (default : 7778) 1 : Backup the server when the container is started. 0: no backup (default : 1) + __UPDATEPONSTART__ 1 : Update the server when the container is started. 0: no update (default : 1) -+ __AUTOUPDATE__ -Number of minute between each check for une newer version (-1 disable auto update) (default : -1) -Auto update is set to --warn and warn the players 30 minutes before update (default, can be changed in /ark/arkmanager.cfg). -+ __AUTOBACKUP__ -Number of minute between each backup (-1 disable auto backup) (default : -1) + __WARNMINUTE__ Number of minute to warn the players when auto-update (default : 30) @@ -101,6 +106,9 @@ Number of minute to warn the players when auto-update (default : 30) + /ark/log : logs + /ark/backup : backups + /ark/arkmanager.cfg : config file + + /ark/crontab : crontab config file + + /ark/Game.ini : ark game.ini config file + + /ark/GameUserSetting.ini : ark gameusersetting.ini config file --- @@ -122,4 +130,8 @@ Number of minute to warn the players when auto-update (default : 30) + 1.1 : - Works with Ark Server Tools 1.4 [See changelog here](https://github.com/FezVrasta/ark-server-tools/releases/tag/v1.4) - Handle mods && auto update mods ++ 1.2 : + - Remove variable AUTOBACKUP & AUTOUPDATE + - Add crontab support + - You can now config crontab with the file /your/ark/path/crontab