Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixes instrumenting of cron to preserve environment variables. #17

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixes instrumenting of cron to preserve environment variables. #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 47 additions & 48 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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, get the new arkmanager.cfg in the template directory.*
*If you use an old volume, get the new arkmanager.cfg in the template directory.*
__Don't forget to use `docker pull turzam/ark` to get the latest version of the image__


Expand All @@ -14,74 +14,74 @@ __Don't forget to use `docker pull turzam/ark` to get the latest version of the
- Easy crontab configuration
- Easy access to ark config file
- Mods handling (via Ark Server Tools)
- `Docker stop` is a clean stop
- `Docker stop` is a clean stop

## Usage
Fast & Easy server setup :
Fast & Easy server setup :
`docker run -d -p 7778:7778 -p 7778:7778/udp -p 27015:27015 -p 27015:27015/udp -e SESSIONNAME=myserver -e ADMINPASSWORD="mypasswordadmin" --name ark turzam/ark`

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`
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/arkmanager.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 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 change server and steam port to allow multiple servers on same host:
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`
`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`

You can check your server with :
`docker exec ark arkmanager status`
You can check your server with :
`docker exec ark arkmanager status`

You can manually update your mods:
`docker exec ark arkmanager update --update-mods`
You can manually update your mods:
`docker exec ark arkmanager update --update-mods`

You can manually update your server:
`docker exec ark arkmanager update --force`
You can manually update your server:
`docker exec ark arkmanager update --force`

You can force save your server :
`docker exec ark arkmanager saveworld`
You can force save your server :
`docker exec ark arkmanager saveworld`

You can backup your server :
`docker exec ark arkmanager backup`
You can backup your server :
`docker exec ark arkmanager backup`

You can upgrade Ark Server Tools :
`docker exec ark arkmanager upgrade-tools`
You can upgrade Ark Server Tools :
`docker exec ark arkmanager upgrade-tools`

You can use rcon command via docker :
`docker exec ark arkmanager rconcmd ListPlayers`
You can use rcon command via docker :
`docker exec ark arkmanager rconcmd ListPlayers`
*Full list of available command [here](http://steamcommunity.com/sharedfiles/filedetails/?id=454529617&searchtext=admin)*

__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 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.*

To add mods, you only need to change the variable ark_GameModIds in *arkmanager.cfg* with a list of your modIds (like this `ark_GameModIds="987654321,1234568"`). If UPDATEONSTART is enable, just restart your docker or use `docker exec ark arkmanager update --update-mods`.

---

## 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`
- 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.
- Edit */my/path/to/ark/GameUserSetting.ini and Game.ini*
- Edit */my/path/to/ark/arkserver.cfg* to add mods and configure warning time.
- 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`
- 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`
- Check your server with :
`docker exec ark arkmanager status`

---
---

## Variables
+ __SESSIONNAME__
Expand All @@ -98,12 +98,12 @@ Ark server port (can't rebind with docker, it doesn't work) (default : 27015)
Steam server port (can't rebind with docker, it doesn't work) (default : 7778)
+ __BACKUPONSTART__
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)
+ __UPDATEONSTART__
1 : Update the server when the container is started. 0: no update (default : 1)
+ __BACKUPONSTOP__
1 : Backup the server when the container is stopped. 0: no backup (default : 0)
+ __WARNONSTOP__
1 : Warn the players before the container is stopped. 0: no warning (default : 0)
1 : Warn the players before the container is stopped. 0: no warning (default : 0)
+ __TZ__
Time Zone : Set the container timezone (for crontab). (You can get your timezone posix format with the command `tzselect`. For example, France is "Europe/Paris").
+ __UID__
Expand All @@ -112,7 +112,7 @@ UID of the user used. Owner of the volume /ark
GID of the user used. Owner of the volume /ark


---
---

## Volumes
+ __/ark__ : Working directory :
Expand All @@ -128,7 +128,7 @@ GID of the user used. Owner of the volume /ark
+ /ark/template/crontab : default config file for crontab
+ /ark/staging : default directory if you use the --downloadonly option when updating.

---
---

## Expose
+ Port : __STEAMPORT__ : Steam port (default: 7778)
Expand All @@ -142,14 +142,14 @@ GID of the user used. Owner of the volume /ark
---

## Changelog
+ 1.0 :
+ 1.0 :
- Initial image : works with Ark Server tools 1.3
- Add auto-update & auto-backup
+ 1.1 :
- Add auto-update & auto-backup
+ 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
- Remove variable AUTOBACKUP & AUTOUPDATE
- Remove variable WARNMINUTE (can now be find in arkmanager.cfg)
- Add crontab support
- You can now config crontab with the file /your/ark/path/crontab
Expand All @@ -164,4 +164,3 @@ GID of the user used. Owner of the volume /ark
- Added support for automatically updating on restart
- Show a spinner when updating
- Add UID & GID to set the uid & gid of the user used in the container (and permissions on the volume /ark)

29 changes: 25 additions & 4 deletions run.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ function stop {
echo "[Backup on stop]"
arkmanager backup
fi
if [ ${WARNONSTOP} -eq 1 ];then
if [ ${WARNONSTOP} -eq 1 ];then
arkmanager stop --warn
else
arkmanager stop
Expand Down Expand Up @@ -42,7 +42,7 @@ cp /home/steam/crontab /ark/template/crontab



if [ ! -d /ark/server ] || [ ! -f /ark/server/arkversion ];then
if [ ! -d /ark/server ] || [ ! -f /ark/server/arkversion ];then
echo "No game files found. Installing..."
mkdir -p /ark/server/ShooterGame/Saved/SavedArks
mkdir -p /ark/server/ShooterGame/Content/Mods
Expand All @@ -52,7 +52,7 @@ if [ ! -d /ark/server ] || [ ! -f /ark/server/arkversion ];then
# Create mod dir
else

if [ ${BACKUPONSTART} -eq 1 ] && [ "$(ls -A server/ShooterGame/Saved/SavedArks/)" ]; then
if [ ${BACKUPONSTART} -eq 1 ] && [ "$(ls -A server/ShooterGame/Saved/SavedArks/)" ]; then
echo "[Backup]"
arkmanager backup
fi
Expand All @@ -63,8 +63,29 @@ fi
CRONNUMBER=`grep -v "^#" /ark/crontab | wc -l`
if [ $CRONNUMBER -gt 0 ]; then
echo "Loading crontab..."

# Generate the crontab with the necessary environment variables added.
(
cat <<EOF
SESSIONNAME=$SESSIONNAME
SERVERMAP=$SERVERMAP
SERVERPASSWORD=$SERVERPASSWORD
ADMINPASSWORD=$ADMINPASSWORD
SERVERPORT=$SERVERPORT
STEAMPORT=$STEAMPORT
BACKUPONSTART=$BACKUPONSTART
UPDATEONSTART=$UPDATEONSTART
BACKUPONSTOP=$BACKUPONSTOP
WARNONSTOP=$WARNONSTOP
TZ=$TZ
UID=$UID
GID=$GID
EOF
) > /tmp/steam.crontab
cat /ark/crontab >> /tmp/steam.crontab

# We load the crontab file if it exist.
crontab /ark/crontab
crontab /tmp/steam.crontab
# Cron is attached to this process
sudo cron -f &
else
Expand Down