commit 5cfee059f640bb85ad04947969f686f0e0f33b39 · ryan.freumh.org/nixos

+66 -2

README.md

···

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       1
        
       

     

       2
       -
       My NixOS configs.

     

       3
        
       

     

       4
       -
       Uses flakes.

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       5

···

       1
       +
       # NixOS Configuration

     

       2
       +
       

     

       3
       +
       My personal Nix and NixOS configuration for reproducible, declarative systems and environments across multiple hosts.

     

       4
       +
       This is a personal configuration with limited applicability to others, though some patterns may be useful for reference.

     

       5
       +
       Common self-hosting services have been extracted to a separate project, [Eilean](https://github.com/RyanGibb/eilean-nix).

     

       6
       +
       

     

       7
       +
       ## Usage

     

       8
       +
       

     

       9
       +
       ### NixOS

     

       10
        
       

     

       11
       +
       See the [NixOS manual](https://nixos.org/manual/nixos/stable/#ch-installation) for how to install NixOS.

     

       12
        
       

     

       13
       +
       1. Clone this repository to `/etc/nixos/` on a NixOS system.

     

       14
       +
       2. Set up the host configuration in `/etc/nixos/hosts/<hostname>/`.

     

       15
       +
       3. Deploy the host with `nixos-rebuild switch`.

     

       16
       +
       

     

       17
       +
       ### Remote Deployment

     

       18
       +
       

     

       19
       +
       [`deploy-rs`](https://github.com/serokell/deploy-rs) can be used to update remote hosts via SSH with `deploy .#hostname`.

     

       20
       +
       

     

       21
       +
       ### Home Manager

     

       22
       +
       

     

       23
       +
       For non-NixOS systems, you can use Home Manager standalone:

     

       24
       +
       

     

       25
       +
       1. Install [Nix](https://nixos.org/download/) and [enable flakes](https://nixos.wiki/wiki/flakes#Other_Distros.2C_without_Home-Manager).

     

       26
       +
       2. Clone this repository and follow the [Home Manager manual](https://nix-community.github.io/home-manager/index.xhtml#sec-install-standalone).

     

       27
       +
       3. Deploy the profile with `home-manager switch`.

     

       28
       +
       

     

       29
       +
       Alternatively, use the home-manager command after installing it:

     

       30
       +
       `home-manager --flake /path/to/repo#<username>@<hostname> switch`

     

       31
       +
       

     

       32
       +
       ### Nix-on-Droid

     

       33
       +
       

     

       34
       +
       See [upstream](https://github.com/nix-community/nix-on-droid/).

     

       35
       +
       

     

       36
       +
       ## Repository Structure

     

       37
       +
       

     

       38
       +
       - [`flake.nix`](./flake.nix) - Entry point where inputs, outputs, and [overlays](https://nixos.org/manual/nixpkgs/stable/#chap-overlays) are defined.

     

       39
       +
         The [`flake.lock`](./flake.lock) file locks these inputs for reproducibility.

     

       40
       +
       - [`hosts/`](./hosts/) - Host-specific configurations where each subdirectory represents a separate machine.

     

       41
       +
         - Hosts are named after animals, following a rough naming scheme where,

     

       42
       +
           - Stationary hosts are mammals.

     

       43
       +
             - Servers are even-toed ungulates ([Artiodactyls](https://en.wikipedia.org/wiki/Artiodactyl)), e.g. the [Network-Attached Storage (NAS) server](https://ryan.freumh.org/nas.html) [`elephant`](./hosts/elephant).

     

       44
       +
             - SBCs are small mammals ([Eulipotyphla](https://en.wikipedia.org/wiki/Eulipotyphla)), e.g. the [Home Assistant](https://www.home-assistant.io/) server and [Zigbee](https://en.wikipedia.org/wiki/Zigbee) bridge [`shrew`](./hosts/shrew).

     

       45
       +
             - Desktops are carnivores ([Carnivora](https://en.wikipedia.org/wiki/Carnivora)), e.g. the tower PC [`vulpine`](./hosts/vulpine).

     

       46
       +
           - Mobile (battery powered) hosts are reptiles, e.g. the laptop [`gecko`](./hosts/gecko).

     

       47
       +
           - Virtual hosts are birds, e.g. the virtual private server [`owl`](./hosts/owl).

     

       48
       +
           - Work-associated hosts are aquatic.

     

       49
       +
           - [`barnacle`](./hosts/barnacle/default.nix) builds an ISO image that can be written to media like a USB flash drive to create a read-only live USB that can be booted to provide the custom environment on all my other hosts and used to, for example, install an operating system, with the [`install.sh`](./hosts/barnacle/install.sh) script.

     

       50
       +
         - Each host directory typically contains,

     

       51
       +
           - `default.nix` - Main configuration entry point that imports other modules.

     

       52
       +
           - `hardware-configuration.nix` - Hardware-specific configuration generated by `nixos-generate-config`.

     

       53
       +
           - `minimal.nix` - A minimal configuration that can be useful when updating with insuffient disk space.

     

       54
       +
             The minimal configuration can be build, the `default.nix` system garbage collected, and then the updated configuration built.

     

       55
       +
             Note this precludes trivial rollback.

     

       56
       +
           - Other modules seperating functionality, such as `services.nix`.

     

       57
       +
       - [`modules/`](./modules/) - NixOS modules of common functionality extracted into modular components which can be enabled by host configurations.

     

       58
       +
       - [`pkgs/`](./pkgs/) - Custom package definitions for packages not available in nixpkgs or requiring modifications.

     

       59
       +
       - [`home/`](./home/) - Home-manager NixOS modules configurations.

     

       60
       +
       - [`secrets/`](./secrets/) - Encrypted secrets managed by agenix.

     

       61
       +
       - [`scripts/`](./scripts/) - Miscellaneous scripts.

     

       62
       +
       - [`nix-on-droid/`](./nix-on-droid/) - [Nix-on-Droid](./#nix-on-droid) configuration.

     

       63
       +
       

     

       64
       +
       ## Managing Secrets

     

       65
       +
       

     

       66
       +
       Secrets are managed using [agenix](https://github.com/ryantm/agenix).

     

       67
       +
       To add a new secret, update [secrets.nix](./secrets/secrets.nix) and run `cd secrets && agenix -e <secret-name>.age`.

     

       68
       +
       To update an existing secret you need only do the latter.

     

       69

-5

flake.nix

···

       275
        
             formatter = inputs.nixpkgs.lib.genAttrs inputs.nixpkgs.lib.systems.flakeExposed (

     

       276
        
               system: inputs.nixpkgs.legacyPackages.${system}.nixfmt-rfc-style

     

       277
        
             );

     

       278
       -
       

     

       279
       -
             templates.host = {

     

       280
       -
               path = ./templates/host;

     

       281
       -
               description = "A basic host configuration";

     

       282
       -
             };

     

       283
        
           };

     

       284
        
       }

···

       275
        
             formatter = inputs.nixpkgs.lib.genAttrs inputs.nixpkgs.lib.systems.flakeExposed (

     

       276
        
               system: inputs.nixpkgs.legacyPackages.${system}.nixfmt-rfc-style

     

       277
        
             );

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       278
        
           };

     

       279
        
       }

-43

templates/host/default.nix

···

       1
       -
       {

     

       2
       -
         pkgs,

     

       3
       -
         lib,

     

       4
       -
         config,

     

       5
       -
         ...

     

       6
       -
       }:

     

       7
       -
       

     

       8
       -
       {

     

       9
       -
         imports = [

     

       10
       -
           ./hardware-configuration.nix

     

       11
       -
         ];

     

       12
       -
       

     

       13
       -
         boot.loader.grub = {

     

       14
       -
           enable = true;

     

       15
       -
           device = "nodev";

     

       16
       -
           efiSupport = true;

     

       17
       -
         };

     

       18
       -
         boot.loader.efi.canTouchEfiVariables = true;

     

       19
       -
       

     

       20
       -
         custom = {

     

       21
       -
           enable = true;

     

       22
       -
           #tailscale = true;

     

       23
       -
           #laptop = true;

     

       24
       -
           #gui.i3 = true;

     

       25
       -
           #gui.sway = true;

     

       26
       -
           #workstation = true;

     

       27
       -
           #autoUpgrade.enable = true;

     

       28
       -
           homeManager.enable = true;

     

       29
       -
         };

     

       30
       -
       

     

       31
       -
         home-manager.users.${config.custom.username} = {

     

       32
       -
           custom = {

     

       33
       -
             machineColour = "blue";

     

       34
       -
           };

     

       35
       -
         };

     

       36
       -
       

     

       37
       -
         environment.systemPackages = with pkgs; [

     

       38
       -
           coreutils

     

       39
       -
         ];

     

       40
       -
       

     

       41
       -
         networking.networkmanager.enable = true;

     

       42
       -
         # services.openssh.openFirewall = true;

     

       43
       -
       }