Sydnix

hosts/

Each directory hosts/«HOST» is expected to configure a single specific device, where «HOST» is the device's exact hostname. Said directory «HOST» should have at least the following structure:

hosts
└── «HOST»
    ├── configuration.nix
    └── system.nix

Where configuration.nix is the main entry point imported by the top-level flake, and system.nix evaluates to a string corresponding to the system option to be used.

users/

Similarly to the hosts directory, each sub-directory users/«USER» is assumed to have some structure, and that «USER» is the precise username desired.

users
└── «USER»
    └── default.nix

Where default.nix returns an attrset of form

{
  # The NixOS option `users.users.«USER»` will be set to result of
  # `systemConfiguration`.
  systemConfiguration = { config, pkgs, lib, ... }: {
    # isNormalUser = true;
    # extraGroups = [ "wheel" ];
    # ...
  };

  # Home-manager configuration
  homeConfiguration = { config, pkgs, lib, ... }: {
    # home.packages = [ pkgs.hello ];
    # ...
  };
}

modules/

modules
├── home
│   └── «Various home-manager modules»…
└── nixos
    ├── defaults
    │   └── «NixOS modules that are *enabled by default*»…
    ├── deertopia
    │   └── «NixOS modules that are *specific to Deertopia*»…
    └── «Various NixOS modules»…

Boot process

What follows is an overview of modules/nixos/impermanence/rollback.nix.

On boot, ...

• The existing subvolume root filesystem will be moved to a 'death row' directory, where it will live for about three days before deletion. Precisely, «btrfs-filesystem»/«root-subvolume» is moved to «btrfs-filesystem»/old-roots/«timestamp». The brief grace period allows for easy recovery in the (very common) case where files are unintentionally deleted due to the user's silly human negligence.

• A new, blank subvolume is created in place of the previous. Precisely, the subvolume «btrfs-filesystem»/«root-subvolume» is created.

• Any subvolumes under «btrfs-filesystem»/old-roots older than three days are deleted.

The /persist directory

/persist/root

Persistent files to be linked into the real root, /. These are managed by Impermanence.

/persist/home/«user»

Persistent files to be linked into the analogous location under the real home, /home/«user». These are managed by Impermanence.

/persist/vault/«user»

Persistent files belonging to specific users. This differs from the persistent home directories in that files are not necessarily linked anywhere.

/persist/private-keys

The private key counterparts to the keys listed in this repository's own public-keys directory.

Module API/option docs

unimplemented! (statistics-cookie)

{:type "statistics-cookie", :begin 6397, :end 6403, :value "[2/30]", :post-blank 0, :position {:start {:line 181, :column 33, :offset 6397}, :end {:line 181, :column 39, :offset 6403}}}

• file:/persist/dots/home/glab.nix

• file:/persist/dots/home/gpg.nix

• file:/persist/dots/home/impermanence.nix

• file:/persist/dots/home/mpd.nix

• file:/persist/dots/home/sops.nix

• file:/persist/dots/home/syncthing.nix

• file:/persist/dots/nixos/deertopia.nix

• file:/persist/dots/nixos/deertopia/authelia.nix

• file:/persist/dots/nixos/deertopia/bepasty.nix

• file:/persist/dots/nixos/deertopia/jellyfin.nix

• file:/persist/dots/nixos/deertopia/lldap.nix

• file:/persist/dots/nixos/deertopia/nginx.nix

• file:/persist/dots/nixos/deertopia/slskd.nix

• file:/persist/dots/nixos/deertopia/webdav.nix

• file:/persist/dots/nixos/defaults.nix

• file:/persist/dots/nixos/defaults/documentation.nix

• file:/persist/dots/nixos/defaults/nixpkgs.nix

• file:/persist/dots/nixos/dropbox.nix

• file:/persist/dots/nixos/filesystemType.nix

• file:/persist/dots/nixos/git-annex.nix

• file:/persist/dots/nixos/gpg.nix

• file:/persist/dots/nixos/hosts.nix

• file:/persist/dots/nixos/impermanence

• file:/persist/dots/nixos/impermanence.nix

• file:/persist/dots/nixos/impermanence/rollback.nix

• file:/persist/dots/nixos/niri.nix

