Configuration - How to configure clan with your own machines

Global configuration

In the flake.nix file:

set a unique clanName.
set clanIcon (optional)
Set machineIcon per machine (optional)

These icons will be used by our future GUI.

=== "buildClan"

```nix title="clan-core.lib.buildClan"
buildClan {
    # Set a unique name 
    clanName = "Lobsters";
    # Optional, a path to an image file
    clanIcon = ./path/to/file; 
    # Should usually point to the directory of flake.nix
    directory = ./.;

    machines = {
        jon = {
            # ...
            # Optional, a path to an image file
            clanCore.machineIcon = ./path/to/file; 
        };
        # ...
    }
}
```

=== "flakeParts"

!!! info "See [Clan with flake-parts](./flake-parts.md) for help migrating to flake-parts."

```nix title="clan-core.flakeModules.default"
clan = {
    # Set a unique name 
    clanName = "Lobsters";
    # Optional, a path to an image file
    clanIcon = ./path/to/file;

    machines = {
        jon = {
            # ...
            # Optional, a path to an image file
            clanCore.machineIcon = ./path/to/file; 
        };
        # ...
    }
};
```

Machine configuration

Adding or configuring a new machine requires two simple steps:

Step 1. Identify Target Disk-ID

Find the remote disk id by executing:

ssh root@<target-computer> lsblk --output NAME,ID-LINK,FSTYPE,SIZE,MOUNTPOINT

Which should show something like:

NAME        ID-LINK                                         FSTYPE   SIZE MOUNTPOINT
sda         usb-ST_16GB_AA6271026J1000000509-0:0                    14.9G 
├─sda1      usb-ST_16GB_AA6271026J1000000509-0:0-part1                 1M 
├─sda2      usb-ST_16GB_AA6271026J1000000509-0:0-part2      vfat     100M /boot
└─sda3      usb-ST_16GB_AA6271026J1000000509-0:0-part3      ext4     2.9G /
nvme0n1     nvme-eui.e8238fa6bf530001001b448b4aec2929              476.9G 
├─nvme0n1p1 nvme-eui.e8238fa6bf530001001b448b4aec2929-part1 vfat     512M 
├─nvme0n1p2 nvme-eui.e8238fa6bf530001001b448b4aec2929-part2 ext4   459.6G 
└─nvme0n1p3 nvme-eui.e8238fa6bf530001001b448b4aec2929-part3 swap    16.8G

Edit the following fields inside the flake.nix

=== "buildClan"

 ```nix title="clan-core.lib.buildClan"
 buildClan {
   # ...
   machines = {
     "jon" = {
       imports = [
         # ...
         ./modules/disko.nix
       ];
       # ...

       # Change this to the correct ip-address or hostname
       # The hostname is the machine name by default
       clan.networking.targetHost = pkgs.lib.mkDefault "root@<hostname>"

       # Change this to the ID-LINK of the desired disk shown by 'lsblk'
       disko.devices.disk.main = {
         device = "/dev/disk/by-id/__CHANGE_ME__";
       }

       # ...
     };
   };     
 }
 ```

=== "flakeParts"

 ```nix title="clan-core.flakeModules.default"
 clan = {
   # ...
   machines = {
     "jon" = {
       imports = [
         # ...
         ./modules/disko.nix
       ];
       # ...

       # Change this to the correct ip-address or hostname
       # The hostname is the machine name by default
       clan.networking.targetHost = pkgs.lib.mkDefault "root@<hostname>"

       # Change this to the ID-LINK of the desired disk shown by 'lsblk'
       disko.devices.disk.main = {
         device = "/dev/disk/by-id/__CHANGE_ME__";
       }

       # ...
     };
   };     
 };
 ```

Step 2. Detect hardware specific drivers

Generate a hardware-configuration.nix for your target computer

ssh root@<target-computer> nixos-generate-config --no-filesystems --show-hardware-config > hardware-configuration.nix

Move the generated file to machines/jon/hardware-configuration.nix.

Initialize the facts

!!! Info All facts are automatically initialized.

If you need additional help see our facts chapter

Whats next?

Deploying: Deploying a Machine configuration
Secrets: Learn about secrets and facts

4.6 KiB Raw Blame History