Commit Graph

76 Commits

Author SHA1 Message Date
Johannes Kirschbauer
8e7e346b28 Docs: add top-level index, refactor according to diataxis 2024-09-22 18:39:13 +02:00
Qubasa
3d1f97f2a4 docs: Rename guides to manual, Rename reference to options, add secure boot chapter to manual. Add secrets chapter to manual. 2024-09-20 16:52:52 +02:00
Jörg Thalheim
b4fb4f180b rename hw-generate to update-hardware-config 2024-09-20 13:42:18 +02:00
Qubasa
1680625260 clan-cli: Moved flash to own subcommand 2024-09-15 15:53:17 +02:00
Qubasa
7709958fa1 docs: Fix line highlighting, add warning to single-disk 2024-09-13 15:01:29 +02:00
Qubasa
787599ebb6 clanCore: init machine_id_v3 2024-09-13 12:17:49 +02:00
a-kenji
f1b857f4ae Revert "Merge pull request 'machine_id_v2' (#2052) from Qubasa/clan-core:machine_id_v2 into main"
This reverts commit 68a72a4156, reversing
changes made to 7af3e80249.
2024-09-10 14:01:12 +02:00
Qubasa
a0b3275ed1 clanCore: init machineId and diskId v2 2024-09-09 15:51:31 +02:00
Qubasa
323010bb04 revert machine_id pull request 2024-09-06 21:38:50 +02:00
Qubasa
04b33e337a templates: Rename diskIdShort to diskId 2024-09-06 18:55:00 +02:00
Qubasa
b16a53f510 clanCore: init machine_id.nix with clan.core.machine.{id,diskId} 2024-09-06 18:05:40 +02:00
Qubasa
ca65c021b1 nixosModules: remove unnecessary ./iso and disk-layout, clanModules: fix issue #1349 2024-09-03 00:09:45 +02:00
Qubasa
1cde013263 docs: Fix incorrect command in disk-encryption getting started 2024-09-02 00:08:38 +02:00
a-kenji
3d5e3f744c docs: improve zerotier documentation 2024-08-30 15:11:03 +02:00
Qubasa
5df58aaf20 docs: Improve iwd, vaultwarden, dyndns, disk-encryption and installer documentation 2024-08-24 13:10:22 +02:00
Jörg Thalheim
9f66ded76a Merge remote-tracking branch 'origin/main' into rework-installation 2024-08-21 13:38:04 +02:00
Aos Dabbagh
7281cef29e fix(installer): Fix language check case
When attempting to follow the docs on the installer, this error comes
up:
```
$ clan flash --flake git+https://git.clan.lol/clan/clan-core \
             --ssh-pubkey ~/.ssh/id_ed25519.pub \
             --keymap us \
             --language en_US.utf-8 \
             --dry-run flash-installer

ERROR: Language 'en_US.utf-8' is not a valid language. Run 'clan flash --list-languages' to see a list of possible languages.
```

I only decided to clean up the docs, but I'm also okay with just
downcasing the locales in `list_possible_languages()`.
2024-08-21 08:15:49 +00:00
Qubasa
6cf6cfa8a8 docs: Add zfs disk encryption getting started guide with remote unlocking. 2024-08-10 12:24:49 +02:00
Jörg Thalheim
bba39c5c7d hw-configure: use hostname specified in the nixos configuration 2024-07-22 16:08:59 +02:00
Jörg Thalheim
d21d296c5c rework installation template based on received feedback 2024-07-22 16:08:59 +02:00
Valentin Gagarin
13b8b949f9 docs: add reference index pages
- add index pages for each reference documentation category
- move concepts pages into the reference hierarchy
- render clanModules overview page in the style of the CLI overview
2024-07-19 10:27:04 +02:00
Jörg Thalheim
d4b0f3bed4 docs: fix flash example 2024-07-15 11:53:25 +02:00
DavHau
4cde2d96be Reapply "clan.core: rename clan.{deployment,networking} -> clan.core.{deployment,networking}"
This reverts commit 9778444706.

workaround upstream bug: https://github.com/NixOS/nixpkgs/issues/324802
2024-07-05 19:29:01 +07:00
Jörg Thalheim
9778444706 Revert "clan.core: rename clan.{deployment,networking} -> clan.core.{deployment,networking}"
This reverts commit afbd4a984d.

The old configuration cannot be updated like this:

