Update README.md

This commit is contained in:
TuRz4m 2015-09-18 11:23:38 +02:00
parent 421ccb4d88
commit ae79bf320d

View file

@ -6,17 +6,20 @@ This image uses [Ark Server Tools] (https://github.com/FezVrasta/ark-server-tool
## Usage ## Usage
Fast & Easy server setup : Fast & Easy server setup :
`docker run -d -p 7778:7778 -p 27016:27016 -e SESSIONNAME=myserver -e ADMINPASSWORD="mypasswordadmin" --name ark turzam/ark` `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 : You can map the ark volume to access config files :
`docker run -d -p 7778:7778 -p 27016:27016 -e SESSIONNAME=myserver -v /my/path/to/ark:/ark --name ark turzam/ark` `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.* 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.*
You can manager your server with rcon if you map the rcon port : You can manager your server with rcon if you map the rcon port :
`docker run -d -p 7778:7778 -p 27016:27016 -p 32330:32330 -e SESSIONNAME=myserver --name ark turzam/ark` `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 and backups itself every hours: 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 27016:27016 -e SESSIONNAME=myserver -e AUTOBACKUP=60 -e AUTOUPDATE=120 --name ark turzam/ark` `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:
`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 : You can check your server with :
`docker exec ark arkmanager status` `docker exec ark arkmanager status`
@ -37,7 +40,7 @@ __You can check all available command for arkmanager__ [here](https://github.com
## Recommended Usage ## Recommended Usage
- First run - First run
`docker run -it -p 7778:7778 -p 27016:27016 -p 32330:32330 -e SESSIONNAME=myserver -e ADMINPASSWORD="mypasswordadmin" -e AUTOUPDATE=120 -e AUTOBACKUP=60 -v /my/path/to/ark:/ark --name ark turzam/ark` `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. - 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.* - Modify */my/path/to/ark/server/ShooterGame/Saved/Config/LinuxServer/GameUserSetting.ini.*
- `docker start ark` - `docker start ark`
@ -55,6 +58,10 @@ Map of your ark server (default : "TheIsland")
Password of your ark server (default : "") Password of your ark server (default : "")
+ __ADMINPASSWORD__ + __ADMINPASSWORD__
Admin password of your ark server (default : "adminpassword") Admin password of your ark server (default : "adminpassword")
+ __SERVERPORT__
Ark server port (can't rebind with docker, it doesn't work) (default : 27015)
+ __STEAMPORT__
Steam server port (can't rebind with docker, it doesn't work) (default : 7778)
+ __BACKUPONSTART__ + __BACKUPONSTART__
1 : Backup the server when the container is started. 0: no backup (default : 1) 1 : Backup the server when the container is started. 0: no backup (default : 1)
+ __UPDATEPONSTART__ + __UPDATEPONSTART__
@ -64,6 +71,9 @@ Number of minute between each check for une newer version (-1 disable auto updat
Auto update is set to --warn and warn the players 30 minutes before update (default, can be changed in /ark/arkmanager.cfg). Auto update is set to --warn and warn the players 30 minutes before update (default, can be changed in /ark/arkmanager.cfg).
+ __AUTOBACKUP__ + __AUTOBACKUP__
Number of minute between each backup (-1 disable auto backup) (default : -1) 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)
--- ---
@ -77,10 +87,16 @@ Number of minute between each backup (-1 disable auto backup) (default : -1)
--- ---
## Expose ## Expose
+ Port : __7778__ : Steam port + Port : __STEAMPORT__ : Steam port (default: 7778)
+ Port : __27016__ : server port + Port : __SERVERPORT__ : server port (default: 27015)
+ Port : __32330__ : rcon port + Port : __32330__ : rcon port
--- ---
## Roadmap
+ direct UDP socket connections rather than Steam P2P (new version v213) ?
+ Better mods handling (wait for ark server tools (branch: 1.4-dev))
---
## Known issues ## Known issues