top-level configurations for all my NixOS machines
Go to file
Colin 5ed29ceb47 servo: /var/media: fixup permissions so everything is r/w by "media" group, including sftpgo 2024-03-28 23:14:40 +00:00
doc README: add a graphic 2024-02-15 01:01:31 +00:00
hosts servo: /var/media: fixup permissions so everything is r/w by "media" group, including sftpgo 2024-03-28 23:14:40 +00:00
integrations/nur flake: add "check-nur" app to validate that my repo passes NUR checks 2023-06-26 01:26:13 +00:00
modules feeds: add Hardcore Software by Steven Sinofsky 2024-03-26 14:08:13 +00:00
nixpatches nixpkgs: remove obsoleted patches 2024-03-26 11:16:43 +00:00
overlays nixpkgs: 2024-03-12 -> 2024-03-13 2024-03-13 15:37:50 +00:00
pkgs nits: update `--replace` uses to `--replace-{fail,quiet}` as appropriate 2024-03-24 12:49:18 +00:00
secrets schlock: ship as sane.programs 2024-03-07 10:10:39 +00:00
templates begin packaging for bonsai (incomplete) 2023-05-18 01:31:06 +00:00
.gitignore rename working -> .working 2023-11-23 03:29:04 +00:00
.sops.yaml sops: fix key map after universal -> common rename 2023-05-16 07:19:09 +00:00
README.md sxmo-utils: mark as broken/unmaintained 2024-03-09 21:09:32 +00:00
TODO.md todo.md: remove completed xdg-desktop-portal item 2024-03-10 01:03:23 +00:00
default.nix bypass-paywalls-clean: 3.2.5.0 -> 3.3.4.0; lay the foundation for updateScripts in this repo 2023-09-22 10:13:56 +00:00
flake.lock nixpkgs: 2024-03-25 -> 2024-03-26; others 2024-03-26 09:44:45 +00:00
flake.nix sway: ship the nightly version 2024-03-11 05:53:14 +00:00

README.md

hello

.❄️≡We|_c0m3 7o m`/ f14k≡❄️.

What's Here

this is the top-level repo from which i configure/deploy all my NixOS machines:

  • desktop
  • laptop
  • server
  • mobile phone (Pinephone)

everything outside of hosts/ and secrets/ is intended for export, to be importable for use by 3rd parties. the only hard dependency for my exported pkgs/modules should be nixpkgs. building hosts/ will require sops.

you might specifically be interested in these files (elaborated further in #key-points-of-interest):

Using This Repo In Your Own Config

this should be a pretty "standard" flake. just reference it, and import either

  • nixosModules.sane (for the modules)
  • overlays.pkgs (for the packages)

or follow the instructions here to use it via the Nix User Repositories.

Layout

  • doc/
    • instructions for tasks i find myself doing semi-occasionally in this repo.
  • hosts/
    • the bulk of config which isn't factored with external use in mind.
    • that is, if you were to add this repo to a flake.nix for your own use, you won't likely be depending on anything in this directory.
  • integrations/
    • code intended for consumption by external tools (e.g. the Nix User Repos)
  • modules/
    • config which is gated behind enable flags, in similar style to nixpkgs' nixos/ directory.
    • if you depend on this repo, it's most likely for something in this directory.
  • nixpatches/
    • literally, diffs i apply atop upstream nixpkgs before performing further eval.
  • overlays/
    • exposed via the overlays output in flake.nix.
    • predominantly a list of callPackage directives.
  • pkgs/
    • derivations for things not yet packaged in nixpkgs.
    • derivations for things from nixpkgs which i need to override for some reason.
    • inline code for wholly custom packages (e.g. pkgs/additional/sane-scripts/ for CLI tools that are highly specific to my setup).
  • scripts/
    • scripts which aren't reachable on a deployed system, but may aid manual deployments
  • secrets/
    • encrypted keys, API tokens, anything which one or more of my machines needs read access to but shouldn't be world-readable.
    • not much to see here
  • templates/
    • exposed via the templates output in flake.nix.
    • used to instantiate short-lived environments.
    • used to auto-fill the boiler-plate portions of new packages.

Key Points of Interest

i.e. you might find value in using these in your own config:

  • modules/fs/
    • use this to statically define leafs and nodes anywhere in the filesystem, not just inside /nix/store.
    • e.g. specify that /var/www should be:
      • owned by a specific user/group
      • set to a specific mode
      • symlinked to some other path
      • populated with some statically-defined data
      • populated according to some script
      • created as a dependency of some service (e.g. nginx)
    • values defined here are applied neither at evaluation time nor at activation time.
      • rather, they become systemd services.
      • systemd manages dependencies
      • e.g. link /var/www -> /mnt/my-drive/www only after /mnt/my-drive/www appears)
    • this is akin to using Home Manager's file API -- the part which lets you statically define ~/.config files -- just with a different philosophy.
  • modules/persist/
    • my alternative to the Impermanence module.
    • this builds atop modules/fs/ to achieve things stock impermanence can't:
      • persist things to encrypted storage which is unlocked at login time (pam_mount).
      • "persist" cache directories -- to free up RAM -- but auto-wipe them on mount and encrypt them to ephemeral keys so they're unreadable post shutdown/unmount.
  • modules/programs/
    • like nixpkgs' programs options, but allows both system-wide or per-user deployment.
    • allows fs and persist config values to be gated behind program deployment:
      • e.g. /home/<user>/.mozilla/firefox is persisted only for users who sane.programs.firefox.enableFor.user."<user>" = true;
    • allows aggressive sandboxing any program:
      • sane.programs.firefox.sandbox.method = "bwrap"; # sandbox with bubblewrap
      • sane.programs.firefox.sandbox.whitelistWayland = true; # allow it to render a wayland window
      • sane.programs.firefox.sandbox.extraHomePaths = [ "Downloads" ]; # allow it read/write access to ~/Downloads
      • integrated with fs and persist modules so that programs' config files and persisted data stores are linked into the sandbox w/o any extra involvement.
  • modules/users.nix
    • convenience layer atop the above modules so that you can just write fs.".config/git" instead of fs."/home/colin/.config/git"

some things in here could easily find broader use. if you would find benefit in them being factored out of my config, message me and we could work to make that happen.

Mirrors

this repo exists in a few known locations:

Contact

if you want to contact me for questions, or collaborate to split something useful into a shared repo, etc, you can reach me via any method listed here. patches, for this repo or any other i host, will be warmly welcomed in any manner you see fit: git send-email, DM'ing the patch over Matrix/Lemmy/ActivityPub/etc, even a literal PR where you link me to your own clone.