diff --git a/README.md b/README.md index db9fbd3..8a14874 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,21 @@ -# va playbook +# va-playbook ansible playbook for solanum that supports hosts running debian or alpine ## setup - add new host to your hosts file -- run `solanum.yml` on new host +- run `solanum.yml` on new host to compile solanum - (optional) add your `ssl.pem` and `ssl.key` to `/home/ircd/ircd/etc/`. you probably want to make a cronjob for acme to automatically do this when the cert expires - run config.yml on the whole network +- repeat steps periodically for network maintainance ## hosts ini everything except the server name, `linkpass`, and `sid` are optional and have sane defaults -``` + +` name.of.the.server linkpass=yourreceivepassword sid=123 autoconn=other.server.name paport=6697 pahost=name.accessable.by.other.hosts ansible_host=name.accessable.by.playbook sponsor='nice person' services=linkpass -``` +` + - linkpass: password to receive from other linking servers. preferrably use something random for each one - sid: the Server ID for the server to use, in the format `[0-9][A-Z0-9][A-Z0-9]` - autoconn: server name to autoconnect to in the `connect {}` block