Maps to container path /data. Path to persistent directory for storing Config, Data, and Logs directories for Foundry to use.

Objetivo

/data

Unraid Server port for Foundry Virtual Tabletop server web interface

Objetivo

30000

Valor

30000

Linux/NodeJS release pre-signed URL generated from the user's profile. Required for downloading an application distribution. This method will take precedence over the FOUNDRY_USERNAME/FOUNDRY_PASSWORD method and CONTAINER_CACHE method. Alternatively, use FOUNDRY_USERNAME/FOUNDRY_PASSWORD method or CONTAINER_CACHE method. It is convenient to use this method in conjunction with CONTAINER_CACHE, the URL will download to the to CONTAINER_CACHE path and then re-use it after the URL expires.

Account username or email address for foundryvtt.com. Required for downloading an application distribution. Takes precedence over CONTAINER_CACHE. Alternatively, use FOUNDRY_RELEASE_URL or CONTAINER_CACHE

Account password for foundryvtt.com. Required for downloading an application distribution. Takes precedence over CONTAINER_CACHE. Alternatively, use FOUNDRY_RELEASE_URL or CONTAINER_CACHE

Version of Foundry Virtual Tabletop to install. This is used when you are using the USERNAME/PASSWORD method. Leave blank to install latest release. NOTE: Whatever you type here will be appended to the zip file if using CONTAINER_CACHE to store the zip. If used with RELEASE_URL this container will *not* validate that the URL matches the version you specify here.⚠️WARNING⚠️: If you leave this blank and use the USERNAME/PASSWORD option without a container cache it will upgrade to the latest foundry version on container restart! Example: 9 - Use most recent 9.x.x version; 9.255 - use most recent 9.255.x version; 9.255.0 - use exact version.

Set a path to cache downloads of the Foundry distribution archive and speed up subsequent container startups. The path should be in /data or another persistent mount point in the container. e.g.; /data/container_cache. Alternatively, use FOUNDRY_RELEASE_URL or FOUNDRY_USERNAME/FOUNDRY_PASSWORD. This method can be used in conjunction with the RELEASE_URL to use the container cache after the URL expires. The variable FOUNDRY_VERSION will be appended to the cached zip file name.

Admin password to be applied at startup. If omitted the admin password will be cleared. May be set using secrets.

The license key to install. e.g.; AAAA-BBBB-CCCC-DDDD-EEEE-FFFF If left unset, a license key will be fetched when using account authentication (USERNAME/PASSWORD method). If multiple license keys are associated with an account, one will be chosen at random. Specific licenses can be selected by passing in an integer index. The first license key being 1. May be set using secrets.

The world to startup at system start. Leave blank to launch Setup page.

Set a path to a directory of shell scripts to be sourced after Foundry is installed but before it is started. The path should be in /data or another persistent mount point in the container. e.g.; /data/container_patches Patch files are sourced in lexicographic order. CONTAINER_PATCHES are processed after CONTAINER_PATCH_URLS.

Set to a space-delimited list of URLs to be sourced after Foundry is installed but before it is started. Patch URLs are sourced in the order specified. CONTAINER_PATCH_URLS are processed before CONTAINER_PATCHES. ⚠️ Only use patch URLs from trusted sources!

Normally new options.json and admin.txt files are generated by the container at each startup. Setting this to true prevents the container from modifying these files when they exist. If they do not exist, they will be created as normal.

Por defecto

false

Valor

false

Normally the ownership of the /data directory and its contents are changed to match that of the server at startup. Setting this to a regular expression will exclude any matching paths and preserve their ownership. Note: This is a match on the whole path, not a search. This is useful if you want mount a volume as read-only inside /data (e.g.; a volume that contains assets mounted at /data/Data/assets).

Set to true to enable verbose logging for the container utility scripts.

Por defecto

false

Valor

false

An absolute or relative path that points to the awsConfig.json or true for AWS environment variable credentials evaluation usage.

Path to zip for Demo Mode. Demo mode allows you to configure a world which will be automatically launched and reset at a frequency of your choosing. When the world is reset, it is deactivated. The source data for the world is restored to its original state using a provided .zip file, and the next reset is automatically scheduled. See: Configuring demo mode.

gid the deamon will be run under.

Por defecto

foundry

Valor

foundry

A custom hostname to use in place of the host machine's public IP address when displaying the address of the game session. This allows for reverse proxies or DNS servers to modify the public address.

Allow the Foundry server to discover and report the accessibility of the host machine's public IP address and port. Setting this to false may reduce server startup time in instances where this discovery would timeout.

Por defecto

true

Valor

true

The default application language and module which provides the core translation files.

Por defecto

en.core

Valor

en.core

Override the local network address used for invitation links, mirroring the functionality of the FOUNDRY_HOSTNAME option which configures the external address.

Set to true to reduce network traffic by serving minified static JavaScript and CSS files. Enabling this setting is recommended for most users, but module developers may wish to disable it.

Por defecto

true

Valor

true

Custom salt string to be applied to the admin password instead of the default salt string. May be set using secrets.

Inform the Foundry server that the software is running behind a reverse proxy on some other port. This allows the invitation links created to the game to include the correct external port.

Indicates whether the software is running behind a reverse proxy that uses SSL. This allows invitation links and A/V functionality to work as if the Foundry server had SSL configured directly.

Por defecto

false

Valor

false

A string path which is appended to the base hostname to serve Foundry VTT content from a specific namespace. For example setting this to demo will result in data being served from http://x.x.x.x:PORT/demo/.

An absolute or relative path that points towards a SSL certificate file which is used jointly with the sslKey option to enable SSL and https connections. If both options are provided, the server will start using HTTPS automatically.

An absolute or relative path that points towards a SSL key file which is used jointly with the sslCert option to enable SSL and https connections. If both options are provided, the server will start using HTTPS automatically.

uid the daemon will be run under.

Por defecto

foundry

Valor

foundry

Allow Universal Plug and Play to automatically request port forwarding for the Foundry server port to your local network address.

Por defecto

false

Valor

false

Sets the Universal Plug and Play lease duration, allowing for the possibility of permanent leases for routers which do not support temporary leases. To define an indefinite lease duration set the value to 0.

Container TZ database name

Por defecto

UTC

Valor

UTC