small readme changes

This commit is contained in:
owen 2021-07-28 11:39:22 -04:00 committed by GitHub
parent 47f584099f
commit 6f1ce177ea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,18 +1,21 @@
# va playbook # va-playbook
ansible playbook for solanum that supports hosts running debian or alpine ansible playbook for solanum that supports hosts running debian or alpine
## setup ## setup
- add new host to your hosts file - 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 - (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 - run config.yml on the whole network
- repeat steps periodically for network maintainance
## hosts ini ## hosts ini
everything except the server name, `linkpass`, and `sid` are optional and have sane defaults 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 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 - 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]` - 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 - autoconn: server name to autoconnect to in the `connect {}` block