Code Monkey home page Code Monkey logo

private-foundryvtt-server's Introduction

Private FoundryVTT server

Fight goblins, not unwelcome guests!

Private Foundry VTT server using Tailscale.

This container image enables you to run a private Foundry VTT with an emphasis on simplicity. It uses Tailscale to expose this as a private service on a Tailnet. Instead of fighting configuration and passwords, you can focus on gaming and fighting goblins.

Note: you need to have a license key to use FoundryVTT

Usage

Download and copy the Foundry distribution file to a folder that will be used for the Foundry data folder.

$ mkdir -p ~/foundrydata/
# copy file as FoundryVTT*.zip or foundryvtt.zip to ./foundrydata

Obtain a Tailscale authentication key from

https://login.tailscale.com/admin/settings/keys

Depending on your needs, set the expiration of the key, if it tags the node, etc. Make sure the ACL is set to allow access to other people in your tailnet.

After this, you can run the container. Be sure to set the TAILSCALE_AUTH_KEY value

$ podman run -d \
   --name=foundryvtt \
   -v ~/foundrydata:/data \
   --env=TAILSCALE_AUTH_KEY=tskey-auth-... \
   ghcr.io/spotsnel-gaming/private-foundryvtt-server:main

If the node joined your tailnet, it should show up as foundryvtt in:

https://login.tailscale.com/admin/machines

after which you can navigate to:

http://foundryvtt

and finish the configuration or log in.

Note

This image is available in both x86_64 (AMD64) and aarch64 (arm64) format. If you have issues during deployment, you can use the --platform=linux/amd64 or --platform=linux/arm64 to force a specific platform.

These images have been tested on various cloud providers, such as AWS, and Oracle Cloud.

Systemd

After this you can use systemd to maintain the state of the container

$ (cd $HOME/.config/systemd/user && podman generate systemd --name --files foundryvtt)
$ systemctl --user enable --now container-foundryvtt
$ loginctl enable-linger [username]

You can check the state of the container with:

 $systemctl --user status container-foundryvtt

Build

To build the Dockerfile, please do:

$ podman build -t foundryvtt .

and use podman run ... foundryvtt instead.

Author

"Gerard Braad"
@gbraad

Sponsor

Become a patron or sponsor, by simply clicking one of these buttons

Github Sponsorship

... or consider a small one-time donation to show appreciation

"Buy Me A Coffee"

PayPal Donate

private-foundryvtt-server's People

Contributors

gbraad avatar rapus95 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.