foundry vtt #6

Supports: bionic
Add to new model

Description

Foundry VTT is a standalone application built for experiencing multiplayer tabletop RPGs
using a feature-rich and modern self-hosted application where your players connect
directly through the browser.


FoundryVtt Charm

Overview

Foundry VTT is a standalone application built for experiencing multi player tabletop RPGs
using a feature-rich and modern self-hosted application where your players connect directly
through the browser. See https://foundryvtt.com/ for details.

Quickstart

Deploy the charm and attach the foundry.zip file for Linux.

juju deploy cs:~pirate-charmers/foundryvtt
juju attach-resource foundryvtt foundryvtt=./foundry.zip

At this time the foundry.zip file is downloaded from your account on
https://foundryvtt.com. FoundryVTT is currently in a pre-release
stage and the requirement to attach the zip file may be mitigated in the future as the
software gains other distribution methods.

After the install settles FoundryVTT will be available at the units IP address on port 30000.
Other than testing, Foundry should always be run behind a proxy and this charm supports
HAProxy. You can deploy and relate HAProxy with.

juju deploy cs:~pirate-charmers/haproxy
juju add-relation foundryvtt haproxy

This will make FounryVTT available at the subdomain foundry on HAProxy on port 443. You can
connect at https://foundry.<haproxyip>. Serving Foundry via TLS on port 443 will requires a
certificate which the HAProxy charm can register for you via letsencrypt. See the HAProxy charm for details.

For local testing you can use the following bundle to deploy to a
local provider and test out FoundryVTT before deploying to your final server.

series: bionic
applications:
    foundry:
        charm: cs:~pirate-charmers/foundryvtt
        num_units: 1
        options:
            proxy_port: 80
        resources:
            foundryvtt: ./foundryvtt-0.5.5.zip
    haproxy:
        charm: cs:~pirate-charmers/haproxy
        num_units: 1
relations:
- - haproxy:reverseproxy
  - foundry:reverseproxy

Place your foundryvtt.zip file in the same folder as the above bundle.yaml and
deploy with juju deploy ./bundle.yaml

You can access using xip.io at: http://<haproxyip>.xip.io

There are config settings on this charm to allow some customization of the proxy
configuration.
- proxy_subdomain: Can be used to customize the subdomain if you run multiple servers.
- proxy_port: Can be set to 80 if you do not want to use TLS but is highly discouraged as
your user credentials will not be encrypted if you do this.
- proxy_via_fqdn: Setting to false will register the IP instead of the fqdn with HAProxy.
This is useful if you are installing in an environment that lacks DNS but has static IP
assignments.
- custom_data_path: Allows you to move the data directory to another location, a network
mount or large 2nd drive for example. This can be changed post-deployment but the folder
must exist it will not be created for you.

Contact


Configuration

