From d951c570f0147771df6adcc6891942512c370a2a Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Wed, 10 Apr 2024 12:26:59 +0200 Subject: [PATCH] docs: improve getting started --- .../{quickstart.md => 01-quickstart.md} | 2 +- docs/admins/{machines.md => 02-machines.md} | 2 +- .../{install-iso.md => 03-install-iso.md} | 2 +- docs/admins/{zerotier.md => 04-networking.md} | 2 +- .../{secrets-management.md => 06-secrets.md} | 5 +- docs/admins/{backup.md => 07-backups.md} | 2 +- docs/admins/{migrate.md => 99-migrate.md} | 2 +- docs/admins/_index.md | 2 +- docs/admins/clan-config.md | 69 ------------------- 9 files changed, 10 insertions(+), 78 deletions(-) rename docs/admins/{quickstart.md => 01-quickstart.md} (98%) rename docs/admins/{machines.md => 02-machines.md} (99%) rename docs/admins/{install-iso.md => 03-install-iso.md} (99%) rename docs/admins/{zerotier.md => 04-networking.md} (98%) rename docs/admins/{secrets-management.md => 06-secrets.md} (97%) rename docs/admins/{backup.md => 07-backups.md} (99%) rename docs/admins/{migrate.md => 99-migrate.md} (99%) delete mode 100644 docs/admins/clan-config.md diff --git a/docs/admins/quickstart.md b/docs/admins/01-quickstart.md similarity index 98% rename from docs/admins/quickstart.md rename to docs/admins/01-quickstart.md index c813d4774..dbf9c37cb 100644 --- a/docs/admins/quickstart.md +++ b/docs/admins/01-quickstart.md @@ -1,4 +1,4 @@ -# Getting Started with Your First Clan Project +# 01 Getting Started Welcome to your simple guide on starting a new Clan project! diff --git a/docs/admins/machines.md b/docs/admins/02-machines.md similarity index 99% rename from docs/admins/machines.md rename to docs/admins/02-machines.md index e84a9113d..7be4cc2be 100644 --- a/docs/admins/machines.md +++ b/docs/admins/02-machines.md @@ -1,4 +1,4 @@ -# 01 Managing NixOS Machines with Clan +# 02 Machines with Clan Integrating a new machine into your Clan environment is a very easy yet flexible process, allowing for a straight forward management of multiple NixOS configurations. diff --git a/docs/admins/install-iso.md b/docs/admins/03-install-iso.md similarity index 99% rename from docs/admins/install-iso.md rename to docs/admins/03-install-iso.md index 3c10dfa1c..0e7128385 100644 --- a/docs/admins/install-iso.md +++ b/docs/admins/03-install-iso.md @@ -1,4 +1,4 @@ -# Clan Hardware Installation +# 03 Clan Hardware Installation For installations on physical hardware, create a NixOS installer image and transfer it to a bootable USB drive as described below. diff --git a/docs/admins/zerotier.md b/docs/admins/04-networking.md similarity index 98% rename from docs/admins/zerotier.md rename to docs/admins/04-networking.md index b7fd5fb84..1a0ed6901 100644 --- a/docs/admins/zerotier.md +++ b/docs/admins/04-networking.md @@ -1,4 +1,4 @@ -# ZeroTier Configuration with NixOS in Clan +# 04 Overlay Networks in Clan This guide provides detailed instructions for configuring [ZeroTier VPN](https://zerotier.com) within Clan. Follow the diff --git a/docs/admins/secrets-management.md b/docs/admins/06-secrets.md similarity index 97% rename from docs/admins/secrets-management.md rename to docs/admins/06-secrets.md index 5b7746beb..5e8e38301 100644 --- a/docs/admins/secrets-management.md +++ b/docs/admins/06-secrets.md @@ -1,6 +1,7 @@ -# Managing Secrets with Clan +# 06 Secrets with Clan + +Clan enables encryption of secrets (such as passwords & keys) ensuring security and ease-of-use among users. -Clan enables encryption of secrets within a Clan flake, ensuring secure sharing among users. This documentation will guide you through managing secrets with the Clan CLI, which utilizes the [sops](https://github.com/getsops/sops) format and integrates with [sops-nix](https://github.com/Mic92/sops-nix) on NixOS machines. diff --git a/docs/admins/backup.md b/docs/admins/07-backups.md similarity index 99% rename from docs/admins/backup.md rename to docs/admins/07-backups.md index 1cc3153d5..425ab4af6 100644 --- a/docs/admins/backup.md +++ b/docs/admins/07-backups.md @@ -1,4 +1,4 @@ -# Backups +# 07 Backups ## Introduction to Backups diff --git a/docs/admins/migrate.md b/docs/admins/99-migrate.md similarity index 99% rename from docs/admins/migrate.md rename to docs/admins/99-migrate.md index 79c00e837..3173ff836 100644 --- a/docs/admins/migrate.md +++ b/docs/admins/99-migrate.md @@ -1,4 +1,4 @@ -# Migrating Existing NixOS Configuration Flake to Clan Core +# 99 Migration guide Transitioning your existing setup to Clan Core is easy and straightforward. Follow this guide to ensure a smooth migration. diff --git a/docs/admins/_index.md b/docs/admins/_index.md index 7f15c05cb..b2f084adc 100644 --- a/docs/admins/_index.md +++ b/docs/admins/_index.md @@ -1,6 +1,6 @@ +++ title = "Admin Documentation" -description = "Documentation administrators creating or managing cLANs" +description = "Documentation for administrators. Create and manage one or multiple cLANs" date = 2025-05-01T19:00:00+00:00 updated = 2021-05-01T19:00:00+00:00 template = "docs/section.html" diff --git a/docs/admins/clan-config.md b/docs/admins/clan-config.md deleted file mode 100644 index 3766e723d..000000000 --- a/docs/admins/clan-config.md +++ /dev/null @@ -1,69 +0,0 @@ -# cLAN config - -`clan config` allows you to manage your nixos configuration via the terminal. -Similar as how `git config` reads and sets git options, `clan config` does the same with your nixos options -It also supports auto completion making it easy to find the right options. - -## Set up clan-config - -Add the clan tool to your flake inputs: - -``` -clan.url = "git+https://git.clan.lol/clan/clan-core"; -``` - -and inside the buildClan: - -``` -imports = [ - inputs.clan.flakeModules.clan-config -]; -``` - -Add an empty config file and add it to git - -```command -echo "{}" > ./clan-settings.json -git add ./clan-settings.json -``` - -Import the clan-config module into your nixos configuration: - -```nix -{ - imports = [ - # clan-settings.json is located in the same directory as your flake. - # Adapt the path if necessary. - (builtins.fromJSON (builtins.readFile ./clan-settings.json)) - ]; -} - - -``` - -Make sure your nixos configuration is set a default - -```nix -{self, ...}: { - flake.nixosConfigurations.default = self.nixosConfigurations.my-machine; -} -``` - -Use all inputs provided by the clan-config devShell in your own devShell: - -```nix -{ ... }: { - perSystem = { pkgs, self', ... }: { - devShells.default = pkgs.mkShell { - inputsFrom = [ self'.devShells.clan-config ]; - # ... - }; - }; -} -``` - -re-load your dev-shell to make the clan tool available. - -```command -clan config --help -```