Foundry VTT
Foundry Virtual Tabletop is a self-hosted, web-based virtual tabletop for pen-and-paper role-playing games. Game master and players connect with a web browser; maps, tokens, dice, character sheets and audio/video run in one shared session.
Announcement and talks
The Foundry VTT app announcement TBA
Foundry VTT is a community application from the tebbiworld repository. Documentation and source can be found on Github
License: read this first
Foundry VTT is commercial software. You need your own purchased license from foundryvtt.com.
- The module does not contain the Foundry software. It uses the community container image felddy/foundryvtt, which downloads the software on first start with your foundryvtt.com account or a download URL from your profile.
- Each administrator enters his own account data or license key in the module settings. Nothing is shared between installations.
- The felddy image states that Foundry binds its software license to the container hostname. The module therefore sets a fixed container hostname derived from the module instance name (e.g.
foundryvtt1), so the license remains valid across restarts and updates.
What the module does
- Runs Foundry VTT as a rootless Podman container (image
ghcr.io/felddy/foundryvtt, tag14). - Publishes Foundry on a host name of your choice through the Traefik instance of the node, with optional Let's Encrypt certificate and HTTP→HTTPS redirect. Foundry uses HTTP and WebSocket over this single HTTPS host.
- The container listens on one allocated port on
127.0.0.1only. No additional ports and no dedicated IP address are required. - Foundry is informed that it runs behind an HTTPS reverse proxy on port 443, so invitation links point to
https://<host>/.
Installation
On a NethServer 8 node:
add-module ghcr.io/tebbiworld/foundryvtt:latest 1
Then open the module settings, fill in the fields (see below) and save.
First start: the container downloads the Foundry software. Depending on the connection this takes several minutes; the module allows up to 15 minutes for the start.
After the start, open https://<host>/. Foundry shows its license agreement and then asks for the administrator access key.
Settings
| Setting | Required | Description |
|---|---|---|
| Host name | yes | FQDN under which Foundry is published, e.g. foundry.example.org. Choose it before the first start. |
| Let's Encrypt certificate | no | Requests a certificate for the host name. Requires that ports 80/443 of this FQDN reach the node on which the module runs. |
| HTTP to HTTPS redirection | no | Redirects HTTP to HTTPS. |
| Software download method | yes | credentials (foundryvtt.com account) or release_url (timed download URL). |
| Foundry account / password | with credentials | foundryvtt.com login. Used to download the software and, if no license key is entered, to fetch a license automatically. |
| Presigned release URL | with release_url | Timed download URL from your foundryvtt.com profile (Purchased Software Licenses). Alternative to account credentials. |
| License key | no | Format AAAA-BBBB-CCCC-DDDD-EEEE-FFFF. If empty and account credentials are set, a license key is fetched from the account. If the account holds several licenses, the felddy image selects one at random; enter the key explicitly in this case. |
| Administrator access key | no | Protects the Foundry setup screen. Empty = no protection. |
| Foundry version | no | Specific version, e.g. 13.347. Empty = default version of the image. |
| Timezone | no | TZ name, e.g. Europe/Zurich. Default UTC. |
Secret fields (password, release URL, license key, admin key) are never displayed again after saving. The UI only shows whether a value is set. Leaving a secret field empty on a later save keeps the stored value.
Storage and backup
All Foundry data (worlds, systems, add-on modules, configuration, license, download cache) is stored in the Podman volume foundryvtt-data, mounted at /data in the container.
Backup: the module does not list the volume foundryvtt-data for the NS8 backup (no state-include.conf). An NS8 backup of this module contains only the module environment, not your worlds. Back up the volume separately until this is added to the module.
Security note: the settings, including the foundryvtt.com password, are stored in the module environment. NS8 always includes this environment in the module backup. Protect the backup destination accordingly, or use the release URL method, which stores no account password.
Updates
- Module / image: the felddy image is pinned to tag
14in the module. A new major version of the felddy image requires a module update. - Foundry software: controlled by the Foundry version field. Check system and add-on compatibility in Foundry before changing the version.
Links
- felddy/foundryvtt-docker – container image and environment variables
Disclaimer
Private hobby project, shared as-is. No warranty, no guaranteed support, use at your own risk. Unofficial community package, not affiliated with or endorsed by Foundry Gaming LLC or the felddy project. The module's own code is licensed GPL-3.0-or-later. Foundry VTT itself requires a purchased license.