eve] error:
[eve]        … while calling the 'head' builtin
[eve]          at /nix/store/5b0hl2dnvr1sawqlkwmsnaiyqz00d34h-source/lib/attrsets.nix:1575:11:
[eve]          1574|         || pred here (elemAt values 1) (head values) then
[eve]          1575|           head values
[eve]              |           ^
[eve]          1576|         else
[eve]
[eve]        … while evaluating the attribute 'value'
[eve]          at /nix/store/5b0hl2dnvr1sawqlkwmsnaiyqz00d34h-source/lib/modules.nix:809:9:
[eve]           808|     in warnDeprecation opt //
[eve]           809|       { value = builtins.addErrorContext "while evaluating the option `${showOption loc}':" value;
[eve]              |         ^
[eve]           810|         inherit (res.defsFinal') highestPrio;
[eve]
[eve]        … while evaluating the option `system.build.toplevel':
[eve]
[eve]        … while evaluating definitions from `/nix/store/5b0hl2dnvr1sawqlkwmsnaiyqz00d34h-source/nixos/modules/system/activation/top-level.nix':
[eve]
[eve]        … while evaluating the option `assertions':
[eve]
[eve]        … while evaluating definitions from `/nix/store/5b0hl2dnvr1sawqlkwmsnaiyqz00d34h-source/nixos/modules/system/boot/systemd.nix':
[eve]
[eve]        … while evaluating the option `systemd.services':
[eve]
[eve]        … while evaluating definitions from `/nix/store/kpzcdgndym0qm1w490mjvk9c2qmz03h5-source/nixosModules/clanCore/zerotier':
[eve]
[eve]        … while evaluating the option `clan.core.networking.zerotier.networkId':
[eve]
[eve]        (stack trace truncated; use '--show-trace' to show the full, detailed trace)
[eve]
[eve]        error: A definition for option `clan.core.networking.zerotier.networkId' is not of type `null or string'. Definition values:
[eve]        - In `/nix/store/kpzcdgndym0qm1w490mjvk9c2qmz03h5-source/nixosModules/clanCore/networking.nix':
[eve]            {
[eve]              _type = "override";
[eve]              content = "267efd4a15b69623";
[eve]              priorit
2024-07-05 11:16:05 +02:00
DavHau
afbd4a984d clan.core: rename clan.{deployment,networking} -> clan.core.{deployment,networking} 2024-07-04 17:05:37 +07:00
Johannes Kirschbauer
241cca5b70 Docs: rename clanName to just name 2024-06-25 14:21:53 +02:00
DavHau
313db5643f refactor: rename clanCore -> clan.core 2024-06-18 18:32:40 +07:00
Johannes Kirschbauer
43e8804eb4 Docs: update machine hardware config instructions 2024-06-15 22:27:46 +02:00
a-kenji
bf0cc19c8f documentation(backups): make exampe more robust 2024-06-04 17:09:26 +02:00
Qubasa
adef52a938 docs: Fix installer wrong indentation 2024-05-30 22:41:30 +02:00
Jörg Thalheim
750b6aec59 flash: make configuration more explicit
Injecting nixos configuration and potentially overriding settings a user
made and can cause surprises.
In most cases, users want to just make these option part of their NixOS
configuration and by having the rest in the command line
we make it more explicit what other configuration is being applied.
2024-05-29 12:45:50 +02:00
Jörg Thalheim
f0f97baa65 drop global argparse flags
They get shadowed by subargparser options.
2024-05-29 10:21:35 +02:00
DavHau
f1f040397d docs/secrets: improve chapter assigning access
Since we already walk the user through creating a secret in an earlier step, it makes more sense explain first how to add machines/users to an existing secret instead of creating  a new one
2024-05-28 13:08:19 +02:00
DavHau
b158c2706f docs: secrets: list the main steps of the guide
... so the user has a routh idea about the mein steps
2024-05-27 12:02:29 +02:00
a-kenji
97928801f9 documentation: add keys 2024-05-24 13:46:05 +02:00
clan-bot
8c36df77cc Merge pull request 'documentation: improve legibility of command output' (#1423) from a-kenji-fix/lsblk into main 2024-05-24 10:40:34 +00:00
a-kenji
2284b060be documentation: improve legibility of command output
Improve legibility of command output.
2024-05-24 12:37:27 +02:00
a-kenji
bf212ce9c4 documenation: fix flake-parts what's next section 2024-05-24 12:11:42 +02:00
a-kenji
7aa85d8aaf documentation: remove references to Icons for introductory material
The icons are not yet used in this path.
This is unneccessary overhead for new users, with no payoff yet.
2024-05-21 11:16:12 +02:00
Qubasa
64a98281f0 Add bcachefs support. Fix clan flash docu. 2024-05-18 23:18:02 +02:00
Qubasa
1e94bf02da Add nix flake check remark to docu 2024-05-14 18:20:56 +02:00
Qubasa
1c2781267b Add clan flash documentation. 2024-05-14 16:13:50 +02:00
Qubasa
1476619515 Renamed machines.md to deploy.md 2024-05-14 15:41:15 +02:00
Qubasa
8288048682 Renamed machines.md to deploy.md 2024-05-14 15:41:15 +02:00
Qubasa
fd41badbc6 Add --no-reboot flag to clan machine install 2024-05-14 15:41:15 +02:00
Qubasa
d574faf253 Heavily improve documentation and flake template 2024-05-14 15:41:15 +02:00
Qubasa
81522c96e5 Fix missing efi and x64 support in template 2024-05-14 15:41:15 +02:00
Qubasa
86ae7cbbfb Reorder getting started documentation 2024-05-10 22:59:45 +02:00
Qubasa
82fa89b57e Fix template. Improve docu. Add disko as default imported module. 2024-05-10 15:39:46 +02:00
a-kenji
fd00a941dc docs: simplify hardware-configuration 2024-05-07 21:37:25 +02:00