custom_data_path
(string) A custom location to move the data directory to. This can be useful if you want to store your data directory on network mount or seperate disk.
node_repo
(string) Repository to install node from
https://deb.nodesource.com/
node_repo_key
(string) The public key for node ppa
-----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v1 Comment: GPGTools - https://gpgtools.org mQINBFObJLYBEADkFW8HMjsoYRJQ4nCYC/6Eh0yLWHWfCh+/9ZSIj4w/pOe2V6V+ W6DHY3kK3a+2bxrax9EqKe7uxkSKf95gfns+I9+R+RJfRpb1qvljURr54y35IZgs fMG22Np+TmM2RLgdFCZa18h0+RbH9i0b+ZrB9XPZmLb/h9ou7SowGqQ3wwOtT3Vy qmif0A2GCcjFTqWW6TXaY8eZJ9BCEqW3k/0Cjw7K/mSy/utxYiUIvZNKgaG/P8U7 89QyvxeRxAf93YFAVzMXhoKxu12IuH4VnSwAfb8gQyxKRyiGOUwk0YoBPpqRnMmD Dl7SdmY3oQHEJzBelTMjTM8AjbB9mWoPBX5G8t4u47/FZ6PgdfmRg9hsKXhkLJc7 C1btblOHNgDx19fzASWX+xOjZiKpP6MkEEzq1bilUFul6RDtxkTWsTa5TGixgCB/ G2fK8I9JL/yQhDc6OGY9mjPOxMb5PgUlT8ox3v8wt25erWj9z30QoEBwfSg4tzLc Jq6N/iepQemNfo6Is+TG+JzI6vhXjlsBm/Xmz0ZiFPPObAH/vGCY5I6886vXQ7ft qWHYHT8jz/R4tigMGC+tvZ/kcmYBsLCCI5uSEP6JJRQQhHrCvOX0UaytItfsQfLm EYRd2F72o1yGh3yvWWfDIBXRmaBuIGXGpajC0JyBGSOWb9UxMNZY/2LJEwARAQAB tB9Ob2RlU291cmNlIDxncGdAbm9kZXNvdXJjZS5jb20+iQI4BBMBAgAiBQJTmyS2 AhsDBgsJCAcDAgYVCAIJCgsEFgIDAQIeAQIXgAAKCRAWVaCraFdigHTmD/9OKhUy jJ+h8gMRg6ri5EQxOExccSRU0i7UHktecSs0DVC4lZG9AOzBe+Q36cym5Z1di6JQ kHl69q3zBdV3KTW+H1pdmnZlebYGz8paG9iQ/wS9gpnSeEyx0Enyi167Bzm0O4A1 GK0prkLnz/yROHHEfHjsTgMvFwAnf9uaxwWgE1d1RitIWgJpAnp1DZ5O0uVlsPPm XAhuBJ32mU8S5BezPTuJJICwBlLYECGb1Y65Cil4OALU7T7sbUqfLCuaRKxuPtcU VnJ6/qiyPygvKZWhV6Od0Yxlyed1kftMJyYoL8kPHfeHJ+vIyt0s7cropfiwXoka 1iJB5nKyt/eqMnPQ9aRpqkm9ABS/r7AauMA/9RALudQRHBdWIzfIg0Mlqb52yyTI IgQJHNGNX1T3z1XgZhI+Vi8SLFFSh8x9FeUZC6YJu0VXXj5iz+eZmk/nYjUt4Mtc pVsVYIB7oIDIbImODm8ggsgrIzqxOzQVP1zsCGek5U6QFc9GYrQ+Wv3/fG8hfkDn xXLww0OGaEQxfodm8cLFZ5b8JaG3+Yxfe7JkNclwvRimvlAjqIiW5OK0vvfHco+Y gANhQrlMnTx//IdZssaxvYytSHpPZTYw+qPEjbBJOLpoLrz8ZafN1uekpAqQjffI AOqW9SdIzq/kSHgl0bzWbPJPw86XzzftewjKNbkCDQRTmyS2ARAAxSSdQi+WpPQZ fOflkx9sYJa0cWzLl2w++FQnZ1Pn5F09D/kPMNh4qOsyvXWlekaV/SseDZtVziHJ Km6V8TBG3flmFlC3DWQfNNFwn5+pWSB8WHG4bTA5RyYEEYfpbekMtdoWW/Ro8Kmh 41nuxZDSuBJhDeFIp0ccnN2Lp1o6XfIeDYPegyEPSSZqrudfqLrSZhStDlJgXjea JjW6UP6txPtYaaila9/Hn6vF87AQ5bR2dEWB/xRJzgNwRiax7KSU0xca6xAuf+TD xCjZ5pp2JwdCjquXLTmUnbIZ9LGV54UZ/MeiG8yVu6pxbiGnXo4Ekbk6xgi1ewLi vGmz4QRfVklV0dba3Zj0fRozfZ22qUHxCfDM7ad0eBXMFmHiN8hg3IUHTO+UdlX/ aH3gADFAvSVDv0v8t6dGc6XE9Dr7mGEFnQMHO4zhM1HaS2Nh0TiL2tFLttLbfG5o QlxCfXX9/nasj3K9qnlEg9G3+4T7lpdPmZRRe1O8cHCI5imVg6cLIiBLPO16e0fK yHIgYswLdrJFfaHNYM/SWJxHpX795zn+iCwyvZSlLfH9mlegOeVmj9cyhN/VOmS3 QRhlYXoA2z7WZTNoC6iAIlyIpMTcZr+ntaGVtFOLS6fwdBqDXjmSQu66mDKwU5Ek fNlbyrpzZMyFCDWEYo4AIR/18aGZBYUAEQEAAYkCHwQYAQIACQUCU5sktgIbDAAK CRAWVaCraFdigIPQEACcYh8rR19wMZZ/hgYv5so6Y1HcJNARuzmffQKozS/rxqec 0xM3wceL1AIMuGhlXFeGd0wRv/RVzeZjnTGwhN1DnCDy1I66hUTgehONsfVanuP1 PZKoL38EAxsMzdYgkYH6T9a4wJH/IPt+uuFTFFy3o8TKMvKaJk98+Jsp2X/QuNxh qpcIGaVbtQ1bn7m+k5Qe/fz+bFuUeXPivafLLlGc6KbdgMvSW9EVMO7yBy/2JE15 ZJgl7lXKLQ31VQPAHT3an5IV2C/ie12eEqZWlnCiHV/wT+zhOkSpWdrheWfBT+ac hR4jDH80AS3F8jo3byQATJb3RoCYUCVc3u1ouhNZa5yLgYZ/iZkpk5gKjxHPudFb DdWjbGflN9k17VCf4Z9yAb9QMqHzHwIGXrb7ryFcuROMCLLVUp07PrTrRxnO9A/4 xxECi0l/BzNxeU1gK88hEaNjIfviPR/h6Gq6KOcNKZ8rVFdwFpjbvwHMQBWhrqfu G3KaePvbnObKHXpfIKoAM7X2qfO+IFnLGTPyhFTcrl6vZBTMZTfZiC1XDQLuGUnd sckuXINIU3DFWzZGr0QrqkuE/jyr7FXeUJj9B7cLo+s/TXo+RaVfi3kOc9BoxIvy /qiNGs/TKy2/Ujqp/affmIMoMXSozKmga81JSwkADO1JMgUy6dApXz9kP4EE3g== =CLGF -----END PGP PUBLIC KEY BLOCK-----
proxy_port
(int) External port to request from the proxy. Default to 443 for TLS
443
proxy_subdomain
(string) Subdomain to register with reverse proxy
foundry
proxy_via_fqdn
(boolean) Regsiter the proxy via fqdn, if set to false ip address will be used instead.
True