Commit Graph

79 Commits

Author SHA1 Message Date
Johannes Kirschbauer
026481f9d7 Docs: harmonize titles 2024-09-25 14:06:55 +02:00
Johannes Kirschbauer
579d24a828 Docs: authorizedKeys is a list 2024-09-25 14:06:55 +02:00
Johannes Kirschbauer
60ddd3369e Docs: restructure apply diataxis 2024-09-25 13:37:35 +02:00
Johannes Kirschbauer
55526b1fdb Docs: add top-level index, refactor according to diataxis 2024-09-22 18:39:13 +02:00
Qubasa
036cd710e1 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
8a8b473236 rename hw-generate to update-hardware-config 2024-09-20 13:42:18 +02:00
Qubasa
cafab5783f clan-cli: Moved flash to own subcommand 2024-09-15 15:53:17 +02:00
Qubasa
edc879b276 docs: Fix line highlighting, add warning to single-disk 2024-09-13 15:01:29 +02:00
Qubasa
60397e0ca4 clanCore: init machine_id_v3 2024-09-13 12:17:49 +02:00
a-kenji
b13ed922b1 Revert "Merge pull request 'machine_id_v2' (#2052) from Qubasa/clan-core:machine_id_v2 into main"
This reverts commit 22a11abfe5, reversing
changes made to 208b71ac0e.
2024-09-10 14:01:12 +02:00
Qubasa
5c975a5eef clanCore: init machineId and diskId v2 2024-09-09 15:51:31 +02:00
Qubasa
2efa096d29 revert machine_id pull request 2024-09-06 21:38:50 +02:00
Qubasa
67bc66164c templates: Rename diskIdShort to diskId 2024-09-06 18:55:00 +02:00
Qubasa
4171d5ea4e clanCore: init machine_id.nix with clan.core.machine.{id,diskId} 2024-09-06 18:05:40 +02:00
Qubasa
e35fd0976a nixosModules: remove unnecessary ./iso and disk-layout, clanModules: fix issue #1349 2024-09-03 00:09:45 +02:00
Qubasa
b41fe4352b docs: Fix incorrect command in disk-encryption getting started 2024-09-02 00:08:38 +02:00
a-kenji
0c58e1b33b docs: improve zerotier documentation 2024-08-30 15:11:03 +02:00
Qubasa
ca60743b2b docs: Improve iwd, vaultwarden, dyndns, disk-encryption and installer documentation 2024-08-24 13:10:22 +02:00
Jörg Thalheim
30bbb142e2 Merge remote-tracking branch 'origin/main' into rework-installation 2024-08-21 13:38:04 +02:00
Aos Dabbagh
1e96f59ecd 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
cdcbd146f2 docs: Add zfs disk encryption getting started guide with remote unlocking. 2024-08-10 12:24:49 +02:00
Jörg Thalheim
3bbfe7fad2 hw-configure: use hostname specified in the nixos configuration 2024-07-22 16:08:59 +02:00
Jörg Thalheim
fabfba77cf rework installation template based on received feedback 2024-07-22 16:08:59 +02:00
Valentin Gagarin
b3fd59a802 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
04a0570017 docs: fix flash example 2024-07-15 11:53:25 +02:00
DavHau
79d6f8e893 Reapply "clan.core: rename clan.{deployment,networking} -> clan.core.{deployment,networking}"
This reverts commit 71009f80d8.

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

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
18b64f2d0b clan.core: rename clan.{deployment,networking} -> clan.core.{deployment,networking} 2024-07-04 17:05:37 +07:00
Johannes Kirschbauer
cf03c71966 Docs: rename clanName to just name 2024-06-25 14:21:53 +02:00
DavHau
4db2e8303f refactor: rename clanCore -> clan.core 2024-06-18 18:32:40 +07:00
Johannes Kirschbauer
0826c2bce0 Docs: update machine hardware config instructions 2024-06-15 22:27:46 +02:00
a-kenji
efd772435c documentation(backups): make exampe more robust 2024-06-04 17:09:26 +02:00
Qubasa
4a27f3bc3f docs: Fix installer wrong indentation 2024-05-30 22:41:30 +02:00
Jörg Thalheim
eb5fe2fe15 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
d002419ae7 drop global argparse flags
They get shadowed by subargparser options.
2024-05-29 10:21:35 +02:00
DavHau
4e3870365a 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
63ee7d8ab1 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
b5626aae1e documentation: add keys 2024-05-24 13:46:05 +02:00
clan-bot
e2185a2f36 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
33504088c2 documentation: improve legibility of command output
Improve legibility of command output.
2024-05-24 12:37:27 +02:00
a-kenji
5320c621b9 documenation: fix flake-parts what's next section 2024-05-24 12:11:42 +02:00
a-kenji
6128032865 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
69d1c792b0 Add bcachefs support. Fix clan flash docu. 2024-05-18 23:18:02 +02:00
Qubasa
16bd11be19 Add nix flake check remark to docu 2024-05-14 18:20:56 +02:00
Qubasa
d717646d93 Add clan flash documentation. 2024-05-14 16:13:50 +02:00
Qubasa
01fa7085de Renamed machines.md to deploy.md 2024-05-14 15:41:15 +02:00
Qubasa
d2a248ed2d Renamed machines.md to deploy.md 2024-05-14 15:41:15 +02:00
Qubasa
bae03fa338 Add --no-reboot flag to clan machine install 2024-05-14 15:41:15 +02:00
Qubasa
ecc80556cf Heavily improve documentation and flake template 2024-05-14 15:41:15 +02:00
Qubasa
aa03d0f877 Fix missing efi and x64 support in template 2024-05-14 15:41:15 +02:00