Update README

This commit is contained in:
Salt 2020-11-07 00:47:18 -06:00
parent 1a761523db
commit 6e5d07547d

View File

@ -6,9 +6,9 @@ Useful for management across all of 9iron, thefuck, and desu.
This branch is kinda-sorta a port of master, so it still needs to reach some form of feature parity with it. Namely:
* Pleroma(? How about we move to outer heaven?)
* Pleroma(? How about we just move instances? Outer heaven? Wherever the hell a1ba sits? SPC?)
* Matrix(? Do I still want to keep this around?)
* Matrix(? Do I still want to keep this around? Is there a better alternative? Will my friends even use it?)
* Basic git cloning for websites
@ -26,13 +26,11 @@ This branch is kinda-sorta a port of master, so it still needs to reach some for
* Monitoring (Doesn't necessarily have to be grafana)
* Forge server deployment? Terraria? What do I do about all these gameservers?
* Forge server deployment? Terraria? What do I do about all these gameservers? Fork 'em into their own roles? I imagine Paper's already got something set up, too.
## Initialization
* Clone the repo, `cd` in
* `ansible-galaxy install -r roles/requirements.yml`
Clone the repo, `cd` in. Done.
## Deployment
@ -53,3 +51,13 @@ Adding a new server will require the following be fulfilled:
* The server is running Ubuntu 18.04 or greater (20.04 recommended)
From there, running the playbook `site.yml` should get the machine up to snuff. To automate the host-local steps, use the script file `contrib/bootstrap.sh`.
## Ansible Galaxy
Several of the roles in this repository are sourced from Ansible Galaxy. They're mirrored here for both easy compatibility with `ansible-pull` and in case the sources go down. Despite this, they're still managed in `roles/requirements.yml` for ease of management, source tracking, and updating. Any forks or deviations from these sources should be thoroughly documented.
Should you need to reinitialize them, the following command (run from the root of the repo) will initialize all Galaxy assets:
```
ansible-galaxy install -r roles/requirements.yml
```