My nix-darwin and NixOS config
docs: update README
+56
-25
+56
-25
README.md
+56
-25
README.md
···
1
1
# Nix Configuration
2
2
3
-
v0.3.1
3
+
v0.4.0
4
4
5
-
Personal NixOS and nix-darwin configurations for managing multiple machines with a unified, centralized setup.
5
+
Personal NixOS and nix-darwin configurations for managing multiple
6
+
machines with a unified, centralized setup.
6
7
7
-
> **Note:** This is a personal configuration repository. While you're welcome to use it as reference, it's specifically tailored to my needs and setup.
8
-
9
-
> **🎯 Quick Start for Forkers:** Edit `modules/options.nix` to customise everything — username, email, git settings, desktop theme, packages, and more. Per-host overrides go in `hosts/<hostname>/default.nix`.
8
+
> **Note:** This is a personal configuration repository. While
9
+
> you're welcome to use it as reference, it's specifically tailored
10
+
> to my needs and setup.
11
+
>
12
+
> **🎯 Quick Start for Forkers:** Edit `modules/options.nix` to
13
+
> customise everything — username, email, git settings, desktop
14
+
> theme, packages, and more. Per-host overrides go in
15
+
> `hosts/<hostname>/default.nix`.
10
16
11
17
## Key Features
12
18
13
-
✨ **Centralized Configuration** - All option defaults in `modules/options.nix` (single source of truth)
19
+
✨ **Centralized Configuration** - All option defaults in
20
+
`modules/options.nix` (single source of truth)
14
21
🔄 **DRY Principles** - Zero duplication; the NixOS module system handles everything
15
22
🎯 **Easy Customization** - Change any default in one file, applies everywhere
16
23
📦 **Multi-System** - Unified config for NixOS and macOS
···
27
34
### Linux (NixOS) - SECONDARY
28
35
29
36
- **laptop** - Dell Inspiron 3501 with KDE Plasma 6 — Secondary workstation
30
-
- **server** - Minimal headless server — Bluesky PDS, Forgejo, Cloudflare tunnel + hardened security
37
+
- **server** - Minimal headless server — Bluesky PDS, Forgejo,
38
+
Nextcloud, Cloudflare tunnel + hardened security
31
39
32
40
## Repository Structure
33
41
34
-
```
42
+
```text
35
43
.
36
44
├── flake.nix # Main flake — defines all hosts
37
45
├── flake.lock # Locked dependency versions
···
51
59
│ ├── users.nix # User account configuration
52
60
│ ├── caddy.nix # Caddy web server
53
61
│ ├── pds.nix # Bluesky ATProto PDS
62
+
│ ├── pds-landing/ # PDS landing page assets
54
63
│ ├── forgejo.nix # Forgejo git forge
64
+
│ ├── nextcloud.nix # Nextcloud instance
55
65
│ ├── cloudflare-tunnel.nix # Cloudflare tunnel (outbound-only)
56
-
│ ├── cockpit.nix # Cockpit web console
57
66
│ ├── ssh-keys.nix # Public key registry for all hosts
58
67
│ ├── server/ # Headless server sub-modules
59
68
│ │ ├── firewall.nix
···
76
85
│
77
86
├── home/ # Home Manager (unified across all hosts)
78
87
│ ├── default.nix # Main entry point
79
-
│ └── programs/ # Per-program config (git, zsh, ssh, vscode, kde, ...)
88
+
│ ├── scripts/ # User scripts (update-all, verify-ssh-external, ...)
89
+
│ └── programs/ # git, zsh, ssh, vscode, kde, ghostty, ...
80
90
│
81
91
├── settings/ # Platform-specific declarative settings
82
92
│ ├── darwin/ # macOS system.defaults (Dock, Finder, trackpad, etc.)
···
86
96
│ ├── setup.sh # Key management helper
87
97
│ └── *.env / *.json / ... # Encrypted secret files
88
98
│
99
+
├── hooks/
100
+
│ └── pre-commit # auto-format: nix, sh, rust, toml, md
101
+
│
89
102
├── tools/ # Rust maintenance tools
90
-
│ └── src/bin/ # health-check, flake-bump, gen-diff
103
+
│ └── src/bin/ # health-check, flake-bump, gen-diff, server-config
91
104
└── wallpapers/
92
105
```
93
106
94
107
## Configuration Architecture
95
108
96
-
All options are declared with typed defaults in `modules/options.nix`. Every system module reads values via `config.myConfig.*`; home-manager modules use `osConfig.myConfig.*`. No custom abstraction layer — it's plain NixOS module system.
109
+
All options are declared with typed defaults in `modules/options.nix`.
110
+
Every system module reads values via `config.myConfig.*`;
111
+
home-manager modules use `osConfig.myConfig.*`. No custom
112
+
abstraction layer — it's plain NixOS module system.
97
113
98
114
**To change a value for all hosts:**
99
115
···
126
142
127
143
```bash
128
144
mkdir -p ~/.config
129
-
curl -L https://github.com/ewanc26/nix/archive/refs/heads/main.tar.gz | tar -xz -C ~/.config
145
+
curl -L \
146
+
https://github.com/ewanc26/nix/archive/refs/heads/main.tar.gz \
147
+
| tar -xz -C ~/.config
130
148
mv ~/.config/nix-main ~/.config/nix-config
131
149
cd ~/.config/nix-config
132
150
```
···
165
183
nano settings/plasma/default.nix # KDE Plasma layout and behaviour
166
184
```
167
185
168
-
See [`docs/settings.md`](docs/settings.md) for the full guide and [`docs/settings-config.md`](docs/settings-config.md) for the complete option reference.
186
+
See [`docs/settings.md`](docs/settings.md) for the full guide and
187
+
[`docs/settings-config.md`](docs/settings-config.md) for the
188
+
complete option reference.
169
189
170
190
## Maintenance
171
191
···
224
244
225
245
## Inputs
226
246
227
-
| Input | Version |
228
-
| ----------------------------------------------------------------- | ---------------- |
229
-
| [nixpkgs](https://github.com/NixOS/nixpkgs) | nixos-25.11 |
230
-
| [home-manager](https://github.com/nix-community/home-manager) | release-25.11 |
231
-
| [nix-darwin](https://github.com/LnL7/nix-darwin) | nix-darwin-25.11 |
232
-
| [sops-nix](https://github.com/Mic92/sops-nix) | latest |
233
-
| [plasma-manager](https://github.com/nix-community/plasma-manager) | latest |
247
+
| Input | Version |
248
+
| --- | --- |
249
+
| [nixpkgs][nixpkgs] | nixos-25.11 |
250
+
| [home-manager][home-manager] | release-25.11 |
251
+
| [nix-darwin][nix-darwin] | nix-darwin-25.11 |
252
+
| [sops-nix][sops-nix] | latest |
253
+
| [plasma-manager][plasma-manager] | latest |
254
+
255
+
[nixpkgs]: https://github.com/NixOS/nixpkgs
256
+
[home-manager]: https://github.com/nix-community/home-manager
257
+
[nix-darwin]: https://github.com/LnL7/nix-darwin
258
+
[sops-nix]: https://github.com/Mic92/sops-nix
259
+
[plasma-manager]: https://github.com/nix-community/plasma-manager
234
260
235
261
## Unified Configuration Benefits
236
262
···
240
266
- **SSH** client configuration unified (connection multiplexing, agent integration)
241
267
- **Git** settings consistent across NixOS and macOS
242
268
- **Starship** prompt looks the same everywhere
269
+
- **Ghostty** terminal configured identically on Linux and macOS
243
270
244
271
### Platform-Specific When Needed
245
272
···
261
288
### Host Management
262
289
263
290
- [`docs/hosts.md`](docs/hosts.md) — hosts documentation index
264
-
- [`docs/hosts-overview.md`](docs/hosts-overview.md) — complete comparison of all three hosts
265
-
- [`docs/hosts-modification.md`](docs/hosts-modification.md) — how to modify and add hosts
266
-
- [`docs/hosts-laptop.md`](docs/hosts-laptop.md) — Dell Inspiron 3501 (NixOS + KDE Plasma 6)
291
+
- [`docs/hosts-overview.md`](docs/hosts-overview.md) — complete
292
+
comparison of all three hosts
293
+
- [`docs/hosts-modification.md`](docs/hosts-modification.md) —
294
+
how to modify and add hosts
295
+
- [`docs/hosts-laptop.md`](docs/hosts-laptop.md) — Dell Inspiron
296
+
3501 (NixOS + KDE Plasma 6)
267
297
- [`docs/hosts-server.md`](docs/hosts-server.md) — headless server setup
268
298
- [`docs/hosts-macmini.md`](docs/hosts-macmini.md) — macOS with nix-darwin
269
299
- [`docs/TAILSCALE-SSH.md`](docs/TAILSCALE-SSH.md) — inter-host SSH over Tailscale
···
271
301
### Settings Management
272
302
273
303
- [`docs/settings.md`](docs/settings.md) — settings overview
274
-
- [`docs/settings-structure.md`](docs/settings-structure.md) — why the config is modular
304
+
- [`docs/settings-structure.md`](docs/settings-structure.md) —
305
+
why the config is modular
275
306
- [`docs/secrets.md`](docs/secrets.md) — secrets management