docs(README.md): update readme

This commit is contained in:
Mohammad Rafiq 2025-06-12 14:02:38 +08:00
parent 3b57194a56
commit 9dc1cca761
No known key found for this signature in database

View file

@ -4,7 +4,7 @@
- [ ] Copy over ~/.ssh/id_ed25519 and zellij status bar plugin confirmation - [ ] Copy over ~/.ssh/id_ed25519 and zellij status bar plugin confirmation
- [ ] Migrate immich to apollo, point to helios - [ ] Migrate immich to apollo, point to helios
- [ ] Migrate LibreChat to apollo, maintain db - [x] Migrate LibreChat to apollo, maintain db
- [ ] Figure out wakapi - [ ] Figure out wakapi
- [ ] Add forgejo - [ ] Add forgejo
- [ ] Add simple blog - [ ] Add simple blog
@ -30,19 +30,16 @@
# Modules # Modules
The nixosModules and homeModules exposed by this flake are slightly out of the The nixosModules and homeModules exposed by this flake are slightly out of the norm.
norm.
Option declarations for user specific configuration are kept to: Option declarations for user specific configuration are kept to:
- homeModules for CLI - homeModules for CLI
- nixosModules for desktop - nixosModules for desktop
System configurations, to this end, should include the window manager, System configurations, to this end, should include the window manager, lockscreen, terminal etc. for that system.
lockscreen, terminal etc. for that system.
These desktop programs will be **configured** in home-manager for each user, but These desktop programs will be **configured** in home-manager for each user, but those configurations consult the osConfig variable passed in by home-manager.
those configurations consult the osConfig variable passed in by home-manager.
# System Setup # System Setup
@ -50,10 +47,7 @@ The following files are **required** for system activation:
- /persist/home/${mainUser}/.ssh/id_ed25519 - /persist/home/${mainUser}/.ssh/id_ed25519
This private key will be used by sops-nix to decrypt the secrets in This private key will be used by sops-nix to decrypt the secrets in [this encrypted file](secrets/secrets.yaml). The secrets inside the yaml file should also be set, or otherwise removed alongside their declarations , found [here](modules/nixos/system/secrets.nix) and references.
[[secrets/secrets.yaml]]. The secrets inside the yaml file should also be set,
or otherwise removed alongside their declarations (in
[[modules/nixos/system/secrets.nix]]) and references.
# Impermanence # Impermanence