lassulus
19f8da397c
ADR: init 05-deployment-parameters
2025-05-20 16:22:52 +02:00
lassulus
7175fb74b4
Merge pull request 'ADR: add decision for nix-select' ( #3452 ) from select-adr into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3452
Reviewed-by: hsjobeki <hsjobeki@gmail.com >
2025-05-20 13:43:31 +00:00
lassulus
348a7d24f5
ADR: add decision for nix-select
2025-05-20 15:26:53 +02:00
Jörg Thalheim
575f5b6626
add documentation on how to use macOS
2025-05-20 12:56:02 +02:00
pinpox
dca118d057
docs: add glossary
2025-05-19 11:41:00 +02:00
Johannes Kirschbauer
af58c32238
Docs: unify 'manual' with 'guides' folder
...
This is one of the final steps towards strictly following
https://diataxis.fr/
2025-05-18 20:40:40 +02:00
Johannes Kirschbauer
a12afdb99f
Docs: move {flake, facts-vars} migration guides into 'migrations' folder
2025-05-18 18:56:03 +02:00
Johannes Kirschbauer
73d12e5aa3
Docs: remove useless repo-layout file
2025-05-18 18:49:29 +02:00
Johannes Kirschbauer
f387ab0882
Docs: create migrations subfolder in guides
2025-05-18 18:46:36 +02:00
Johannes Kirschbauer
b35c1c2e46
Docs: place reference to new ClanModules on index page
2025-05-18 18:40:10 +02:00
Johannes Kirschbauer
1806c6c16e
Docs: move 'getting-started' into guides section
2025-05-18 18:35:11 +02:00
Johannes Kirschbauer
7ff62958e6
Docs: move {contributing, disk, mesh, backups} into guides
2025-05-18 18:22:32 +02:00
Johannes Kirschbauer
64bef5980f
docs: move authoring guides into guides subfolder
2025-05-16 16:33:39 +02:00
Johannes Kirschbauer
4ebdf021a3
Docs: init migration guide for clanServices
2025-05-16 16:15:51 +02:00
Johannes Kirschbauer
62d2c08dd5
Docs: improve clanService docs
2025-05-16 14:58:46 +02:00
pinpox
da3c1ceea3
Add clanServices to docs
...
Renders the documentation for clanServices. Options for the modules are
extracted and rendered the same way as for the existing clanModules.
Additionally tweaks the typography for the documentation of options
slightly
2025-05-16 11:29:50 +02:00
pinpox
857950d373
add back old module for compatibility
2025-05-14 16:19:55 +02:00
Johannes Kirschbauer
a1d2948914
docs(adrs): move decision folder into docs to make them publicly visible within docs
2025-05-14 10:06:24 +02:00
a-kenji
35805204fb
docs/guides: facts vars migration guide
...
Add a migration guide from facts to vars.
2025-05-13 08:10:32 +00:00
Johannes Kirschbauer
a3f4a96c79
Docs: init empty migration guide with references
2025-05-12 16:13:08 +02:00
Johannes Kirschbauer
e2ab2fcfb3
Fix: update test and docs
2025-05-12 15:54:50 +02:00
Johannes Kirschbauer
abaa6d17f6
Docs: update 'clan.service' examples
2025-05-11 15:46:16 +02:00
Jörg Thalheim
0b4e896af3
migrate clan history to clan-vm-manager
...
this functionality is not really useful or used in clan-vm-manager and
therefore should live in the clan-vm-manager.
Not porting the test for now because we probably get rid of the clan-vm-manager soon in favour of the UI.
2025-04-16 14:51:37 +02:00
Johannes Kirschbauer
485b6ae5c4
docs(authoring): restructure authoring guides
...
Mainly because we have two module specs now and they will remain
valid for a while. We need to keep the older format documented for a while
2025-04-08 21:32:19 +02:00
Johannes Kirschbauer
64e444d4cf
docs(inventory/instances): init guide for setting up the new service model
2025-04-04 14:22:35 +02:00
Pablo Ovelleiro Corral
8ed186ce55
data-mesher: init module
...
Co-authored-by: Brian McGee <brian@bmcgee.ie >
2025-03-29 13:49:41 +00:00
DavHau
bc48a7a57c
docs: add guide for testing
2025-03-19 09:43:05 +00:00
DavHau
188c5dfb17
docs: move contributing+debugging to section contributing
2025-03-11 15:19:46 +07:00
Pablo Ovelleiro Corral
66332c1ae6
Add auto-upgrade module
2025-03-04 10:09:37 +01:00
Qubasa
125c2df666
docs: Fix multiple issues with the clan installation guide
2025-02-18 17:40:27 +07:00
lassulus
3f19444985
clan_cli: add select command
2025-02-04 07:32:55 +00:00
Johannes Kirschbauer
83c6ad19eb
Docs: change navigation to use tabs again
2025-01-23 13:49:55 +01:00
a-kenji
42e0928b55
clanModules/mycelium: init mycelium
...
This adds a clanModule for `mycelium`.
`Mycelium` is an IPv6 overlay network written in Rust.
Each node that joins the overlay network will receive an overlay network IP in the 400::/7 range.
An example configuration might look like this in the inventory:
```nix
mycelium.default = {
roles.peer.machines = [
"berlin"
"munich"
];
config = {
topLevelDomain = "m";
openFirewall = true;
addHostedPublicNodes = true;
};
};
```
This will add the machines named `berlin` and `munich` to the `mycelium` vpn.
And will also set the toplevel domain of the mycelium vpn to `m`, meaning the
machines are now reachable via `berlin.m` and `munich.m`.
2025-01-22 11:56:10 +00:00
Qubasa
030b046552
Reapply "docs: Document imports dir. Remove What's next sections everywhere. Merge guide overview and hompage view."
...
This reverts commit ba517f56b3
2025-01-18 10:00:56 +07:00
Jörg Thalheim
ba517f56b3
Revert "docs: Document imports dir. Remove What's next sections everywhere. Merge guide overview and hompage view."
...
This reverts commit 257e1893ee
2025-01-17 15:44:44 +01:00
Qubasa
257e1893ee
docs: Document imports dir. Remove What's next sections everywhere. Merge guide overview and hompage view.
2025-01-17 21:03:25 +07:00
Johannes Kirschbauer
fef5a0b6f2
Docs: change navigation to use sidebar sections only
2025-01-14 12:31:45 +00:00
pinpox
7ccc9f52b6
migration-guide ( #2717 )
...
This PR adds a migration guide for existing NixOS configurations.
Co-authored-by: Pablo Ovelleiro Corral <mail@pablo.tools >
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/2717
Co-authored-by: pinpox <clan@pablo.tools >
Co-committed-by: pinpox <clan@pablo.tools >
2025-01-11 20:38:08 +00:00
DavHau
aa175d9682
vars: add guide for using vars to manage shared passwords
...
This could be extended forther to cover more features, but it is a start
2025-01-11 20:01:47 +07:00
Qubasa
3d0b2948f3
docs: Add debugging.md and repo-layout.md guides
2025-01-09 13:01:49 +00:00
Johannes Kirschbauer
30a99f5cb6
Chore: update docs
2024-12-31 14:22:00 +01:00
Johannes Kirschbauer
a87d0fcf92
Docs: add permanent footer with prev/next buttons
2024-12-20 19:13:55 +01:00
Michael Hoang
31ed292939
docs: update Matrix link
2024-12-11 10:18:36 +11:00
Johannes Kirschbauer
d1f624ad1f
api/disk-templates: adopt directory structure from clan modules
2024-12-03 12:01:35 +01:00
DavHau
fbbfcc0aa5
vars: generate docs for cli and module
2024-11-29 17:23:31 +07:00
Johannes Kirschbauer
277bad43cf
Docs/modules: move frontmatter into supmenu with overview
2024-11-20 13:21:00 +01:00
Johannes Kirschbauer
b3164076d5
Docs/modules: seperate out inventory,role specific interface
2024-11-20 11:01:28 +01:00
a-kenji
2389e3f73e
clanModules: Fix ordering
2024-11-19 14:14:31 +01:00
a-kenji
4b4b3826c8
clanModules/importer: Init importer inventory module
...
Initialize the `importer` inventory module.
It is a power user module that allows for convenient, flexible,
structured imports for hosts.
It exposes the `extraModules` functionality of the inventory,
without any added configuration.
Closes : #2356
2024-11-19 14:00:57 +01:00
Johannes Kirschbauer
cfe9dbf117
Docs/frontmatter: init automatic reference for frontmatter
2024-11-19 10:35:13 +01:00
