From cda036f665d2c2172a6ddf69c6a0d2852ec81012 Mon Sep 17 00:00:00 2001 From: Pim Kunis Date: Sun, 8 Jan 2023 20:19:13 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 50 +++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 39 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e22e57f..4e58d0a 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,46 @@ -# Ansible scripts for our homeservers +# Homeservers + +This repository contains Ansible scripts to setup our home servers. +The `common` role executes some common OS tasks. +The `docker` role installs Docker. +The other roles are specifically for the various services we run. + +## Running services + +All services below are running under Docker, except NSD because I couldn't figure out how to enable IPv6 for it. + +- Authoritative DNS using [NSD](https://www.nlnetlabs.nl/projects/nsd/about/) (ns.pizzapim.nl) +- Reverse proxy using [Traefik](https://doc.traefik.io/traefik/) +- Git server using [Forgejo](https://forgejo.org/) ([git.pizzapim.nl](https://git.pizzapim.nl)) +- Static website using [Hugo](https://gohugo.io/) ([pizzapim.nl](https://pizzapim.nl)) +- File sychronisation using [Syncthing](https://syncthing.net/) +- Microblogging server using [Mastodon](https://joinmastodon.org/) ([social.pizzapim.nl](https://social.pizzapim.nl)) +- Calendar and contact synchronisation using [Radicale](https://radicale.org/v3.html) ([dav.pizzapim.nl](https://dav.pizzapim.nl)) +- KMS server using [vlmcsd](https://github.com/Wind4/vlmcsd) + +## Possible future services + +- matrix +- peertube? +- jitsi + ## TODO ### NSD -- ZSK rollover. -- I always resign the zone, even if nothing has changed. -I could check whether the zone has changed or new keys were generated but that is kind of difficult. +#### ZSK Rollover + +Could make automatic key rollovers with cron or some other tool. + +#### Idempotency + +Currently I always resign zones. +But for idempotency I should probably only do it if the zone has changed or the keys have changed. + +### Backup + +Borg backup? ### Firewall -Seems to be a little annoying with all the docker stuff - -### Matrix - -### Peertube? - -### Jitsi +A little more difficult because of docker networking but probably doable. \ No newline at end of file