david/foundry-vtt-config
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adds usage instructions to the readme

Browse Source
This commit is contained in:
David Underwood
2021-03-10 12:05:02 -05:00
parent fb29257adf
commit 51f8ced5ab
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -13,3 +13,18 @@ Things it still needs:
* Unit file to run the app * Unit file to run the app
* Configuration file for Foundry itself * Configuration file for Foundry itself
* A data directory for Foundry to use * A data directory for Foundry to use
# Usage instructions
## Assumptions
* You already have a VPS running and DNS records pointing your desired domain at it.
* You have a valid SSH key for your root user configured in your SSH agent.
* You have Ansible installed and are reasonably familiar with it.
## Steps
Create a copy of the example variables file `cp variables.yml.example variables.example` and change the domain name to the correct value.
Run the playbook against your server, e.g. `ansible-playbook foundry_playbook.yml -i vtt.vidja.social,` (Note the comma after the domain, this tells ansible it's an address and not an inventory file).