document description in readme

This commit is contained in:
xfnw 2021-10-29 17:02:30 -04:00
parent 0c9020a744
commit e2c6986c76

View file

@ -13,7 +13,7 @@ ansible playbook for solanum that supports hosts running debian or alpine
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 description='very good server'
`
- linkpass: password to receive from other linking servers. preferrably use something random for each one
@ -24,6 +24,7 @@ name.of.the.server linkpass=yourreceivepassword sid=123 autoconn=other.server.na
- ansible_host: hostname for ansible to use
- sponsor: put a little 'server donated by' message in the MOTD
- services: password to accept for services connecting over localhost, use only on the server that links to services
- description: description for server in whois etc
## caveats
- ini seems to have horrible variable typing, so weird things can happen like `sid=2E5` turning into `sid=200000` (even if you quote it, wtf). use yaml for your hosts file if you need strict typing