Skip to content

README.md

Latest commit

 

History

History
130 lines (77 loc) · 3.52 KB

README.md

File metadata and controls

130 lines (77 loc) · 3.52 KB

Foundry VTT - Docker

Forked from the archived BenjaminPrice/fvtt-docker project to support modern Foundry versions.

Foundry VTT - Docker

This repository hosts the Foundry VTT Dockerfile for thisisbrady/fvtt-docker on Docker Hub.

Foundry VTT is a virtual tabletop for playing tabletop RPG games such as Dungeons & Dragons 5e.

I've also included a basic docker-compose.yaml file which you can use to get things up and running quickly.

Note

At the request of the author of Foundry VTT, the source code for Foundry VTT is not included in this image.

You will need to manually download the zip file from your Foundry VTT account on the official Foundry VTT website.

Recommended Hosting

I recommend you host your server on a dedicated server. They can be quite cheap.

Installation

Prerequisites

Instructions

Step 0 - Install Prerequisites

Ensure you have both Docker and Docker Compose installed by following the directions in the links above.

Step 1 - Download the docker-compose.yaml file

Manually download it or use the command below

wget https://raw.githubusercontent.com/BenjaminPrice/fvtt-docker/master/docker-compose.yaml

Step 2 - Download the Foundry VTT Zip File

  • Navigate to your User Profile page and find your Software Download Links on your license page.
  • Download the Node.js version.
  • Save it to the same directory as the docker-compose.yaml file from the previous step.

Step 3 - Create your data directory

This directory is where your games, images, etc will all be stored and persisted when the docker container is restarted.

Either manually create the directory or use this shell command (linux/mac/WSL only) to create the directory in your user home:

mkdir $HOME/foundryvtt-data/

Step 4 - Create your app directory (optional)

This is where you can place your custom login screen. You only need to perform this step if you want a custom login screen on foundryVTT.

Either manually create the directory or use this shell command (linux/mac/WSL only) to create the directory in your user home:

mkdir $HOME/foundryvtt-app/

Step 5 - Modify the docker-compose.yaml file

Set your data directory by modifying this line:

- /path/to/your/foundry/data/directory:/data/foundryvtt

Example:

- /home/player1/foundryvtt-data:/data/foundryvtt

Set your download directory (where you saved your zip file) by modifying this line:

- /path/to/your/foundry/zip/file:/host

Example:

- /home/player1/downloads:/host

Set your app directory (where the app and login screen resides) by modifying this line:

- /path/to/your/foundry/app/file:/opt/foundryvtt/resources/app

Example:

- /home/player1/foundryvtt-app:/opt/foundryvtt/resources/app

Step 6 - Run the server

docker-compose up -d

Step 7 - Access the server

Navigate to your server in your webbrowser (by IP address, is recommended)

http://127.0.0.1:30000/

Replace 127.0.0.1 with your own IP address.

Step 8 - Customize your login screen

you can customize your login screen using a fix such as this one: prettier login screen