yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: make flake-parts guide flow better

Browse Source
This commit is contained in:
Qubasa
2025-09-25 18:58:52 +02:00
parent 2c2266ce8c
commit eddb1e35fc
1 changed files with 16 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
docs/site/guides/flake-parts.md
View File

@@ -1,33 +1,29 @@
Clan supports integration with [flake-parts](https://flake.parts/), a framework for constructing your `flake.nix` using modules. Follow these steps to integrate Clan with flake-parts:
Clan supports integration with [flake-parts](https://flake.parts/), a framework for constructing your `flake.nix` using modules. ## Step 1: Update Your Flake Inputs
To construct your Clan using flake-parts, follow these steps: Add `flake-parts` as a dependency in your `flake.nix` file alongside existing dependencies like `clan-core` and `nixpkgs`. Here's an example:
## Update Your Flake Inputs
To begin, you'll need to add `flake-parts` as a new dependency in your flake's inputs. This is alongside the already existing dependencies, such as `clan-core` and `nixpkgs`. Here's how you can update your `flake.nix` file:
```nix ```nix
# flake.nix # flake.nix
inputs = { inputs = {
nixpkgs.url = "github:NixOS/nixpkgs?ref=nixos-unstable"; nixpkgs.url = "github:NixOS/nixpkgs?ref=nixos-unstable";
# New flake-parts input # Add flake-parts
flake-parts.url = "github:hercules-ci/flake-parts"; flake-parts.url = "github:hercules-ci/flake-parts";
flake-parts.inputs.nixpkgs-lib.follows = "nixpkgs"; flake-parts.inputs.nixpkgs-lib.follows = "nixpkgs";
clan-core = { clan-core = {
url = "https://git.clan.lol/clan/clan-core/archive/main.tar.gz"; url = "https://git.clan.lol/clan/clan-core/archive/main.tar.gz";
inputs.nixpkgs.follows = "nixpkgs"; # Don't do this if your machines are on nixpkgs stable. inputs.nixpkgs.follows = "nixpkgs"; # Avoid this if using nixpkgs stable.
# New inputs.flake-parts.follows = "flake-parts"; # New
inputs.flake-parts.follows = "flake-parts";
}; };
} };
``` ```
## Import the Clan flake-parts Module ## Step 2: Import the Clan flake-parts Module
After updating your flake inputs, the next step is to import the Clan flake-parts module. This will make the [Clan options](/options) available within `mkFlake`. Next, import the Clan flake-parts module to make the [Clan options](/options) available within `mkFlake`:
```nix ```nix
{ {
@@ -43,9 +39,9 @@ After updating your flake inputs, the next step is to import the Clan flake-part
} }
``` ```
## Configure Clan Settings and Define Machines ## Step 3: Configure Clan Settings and Define Machines
Next you'll need to configure Clan wide settings and define machines, here's an example of how `flake.nix` should look: Configure Clan-wide settings and define machines. Here's an example `flake.nix`:
```nix ```nix
{ {
@@ -62,24 +58,22 @@ Next you'll need to configure Clan wide settings and define machines, here's an
]; ];
# Define your Clan # Define your Clan
# See: https://docs.clan.lol/reference/nix-api/clan/
clan = { clan = {
# Clan wide settings meta.name = ""; # Required and must be unique
meta.name = ""; # This is required and must be unique
machines = { machines = {
jon = { jon = {
imports = [ imports = [
./modules/firefox.nix ./modules/firefox.nix
# ... more modules # Add more modules as needed
]; ];
nixpkgs.hostPlatform = "x86_64-linux"; nixpkgs.hostPlatform = "x86_64-linux";
# Set this for Clan commands to work remotely over SSH like `clan machines update` # Enable remote Clan commands over SSH
clan.core.networking.targetHost = "root@jon"; clan.core.networking.targetHost = "root@jon";
# remote> lsblk --output NAME,ID-LINK,FSTYPE,SIZE,MOUNTPOINT # Disk configuration
disko.devices.disk.main = { disko.devices.disk.main = {
device = "/dev/disk/by-id/nvme-eui.e8238fa6bf530001001b448b4aec2929"; device = "/dev/disk/by-id/nvme-eui.e8238fa6bf530001001b448b4aec2929";
}; };
@@ -90,7 +84,4 @@ Next you'll need to configure Clan wide settings and define machines, here's an
} }
``` ```
For detailed information about configuring `flake-parts` and the available options within Clan, For more details on configuring `flake-parts` and available Clan options, refer to the [Clan module documentation](https://git.clan.lol/clan/clan-core/src/branch/main/flakeModules/clan.nix).
refer to the [Clan module](https://git.clan.lol/clan/clan-core/src/branch/main/flakeModules/clan.nix) documentation.
---