playbook/README.md

32 lines
1.7 KiB
Markdown
Raw Normal View History

2021-07-28 15:39:22 +00:00
# va-playbook
2021-07-28 15:36:27 +00:00
ansible playbook for solanum that supports hosts running debian or alpine
## setup
- add new host to your hosts file
2021-07-28 15:39:22 +00:00
- run `solanum.yml` on new host to compile solanum
2021-07-28 15:36:27 +00:00
- (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
2021-07-28 15:39:22 +00:00
- repeat steps periodically for network maintainance
2021-07-28 15:36:27 +00:00
## hosts ini
everything except the server name, `linkpass`, and `sid` are optional and have sane defaults
2021-07-28 15:39:22 +00:00
`
2021-10-29 21:02:30 +00:00
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'
2021-07-28 15:39:22 +00:00
`
2021-07-28 15:36:27 +00:00
- 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
- paport: port for other servers to use for linking
- pahost: hostname for other servers to use for linking
- ansible_host: hostname for ansible to use
- sponsor: put a little 'server donated by' message in the MOTD
2021-07-28 15:36:27 +00:00
- services: password to accept for services connecting over localhost, use only on the server that links to services
2021-10-29 21:02:30 +00:00
- description: description for server in whois etc
2021-07-28 15:51:52 +00:00
## 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
- this playbook currently only supports each server having one server set to `autoconn`