• file:/persist/dots/nixos/sops.nix

• file:/persist/dots/nixos/syncthing.nix

• file:/persist/dots/nixos/tailscale.nix

• file:/persist/dots/nixos/users.nix

Concepts

unimplemented! (statistics-cookie)

{:type "statistics-cookie", :begin 7932, :end 7935, :value "[/]", :post-blank 0, :position {:start {:line 214, :column 19, :offset 7932}, :end {:line 214, :column 22, :offset 7935}}}

• Impermanence

• Deertopia services

• Deertopia network diagram (is that a fine term for it?)

Remove uses of with lib;

Grep for with lib

Refactor modules/ directory

modules
├── home
│   ├── sydnix
│   │   ├── crumb
│   │   │   └── «My configurations»
│   │   └── «Personal Sydnix modules»
│   └── «Home-manager modules that could be upstreamed»
└── nixos
    ├── sydnix
    │   ├── webdav.nix
    │   └── deertopia
    │       └── «Deertopia-specific modules»
    └── «NixOS modules that could be upstreamed»

Import sydnix-cli and port-tools via flake's self.packages

Refactor default modules

All code in default.nix and defaults/ should be moved into individual modules. default.nix's role is then subjugated to enabling those modules and bundling them under a single enable switch.

Deprecate sydnix.deertopia.webdav

I believe Copyparty has a built-in WebDAV server. This would allow more refined permissions, and is one less required service.

sydnix.deertopia.nginx.vhosts should not set a root by default

It's currently only useful for the www and dav vhosts, and otherwise is nothing but a potential problem-causer.

lib.sydnix

• mkMutableSymlink

• listNixDirectory

Complete ten Nix TODOs

Grep Sydnix for "TODO"

Log completed TODOs here:

Refactor users/crumb/programs/*.nix into proper modules

Niri

wbg

Waybar

Swaylock

Extensions

Settings

Search engines

shopt -s histverify

Don’t execute expanded result immediately.

Emacs

Managed by users/crumb/programs/emacs.nix.

See configuration notes here.

Bash

Managed by the Home-manager module.

(neo)vim

Managed by a hand-rolled wrapper. See users/crumb/programs/nvim.nix.

Readline

pass → passage

mpdscribble

$EDITOR

See choose-editor.

nix-clean

Collect garbage, clean up boot entries, delete old generations...

https://discourse.nixos.org/t/what-to-do-with-a-full-boot-partition/2049

choose-editor

• If the Emacs daemon is running...

  • ...then run emacsclient.

  • ...otherwise, prompt the user to choose between Emacs and Vim

    • If Emacs: run emacs.

    • If Vim: In order, try nvim, vim, then vi.

      • If neither are available, use nix run nixpkgs#nvim

        • If this fails, try nano.

• Support --pager

rage-edit

forget-host HOST

Remove a given host from ~/.ssh/known_hosts. Something like sed -i -e '/192.168.122.54/d' .ssh/known_hosts.

Confirm by printing diff.

scratch-dir [NAME]

Create a new tempdir called [NAME], and cd into it.

doctor / status

Run various checks on the system.

• Sizes of caches. perhaps those listed by sydnix.impermanence.cache.{files,directories}? Offer to clean them if they're getting old or large.

• Check for available upgrades. Flake inputs, overlays, emacs packages, etc.

persist status

List persistent files per user, and show their mount strategy.

• Show info about sydnix.impermanence.cache values. Extend that option to have "description" and "consequences" fields, which are shown to users before clearing them. e.g.

    {
      sydnix.impermanence.cache.directories.".local/share/emacs/cache" = {
        description = "Root of all caches for Emacs and Emacs packages.";
        consequences = [
          "All known projects will be forgotten"
          "All trusted .dir-locals.el files and values will be forgotten"
        ];
      };
    }
  

   $ sydnix cache clear
   Recursively remove `~/.local/share/emacs/cache'?
   - All known projects will be forgotten
   - All trusted .dir-locals.el files and values will be forgotten
  [y/n]
  «more caches…»
  

persist prepare

Command sydnix persist prepare «file or directory» will

1. Move a directory to /persist

2. Optionally mount/bind/symlink it back into place.

3. Print Nix code necessary to persist it.