summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoroutremonde <outremonde@vivaldi.net>2025-06-10 20:32:00 -0400
committeroutremonde <outremonde@vivaldi.net>2025-06-10 20:32:00 -0400
commit9786eb8672213344d8d1b7bdef12bc94510b20db (patch)
treeb7d79440800c92d32187ab32c636b0830c94a610 /docs
initialized repository
Former-commit-id: 84647f22b951a957b2b83885b612115d473f6626
Diffstat (limited to 'docs')
-rw-r--r--docs/home-server.md53
-rw-r--r--docs/layout.md74
-rw-r--r--docs/todo.md25
3 files changed, 152 insertions, 0 deletions
diff --git a/docs/home-server.md b/docs/home-server.md
new file mode 100644
index 0000000..fd2de2c
--- /dev/null
+++ b/docs/home-server.md
@@ -0,0 +1,53 @@
+# Home Server
+
+## Programs:
+
+Categories:
+
+- core: Uncontainerized services like ssh, backups, and caddy.
+- cloud: File storage services like syncthing.
+- development: Developer operations services like gitolite and cgit.
+- gaming: Game servers like minecraft.
+- media: Media services like calibre-web, invidious, and plex.
+- networking: Networking services like Wireguard, firewall, etc.
+### Services
+
+#### Uncontainerized:
+
+- SSH
+- Backups
+- Caddy
+
+#### Containerized:
+
+- Git Server (Gitolite, Cgit)
+- Calibre
+- Invidious
+- Syncthing
+- Minecraft
+- Wireguard
+
+#### Considering:
+
+- Plex
+- File Storage?
+
+### Directory Layout
+
+/srv/
+ www/: Personal website.
+ sync/: Syncronized files.
+ git/: Repos and data for Gitolite and Cgit.
+ minecraft/: Minecraft servers.
+
+### Checklist
+
+- [ ] Setup SSH
+- [ ] Setup Syncthing
+- [ ] Setup Caddy
+- [ ] Setup Https Website
+- [ ] Setup Minecraft Server
+- [ ] Setup Git Server
+- [ ] Setup Wireguard
+- [ ] Setup Invidious
+- [ ] Setup Calibre
diff --git a/docs/layout.md b/docs/layout.md
new file mode 100644
index 0000000..4c38883
--- /dev/null
+++ b/docs/layout.md
@@ -0,0 +1,74 @@
+# Layout
+
+features/: Simple reusable configurations (only create an enable option and maybe one other).
+ system/
+ gui/: Graphical configurations.
+ desktops/: Desktop environments, compositors, window managers, etc.
+ apps/: Graphical apps.
+ bundles/: Collections of gui configurations.
+ cli/: Commandline configurations.
+ scripts/: Custom scripts.
+ apps/: Commandline apps (TUIs).
+ utils/: Commandline utils.
+ shells/: Shell configurations.
+ bundles/: Collections of cli configs.
+ services/: Service configurations.
+ core/: Highest importance services.
+ extra/: Medium importance services.
+ misc/: Miscellaneous services.
+ hardware/: Hardware services.
+ bundles: Collections of service configs.
+ global/: Always enabled on every device.
+ server/: Server configurations.
+ core/: Core server configs (e.g. SSH, Backups, system monitoring).
+ media/: Server apps for managing media (books, videos, etc) (e.g. Calibre or Invidious).
+ cloud/: Server apps for file storage (e.g. Syncthing, Nextcloud).
+ development/: Server apps to assist in development (e.g. Git server setup).
+ gaming/: Game servers (e.g. Minecraft).
+ user/
+ gui/: Graphical configurations.
+ desktops/
+ apps/
+ bundles/
+ cli/
+ scripts/
+ apps/
+ utils/
+ bundles/
+ services/
+ global/
+ home-manager.nix
+modules/: Custom nix modules (Can create any amount of options).
+ system/: Custom nixos modules.
+ user/: Custom home-manager modules.
+ aesthetics/
+ default.nix
+ targets/
+ themes/
+secrets/: Age-encrypted secrets integrated with nixos.
+ user-passwords/
+ culsans.age
+ lucas.age
+ server.age
+users/: User specific home manager configurations
+ nzxt-desktop/
+ culsans.nix
+ ideapad-laptop/
+ lucas.nix
+ prodesk-server/
+ server.nix
+ pendrive-iso/
+ pendrive.nix
+systems/: System-specific nixos configurations.
+ nzxt-desktop/
+ system.nix
+ hardware.nix
+ ideapad-laptop/
+ system.nix
+ hardware.nix
+ prodesk-server/
+ system.nix
+ hardware.nix
+ pendrive-iso/
+ system.nix
+ hardware.nix
diff --git a/docs/todo.md b/docs/todo.md
new file mode 100644
index 0000000..22a6977
--- /dev/null
+++ b/docs/todo.md
@@ -0,0 +1,25 @@
+# Setup
+
+## Todo
+
+- add new workspace keybind to niri
+- add niri mode to make it hard to watch yt
+- Setup swayidle
+- make swww use default wallpaper if it has none applied
+- create modular server setup
+- set up the default apps module.
+- set a terminal to use with fuzzel
+- add OSD to niri
+- add a qutebrowser keybind to open a link in tor
+- find a password manager
+- disable touch gestures in niri
+- set = to zoom in in qutebrowser
+- make qr tool not use tempfiles cluttering homedir
+- make private tor vm
+
+## Issues
+
+- Apps won't open terminal when they try to open a file manager (show in folder does not work) (maybe xdg-open doesn't see foot?).
+- Steam is a black window on ideapad-laptop.
+- Ideapad-laptop wakes immediately when suspended.
+- Unclear whether niri lid switch events are actually happening when laptop closes.