initial commit to self-hosted git

1 files changed, 24 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4fc6aab
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Flake Layout
+- `hosts/`
+  - `eden/` - my media server and makeshift NAS. Media is stored in a RAID-Z2
+  ZFS pool for redundancy, with a caching drive for increased read performance.
+  - `hive/` - my "social" server, responsible for hosting my fediverse server
+  and a few websites.
+  - `oasis/` - my SFTP and git forge server.
+  - `raindog/` - my DNS server and SearXNG host. The name is inspired by one of
+  my beautiful dogs, Rainey.
+  - `sparrow/` - my laptop.
+  - `woodpecker/` - my desktop.
+- `modules/`
+  - `containers/` - podman/docker container configurations.
+  - `customs/` - custom modules or overrides for existing modules in nixpkgs.
+  - `profiles/` - configurations intended to be imported into a given system.
+  - `retired/` - modules or configurations I don't use anymore, but want to
+  keep around for reference.
+  - `scripts/` - custom shell scripts wrapped in nix (primarily for servers).
+  - `services/` - service/daemon configurations.
+  - `users/` - default user configuration for my systems.
+- `secrets/` - [age](https://github.com/FiloSottile/age) encrypted secrets, via
+  [agenix](https://github.com/ryantm/agenix)
+- `users/` - [home-manager](https://github.com/nix-community/home-manager)
+  configuration per user.