From 8892ff6f2673a622f4a3cf67ea610bf3000b3f60 Mon Sep 17 00:00:00 2001 From: Kalle Struik Date: Fri, 11 Apr 2025 17:21:15 +0200 Subject: [PATCH] Update readme --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fe0a088..1075b39 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Home lab configuration The nix based configuration for my home lab. +## Documentation +Documentation for each role is available at `docs/roles`. Similar documentation is +also available for each unmanaged host in `docs/hosts`. ## Deploying a new VM 1. Create a clone of the template VM in proxmox. @@ -27,7 +30,7 @@ The nix based configuration for my home lab. - secrets/ # Encrypted secrets for each host - systems/base/ # Base system configuration shared by all hosts -- confgi.nix # Global configuration options +- config.nix # Global configuration options ``` ## IP ranges @@ -73,7 +76,7 @@ Immich's database. **This data should be persisted to the Ceph cluster. Preferably in real-time, but if this is infeasible, for example, running databases on top of ceph incurs a large performance hit, the data should be persisted in an automated fashion, such as through a cron job making a backup -every x hours. +every x hours.** ## TODO: @@ -90,8 +93,6 @@ every x hours. - Pterodactyl wings: Backend daemon for game servers - Vaultwarden: Password manager -- Forgejo actions runner: - **Needs to run over VPN:** - Prowlarr: - Radarr: