docs: improve getting started

This commit is contained in:
Johannes Kirschbauer
2024-04-10 12:26:59 +02:00
parent e6b9bcc8f3
commit a0883169e7
9 changed files with 10 additions and 78 deletions

View File

@@ -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!

View File

@@ -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.

View File

@@ -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.

View File

@@ -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

View File

@@ -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.

View File

@@ -1,4 +1,4 @@
# Backups
# 07 Backups
## Introduction to Backups

View File

@@ -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.

View File

@@ -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"

View File

@@ -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
```