Johannes Kirschbauer
b36d641e71
Docs: move {flake, facts-vars} migration guides into 'migrations' folder
2025-05-18 18:56:03 +02:00
Johannes Kirschbauer
04146eeac9
Docs: remove useless repo-layout file
2025-05-18 18:49:29 +02:00
Johannes Kirschbauer
df5010084f
Docs: create migrations subfolder in guides
2025-05-18 18:46:36 +02:00
Johannes Kirschbauer
e9278ceaba
Docs: place reference to new ClanModules on index page
2025-05-18 18:40:10 +02:00
Johannes Kirschbauer
0261a954de
Docs: move 'getting-started' into guides section
2025-05-18 18:35:11 +02:00
Johannes Kirschbauer
ad5bbdbee0
Docs: move {contributing, disk, mesh, backups} into guides
2025-05-18 18:22:32 +02:00
Johannes Kirschbauer
9221231e89
docs: move authoring guides into guides subfolder
2025-05-16 16:33:39 +02:00
Johannes Kirschbauer
868db1e6f3
Docs: init migration guide for clanServices
2025-05-16 16:15:51 +02:00
Johannes Kirschbauer
21f87f169a
Docs: improve clanService docs
2025-05-16 14:58:46 +02:00
pinpox
8220c32142
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
0e1831d0f4
add back old module for compatibility
2025-05-14 16:19:55 +02:00
Johannes Kirschbauer
d825a3348b
docs(adrs): move decision folder into docs to make them publicly visible within docs
2025-05-14 10:06:24 +02:00
a-kenji
14969c5822
docs/guides: facts vars migration guide
...
Add a migration guide from facts to vars.
2025-05-13 08:10:32 +00:00
Johannes Kirschbauer
3c157c4a31
Docs: init empty migration guide with references
2025-05-12 16:13:08 +02:00
Johannes Kirschbauer
a87ab490a3
Fix: update test and docs
2025-05-12 15:54:50 +02:00
Johannes Kirschbauer
d5f90b2730
Docs: update 'clan.service' examples
2025-05-11 15:46:16 +02:00
Jörg Thalheim
d2173cb120
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
b4f63b8835
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
6c8d2d3cb5
docs(inventory/instances): init guide for setting up the new service model
2025-04-04 14:22:35 +02:00
Pablo Ovelleiro Corral
42b58910a9
data-mesher: init module
...
Co-authored-by: Brian McGee <brian@bmcgee.ie >
2025-03-29 13:49:41 +00:00
DavHau
33abb7ecd7
docs: add guide for testing
2025-03-19 09:43:05 +00:00
DavHau
30d19d088f
docs: move contributing+debugging to section contributing
2025-03-11 15:19:46 +07:00
Pablo Ovelleiro Corral
a865213894
Add auto-upgrade module
2025-03-04 10:09:37 +01:00
Qubasa
6c8137d30b
docs: Fix multiple issues with the clan installation guide
2025-02-18 17:40:27 +07:00
lassulus
3811aef9b2
clan_cli: add select command
2025-02-04 07:32:55 +00:00
Johannes Kirschbauer
559a95cdde
Docs: change navigation to use tabs again
2025-01-23 13:49:55 +01:00
a-kenji
7308eb8dc7
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
0d2ee39746
Reapply "docs: Document imports dir. Remove What's next sections everywhere. Merge guide overview and hompage view."
...
This reverts commit b19beb8913
2025-01-18 10:00:56 +07:00
Jörg Thalheim
b19beb8913
Revert "docs: Document imports dir. Remove What's next sections everywhere. Merge guide overview and hompage view."
...
This reverts commit d4305f8b3c
2025-01-17 15:44:44 +01:00
Qubasa
d4305f8b3c
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
819e66c2da
Docs: change navigation to use sidebar sections only
2025-01-14 12:31:45 +00:00
pinpox
26d286a234
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
afa03bc8d7
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
5b51950e6d
docs: Add debugging.md and repo-layout.md guides
2025-01-09 13:01:49 +00:00
Johannes Kirschbauer
95fa227780
Chore: update docs
2024-12-31 14:22:00 +01:00
Johannes Kirschbauer
e766cf5eaf
Docs: add permanent footer with prev/next buttons
2024-12-20 19:13:55 +01:00
Michael Hoang
ad4a3b473f
docs: update Matrix link
2024-12-11 10:18:36 +11:00
Johannes Kirschbauer
d15e801940
api/disk-templates: adopt directory structure from clan modules
2024-12-03 12:01:35 +01:00
DavHau
03bcf6bba3
vars: generate docs for cli and module
2024-11-29 17:23:31 +07:00
Johannes Kirschbauer
9874ae9322
Docs/modules: move frontmatter into supmenu with overview
2024-11-20 13:21:00 +01:00
Johannes Kirschbauer
6e61db7f83
Docs/modules: seperate out inventory,role specific interface
2024-11-20 11:01:28 +01:00
a-kenji
e98cbdea6f
clanModules: Fix ordering
2024-11-19 14:14:31 +01:00
a-kenji
de48d3447d
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
8544387d65
Docs/frontmatter: init automatic reference for frontmatter
2024-11-19 10:35:13 +01:00
Qubasa
09e0d8add3
docs: Remove old blog, remove empty concepts rider
2024-11-18 17:25:47 +01:00
a-kenji
8504a0e674
add clanModule for zerotier inventory
2024-11-08 14:10:23 +00:00
Johannes Kirschbauer
417db1e1e8
Docs: fix missing icons & favicon
2024-11-06 13:56:20 +01:00
Johannes Kirschbauer
c965032a6f
Docs: minor improvements
2024-10-09 09:38:31 +02:00
Johannes Kirschbauer
95b565eada
Docs: init module author guide
2024-10-08 14:22:16 +02:00
Johannes Kirschbauer
bc8d788730
Docs: harmonize titles
2024-09-25 14:06:55 +02:00
