Foundry VTT on Heroku
Run Foundry Virtual Tabletop on Heroku and save data to GitHub, all for free.
Getting started
- Find your license code for Foundry at https://foundryvtt.com/, under your username > Purchased Licenses
- Create a new, private GitHub repo and add a README file at https://github.com/new.
- If your repo is https://github.com/username/foundry-data then
GITHUB_REPO
should be set tousername/foundry-data
.
- If your repo is https://github.com/username/foundry-data then
- Generate a new GitHub token with the
repo
scope at https://github.com/settings/tokens/new. - Click and fill in the above details.
- Every minute the server will check for changed data files (including modules, systems and worlds) and push them to your GitHub repo.
- Enjoy your server!
Caveats
- Invitation links from in-game settings are incorrect.
- Instead just send your players a link to your Heroku URL.
- Heroku shuts down the server after 30 minutes with no activity.
- As part of the free plan Heroku servers sleep after 30 minutes of no activity.
- After the server sleeps an admin will need to launch a world again before players can join.
- The license agreement needs to be accepted each time the server launches, preventing the automatic launching of a world.
- If the GitHub repo changes while the server is running it will not be able to push the changed data files.
- If the server can't push to the
main
branch because of changes, it will create a branch callederror-
followed by a timestamp. You will then need to merge this branch with themain
branch to continue using the saved data. - If the server can't create or push the
error-
branch then you will lose the last minute of changes, and the server will automatically restart in order to prevent any more data-loss.
- If the server can't push to the