From 1bd7e5c0e77f141453a91b4ed5e7cb51569bd339 Mon Sep 17 00:00:00 2001 From: teutat3s Date: Mon, 6 Nov 2023 21:34:50 +0100 Subject: [PATCH] docs: clean up --- docs/deploying.md | 13 +++++++++-- docs/mailman.md | 21 +++++++++++++++++ hosts/flora-6/README.md | 50 ----------------------------------------- 3 files changed, 32 insertions(+), 52 deletions(-) create mode 100644 docs/mailman.md delete mode 100644 hosts/flora-6/README.md diff --git a/docs/deploying.md b/docs/deploying.md index 010192a..43e748f 100644 --- a/docs/deploying.md +++ b/docs/deploying.md @@ -2,10 +2,19 @@ We use [deploy-rs](https://github.com/serokell/deploy-rs) to deploy changes. Currently this process is not automated, so configuration changes will have to be manually deployed. -To deploy, make sure you have a [working development shell](./development-shell.md). Then, run deploy-rs with the hostname of the server you want to deploy: +To deploy, make sure you have a [working development shell](./development-shell.md). Then, run `deploy-rs` with the hostname of the server you want to deploy: +For nachtigall.pub.solar: ``` deploy '.#nachtigall' ``` -You'll need to have SSH Access to the box to be able to do this. +For flora-6.pub.solar: +``` +deploy '.#flora-6' +``` + +You'll need to have SSH Access to the boxes to be able to do this. + +### SSH access +Ensure your SSH public key is in place [here](./public-keys/admins.nix) and was deployed by someone with access. diff --git a/docs/mailman.md b/docs/mailman.md new file mode 100644 index 0000000..8ac07d5 --- /dev/null +++ b/docs/mailman.md @@ -0,0 +1,21 @@ +# Mailman on NixOS docs + +- add reverse DNS record for IP + +Manual setup done for mailman, adapted from https://nixos.wiki/wiki/Mailman: + +``` +# Add DNS records in infra repo using terraform: + +# https://git.pub.solar/pub-solar/infra-vintage/commit/db234cdb5b55758a3d74387ada0760e06e166b9d + +# Generate initial postfix_domains.db and postfix_lmtp.db databases for Postfix + +sudo -u mailman mailman aliases + +# Create a django superuser account + +sudo -u mailman-web mailman-web createsuperuser + +# Followed outlined steps in web UI +``` diff --git a/hosts/flora-6/README.md b/hosts/flora-6/README.md deleted file mode 100644 index 4600605..0000000 --- a/hosts/flora-6/README.md +++ /dev/null @@ -1,50 +0,0 @@ -# Deploy infra branch to flora-6 - -Use this command after updating flake inputs to update services on `flora-6`. - -``` -deploy --skip-checks --confirm-timeout 300 --targets '.#flora-6' - -An alternative, if deployment always fails and rolls back. - -``` - -deploy --skip-checks --magic-rollback false --auto-rollback false --targets '.#flora-6' - -``` - -# SSH access to flora-6 -Ensure your SSH public key is in place [here](./users/barkeeper/default.nix) and -was deployed by someone with access. - -``` - -ssh barkeeper@flora-6.pub.solar - -``` - -# Mailman on NixOS docs - -- add reverse DNS record for IP - -Manual setup done for mailman, adapted from https://nixos.wiki/wiki/Mailman: - -``` - -# Add DNS records in infra repo using terraform: - -# https://git.pub.solar/pub-solar/infra/commit/db234cdb5b55758a3d74387ada0760e06e166b9d - -# Generate initial postfix_domains.db and postfix_lmtp.db databases for Postfix - -sudo -u mailman mailman aliases - -# Create a django superuser account - -sudo -u mailman-web mailman-web createsuperuser - -# Followed outlined steps in web UI - -``` - -```