Johannes Kirschbauer
a6a79e83a0
treewide(clanLib): rename all occurences of {clan-core,self}.lib to 'clanLib'
2025-04-09 11:32:46 +02:00
hsjobeki
f60da91dea
Merge pull request 'docs(authoring): restructure authoring guides' ( #3248 ) from hsjobeki/clan-core:docs-authoring into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3248
2025-04-08 19:58:59 +00: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
Sam Lehman
e0a6ed3d49
devshells: name shells for clarity
2025-04-08 19:31:30 +00:00
Johannes Kirschbauer
1b3ce7ebd4
docs(inventory): improve extendSettings docs
2025-04-08 15:46:13 +02:00
Johannes Kirschbauer
ce84c4cddb
chore(lib/modulesDocs): move dependency on clan-core and pkgs into function args
...
This is a good idea, to make lib agnostic from clan-core
The next step could be to rename the clan-core argument name
Or to explizitly pass the actual dependencies, instead of everything in
clan-core
2025-04-08 15:30:49 +02:00
Johannes Kirschbauer
97049d187c
doc(inventory): document experimental settings vendoring
2025-04-08 15:24:12 +02:00
Brian McGee
9d6dfbd3e9
fix(docs): add the requirement to export clan.templates in flake outputs to migration guide
2025-04-08 10:44:36 +01:00
Brian McGee
7493ab3e59
fix(docs): correct flake sample in migration guide
...
diff --git a/docs/site/manual/migration-guide.md b/docs/site/manual/migration-guide.md
index 551a3ef0..38be9a0e 100644
--- a/docs/site/manual/migration-guide.md
+++ b/docs/site/manual/migration-guide.md
@@ -77,13 +77,18 @@ For the provide flake example, your flake should now look like this:
```nix
{
inputs.nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+
+ inputs.clan-core = {
+ url = "git+https://git.clan.lol/clan/clan-core ";
+ inputs.nixpkgs.follows = "nixpkgs";
+ };
- outputs = { self, nixpkgs, ... }:
+ outputs = { self, nixpkgs, clan-core, ... }:
let
clan = clan-core.lib.buildClan {
self = self; # this needs to point at the repository root
specialArgs = {};
- inventory.meta.name = "NEEDS_TO_BE_UNIQUE"; # TODO: Changeme
+ meta.name = throw "Change me to something unique";
machines = {
berlin = {
2025-04-08 10:44:33 +01:00
hsjobeki
b0d8d1f195
Merge pull request 'chore(lib/select): move into subfolder with a test file' ( #3175 ) from hsjobeki/clan-core:lib-cleanup into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3175
2025-04-04 12:32:32 +00:00
Johannes Kirschbauer
6c8d2d3cb5
docs(inventory/instances): init guide for setting up the new service model
2025-04-04 14:22:35 +02:00
Jörg Thalheim
f1cd85f281
docs/secrets: mention defaultGroups option
2025-04-03 14:02:05 +02:00
Johannes Kirschbauer
c25574bebd
fix(lib/evalClan): evalClan is an explizit lib attribute
2025-03-30 17:07:11 +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
hsjobeki
1d60f94cc5
Merge pull request 'docs/configure: Remove reference to unfinished feature' ( #3097 ) from kenji/clan-core:docs-remove-upcoming into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3097
2025-03-25 18:12:09 +00:00
Mic92
ccb5af9565
Merge pull request 'docs/index: Clear up API Reference description' ( #3098 ) from kenji/clan-core:docs-overview into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3098
2025-03-25 09:34:18 +00:00
a-kenji
709d773768
docs/configure: Fix erroneous option attribute
...
Fixes: 3094
2025-03-22 13:05:55 -07:00
a-kenji
845abd1356
docs/index: Clear up API Reference description
...
The term "auto generated" gives leeway to the incorrect assumption
that this is not a curated reference that contains written documentation
especially for the rendered reference.
This is not the case.
2025-03-22 12:56:51 -07:00
a-kenji
2b4a4f2422
docs/configure: Remove reference to unfinished feature
2025-03-22 12:53:59 -07: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
a-kenji
91a19d9ea9
docs/repo-layout: Remove infra section
...
Remove the public infra section, as it uses a bit of unfortunate
wording. It suggests we would add anyone to our infrastructure as an
admin.
2025-03-03 11:34:45 +00:00
a-kenji
726f2ab5f8
docs/CONTRIBUTING: Remove internal tools documentation to streamline
...
Remove our internal developer tools documentation to streamline the
CONTRIBUTING.md guide and to not confuse external contributors.
2025-03-03 11:34:34 +00:00
a-kenji
5918620535
docs/CONTRIBUTING: Add missing article
2025-03-02 20:44:42 -08:00
a-kenji
e98e817941
docs: Fix numbered markdown list
2025-03-02 20:10:43 -08:00
a-kenji
fe92c7d1e6
docs/CONTRIBUTING: Clarify wrong suggestion about debugging dependent tools
2025-03-03 03:57:33 +00:00
a-kenji
4222f9788c
docs/site: Fix flake-parts link
2025-03-03 03:53:49 +00:00
a-kenji
3d80423259
docs/CONTRIBUTING: Fix data-mesher reference name
2025-03-02 19:42:57 -08:00
a-kenji
bc239e104c
docs/guide: Mention alternative secret store backends
2025-02-27 09:58:00 +00:00
a-kenji
3e0cd4bdfb
docs/guide: Deduplicate machine instructions
2025-02-27 09:56:52 +00:00
a-kenji
dfb5e5123f
docs/guide: Add devshell recommendation to getting started
...
Fixes : #2218
2025-02-25 18:16:50 +00:00
Jörg Thalheim
b0760bc2b9
recommend vars over facts
2025-02-22 03:34:40 +00:00
Qubasa
8ac286bcaf
docs: Fix install documentation
2025-02-19 14:23:45 +07:00
Qubasa
6c8137d30b
docs: Fix multiple issues with the clan installation guide
2025-02-18 17:40:27 +07:00
a-kenji
c3013c1a02
docs/mesh-vpn: Document inventory usage
2025-02-16 13:32:42 +07:00
a-kenji
3cff6577da
docs: Extend backups guide
...
Closes #2792
2025-02-16 13:04:53 +07:00
Jörg Thalheim
873f650678
remove directory = self from our documentation
2025-02-15 01:48:17 +00:00
Qubasa
35aedddf65
docs: Add --refresh flag to nix shell command to mitigate caching issues
2025-02-14 13:28:21 +07:00
Qubasa
de3153259d
clan-cli: Fix garbled clan vms run output. docs: Improve debugging guide
2025-02-13 16:17:55 +07:00
Sacha Korban
c0f07afb98
docs: disc-encryption: change guide to use phases option and misc improvements
2025-02-13 17:10:07 +11:00
OliverNChalk
50924ad7ff
docs: fix git rm step in Add Machines
2025-02-11 09:41:25 +11:00
Michael Hoang
5314eb4cfa
blog: actually remove asciicinema player
2025-02-04 15:48:12 +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
dfdcad7fc5
Fix various typos
2025-01-22 13:26:58 +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
3ffefc3064
clan: revert imports.nix and wait till tuesday
2025-01-18 20:21:49 +07:00
Qubasa
65bd3a9ac6
docs: Rename mentions of inventory module to clanModule with inventory support
2025-01-18 10:17:20 +07: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
