Docker for a Foundry dedicated server

Table of contents

• Docker Run command
• Docker Compose command
• Backup & recovery
• Environment variables Game settings
• Environment variables Backup settings
• Environment variables for the User PUID/GUID
• Environemnt variables for the beta branch

This is a Docker container to help you get started with hosting your own Foundry dedicated server.

This Docker container has been tested and will work on the following OS:

• Linux (Ubuntu/Debian)

This is my first Docker image ever created I am always open to improving it!

Tip

Add environment variables so that you can for example change the password of the server On the bottom you will find a list of all environment variables to change, if you want to use your own app.cfg file set the CUSTOM_CONFIG to true Here are all the possible changes from the devs link

Important

The first server start can take a few minutes! If you are stuck in the logs on this part just be a bit more patient:

wine: created the configuration directory '/home/foundry/.wine'
002c:fixme:actctx:parse_depend_manifests Could not find dependent assembly L"Microsoft.Windows.Common-Controls" (6.0.0.0)
004c:fixme:actctx:parse_depend_manifests Could not find dependent assembly L"Microsoft.Windows.Common-Controls" (6.0.0.0)
0054:fixme:actctx:parse_depend_manifests Could not find dependent assembly L"Microsoft.Windows.Common-Controls" (6.0.0.0)
0054:err:ole:StdMarshalImpl_MarshalInterface Failed to create ifstub, hr 0x80004002
0054:err:ole:CoMarshalInterface Failed to marshal the interface {6d5140c1-7436-11ce-8034-00aa006009fa}, hr 0x80004002
0054:err:ole:apartment_get_local_server_stream Failed: 0x80004002
0054:err:ole:start_rpcss Failed to open RpcSs service
004c:err:ole:StdMarshalImpl_MarshalInterface Failed to create ifstub, hr 0x80004002
004c:err:ole:CoMarshalInterface Failed to marshal the interface {6d5140c1-7436-11ce-8034-00aa006009fa}, hr 0x80004002
004c:err:ole:apartment_get_local_server_stream Failed: 0x80004002
0090:err:winediag:gnutls_process_attach failed to load libgnutls, no support for encryption
0090:err:winediag:process_attach failed to load libgnutls, no support for pfx import/export
0098:err:winediag:gnutls_process_attach failed to load libgnutls, no support for encryption

Docker Run

This will create the folders './server' and './data' in your current folder where you execute the code

Recommendation: Create a folder before executing this docker command

To deploy this docker project run:

docker run -d \
    --name foundry \
    -p 3724:3724/udp \    
    -p 27015:27015/udp \
    -v ./server:/home/foundry/server_files \
    -v ./data:/home/foundry/persistent_data \
    -e TZ=Europe/Paris \
    -e SERVER_PWD=change_me
    -e SERVER_NAME='Foundry docker by Luxusburg'
    -e PAUSE_SERVER_WHEN_EMPTY=false
    -e MAX_TRANSFER_RATE=8192
    luxusburg/docker-foundry:latest

Docker compose Deployment

This will create the folders './server' and './data' in your current folder where you execute combose file

Recommendation: Create a folder before executing the docker compose file

Important

Older docker compose version needs this line before the services: line

version: '3'

---
services:
  foundry:
    container_name: foundry
    image: luxusburg/docker-foundry:latest
    network_mode: bridge
    environment:
      - TZ=Europe/Paris
      - WORLD_NAME='worldname'
      - SERVER_PWD=change_me
      - PAUSE_SERVER_WHEN_EMPTY=false
      - AUTOSAVE_INTERVAL=300
      - SERVER_IS_PUBLIC=true
      - SERVER_PORT=3724
      - SERVER_QUERY_PORT=27015
      - SERVER_NAME='Foundry docker by Luxusburg'
      - SERVER_MAX_PLAYERS=10
      - MAX_TRANSFER_RATE=8192
      - CUSTOM_CONFIG=false
      - BACKUPS=true
      - BACKUP_INTERVAL=0 * * * *
      - BACKUP_RETENTION=10
    volumes:
      - ./server:/home/foundry/server_files:rw
      - ./data:/home/foundry/persistent_data:rw
    ports:
      - 3724:3724/udp
      - 27015:27015/udp
    restart: unless-stopped

Backup & recovery

Backups are all saved in the folder you set in your volume for /location/of/folder:/mnt/foundry/persistentdata There should be a folder in it called backup.

Per Default backups are activated and done every hour of the day you can change this by looking at the environment variables further below.

Important

This command will overwrite your current save files! Copy/backup the files before overwriting them!

If you want to recover a backup you need to stop the container and unzip the files into your folder /location/of/folder with this command for example tar -xzvf /location/of/folder/backup/foundry-backup-DATE_AND_TIME_OF_BACKUP_YOU_WANT_TO_USE.tar.gz -C /location/of/folder/

Environment variables Game settings

You can use these environment variables for your game settings:

Variable	Key	Description
TZ	Europe/Paris	timezone
WORLD_NAME	optional save name for map	Sets the server world name. This is the folder where the save files will be stored.
SERVER_PWD	optional password	Sets the server password.
PAUSE_SERVER_WHEN_EMPTY	optional: true or false	Will the server pause when nobody is connected.
AUTOSAVE_INTERVAL	optional in seconds	Sets the autosave frequency in seconds.
SERVER_IS_PUBLIC	optional: true of false	Sets whether the server is listed on the Steam server browser.
SERVER_PORT	optional	Sets the network port used by the game. Default is 3724.
SERVER_QUERY_PORT	optional	Sets the network port used by the Steam server browser to query information about the game. This is only used if the server is set to public. Default is 27015.
SERVER_NAME	optional	This is the name of the server listed in the Steam server browser.
MAP_SEED	optional	Sets the map seed used to generate the world.
SERVER_MAX_PLAYERS	optional	This sets the max amount of players on a server.
MAX_TRANSFER_RATE	optional default: 1024 max: 8192	Change transfer rate of the server data
CUSTOM_CONFIG	optional: true or false	Set this to true if the server should only accept you manual adapted app.cfg file

Environment variables Backup settings

Warning

For BACKUP_INTERVAL do not set double or single quotes : "" or ''

Variable	Key	Description
BACKUPS	true (default) or false	Activate backups
BACKUP_INTERVAL	default: 0 * * * *	Cron schedule value for the backups
BACKUP_RETENTION	default: 30 min: 1	Sets how many days the backups should be kept

Environment variables for the User PUID/GUID

Variable	Key	Description
PUID	default: 1000	User ID
PGUID	default: 1000	Group ID

Environemnt variables for the beta branch

Variable	Key	Description
BETANAME	no default value	Set the beta branch name. Don't use "" or ''!
BETAPASSWORD	no default value	Set the beta branch password. Don't use "" or ''!