Adds usage instructions to the readme
This commit is contained in:
15
README.md
15
README.md
@@ -13,3 +13,18 @@ Things it still needs:
|
||||
* Unit file to run the app
|
||||
* Configuration file for Foundry itself
|
||||
* 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).
|
||||
|
||||
Reference in New Issue
Block a user