Merge branch 'main' of github.com:vulpineawoo/playbook

README.md

@@ -0,0 +1,30 @@
+# 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 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
+- 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
+- services: password to accept for services connecting over localhost, use only on the server that links to services
+
+## 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`