From 47f584099f7d42ba234fd18481c81b64b62854b0 Mon Sep 17 00:00:00 2001 From: owen Date: Wed, 28 Jul 2021 11:36:27 -0400 Subject: [PATCH 1/4] create readme --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..db9fbd3 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# 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 +- (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 + +## 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 person in the MOTD +- services: password to accept for services connecting over localhost, use only on the server that links to services From 6f1ce177eaf627344235d687b97b3e33f5635f95 Mon Sep 17 00:00:00 2001 From: owen Date: Wed, 28 Jul 2021 11:39:22 -0400 Subject: [PATCH 2/4] small readme changes --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) 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 From 2e8e91b171224c7ba474d8ef70522bf3ae50ffc2 Mon Sep 17 00:00:00 2001 From: owen Date: Wed, 28 Jul 2021 11:51:52 -0400 Subject: [PATCH 3/4] add caveats --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 8a14874..127f24d 100644 --- a/README.md +++ b/README.md @@ -24,3 +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 person 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` From 2b1fa5a6bd525659316157380316a1f2a3afc9c3 Mon Sep 17 00:00:00 2001 From: owen Date: Wed, 28 Jul 2021 11:55:53 -0400 Subject: [PATCH 4/4] change wording for sponsor var a little --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 127f24d..93c0fa5 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ name.of.the.server linkpass=yourreceivepassword sid=123 autoconn=other.server.na - 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 person in the MOTD +- 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