Update readme

This commit is contained in:
kalle 2025-04-11 17:21:15 +02:00
parent 04e0af85a9
commit 8892ff6f26

View file

@ -1,6 +1,9 @@
# Home lab configuration # Home lab configuration
The nix based configuration for my home lab. 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 ## Deploying a new VM
1. Create a clone of the template VM in proxmox. 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 - secrets/ # Encrypted secrets for each host
- systems/base/ # Base system configuration shared by all hosts - systems/base/ # Base system configuration shared by all hosts
- confgi.nix # Global configuration options - config.nix # Global configuration options
``` ```
## IP ranges ## 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 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 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 persisted in an automated fashion, such as through a cron job making a backup
every x hours. every x hours.**
## TODO: ## TODO:
@ -90,8 +93,6 @@ every x hours.
- Pterodactyl wings: Backend daemon for game servers - Pterodactyl wings: Backend daemon for game servers
- Vaultwarden: Password manager - Vaultwarden: Password manager
- Forgejo actions runner:
**Needs to run over VPN:** **Needs to run over VPN:**
- Prowlarr: - Prowlarr:
- Radarr: - Radarr: