+ 
+ 
+
+
+ ```
+
+ This will activate the `chaostheatre` configuration on your system, which is a de-facto mirror of my main configuration with secret-based settings removed.
+ Please keep in mind that this limited installer will make local changes to the cloned repository in order to be able to install it (otherwise the builder would fail at fetching my private secrets repository). As such, this should only be used to evaluate the system - if you want to use it longterm, you will need to create a fork and make some changes.
+
+
+ ### Deployment
+
+ Click here for instructions on how to install the demo system
+ + If you just want to see if this configuration is for you, run this command on any system that has `nix` installed: + + ``` shell + nix run --experimental-features 'nix-command flakes' github:Swarsel/.dotfiles#swarsel-rebuild -- -u
+ /default.nix` (you can use one of the other configurations as a template. Also see https://github.com/Swarsel/.dotfiles/tree/main/modules for a list of all additional options). At the very least, you should replace the `secrets/` directory with your own secrets and replace the SSH public keys with your own ones (otherwise I will come visit you!πβ€οΈ). I personally recommend to use the literate configuration and `org-babel-tangle-file` in Emacs, but you can also simply edit the separate `.nix` files.
+ 1) Have a system with `nix` available booted (this does not need to be installed, i.e. you can use a NixOS installer image; a custom minimal installer ISO can be built by running `just iso` in the root of this repo)
+ 2) Make sure that your Yubikey is plugged in or that you have your SSH key available (and configured)
+ 3) Run `swarsel-bootstrap -n -d ` on your existing system.
+ - Alternatively (if you run this on a system that is not yet running this configuration), you can also run `nix run --experimental-features 'nix-command flakes' github:Swarsel/.dotfiles -- -n -d ` (this runs the same program as the command above).
+ 4) Follow the installers instructions:
+ - you will have to choose a disk encryption password (if you want that feature)
+ - you will have to confirm once that the target system has rebooted
+ - you will have to enter the root password once during the final system install
+ 5) That should be it! The installer will take care of setting up disks, secrets, and the rest of the hardware configuration! You will still have to sign in manually to some webservices etc.
+
+ #### Local deployment (recommended for setting up the first system)
+
+ 1) Boot the latest install ISO from this repository on an UEFI system.
+ 2) Run `swarsel-install -n `
+ 3) Reboot
+
+ Alternatively, to install this from any NixOS live ISO, run `nix run --experimental-features 'nix-command flakes' github:Swarsel/.dotfiles#install -- -n ` at step 2.
+
+
+ ## Infrastructure
+
+ Click here for deployment instructions
+ + The deployment process for this configuration is mostly automated, there are only a few steps that are needed to be done manually. You can choose between a remote deployment strategy that is also able to deploy new age keys for sops for you and a local installer that will only install the system without any secret handling. + + #### Remote deployment (recommended if you have at least one running system) + + 0) Fork this repo, and write your own host config at `hosts/nixos/
+ >
+
+ ### Services
+
+ <>
+
+ ### Hosts
+
+ <>
+
+
+ ## General Nix tips & useful links
+
+ Click here for a summary of my infrastructure
+ + ### Programs + + <
+ ` - this can be e.g. useful if you accidentally removed home-manager from your packages on a non-NixOS machine. Alternatively, use [comma](https://github.com/nix-community/comma)
+ - More info on `nix [...]` commands: https://nixos.org/manual/nix/stable/command-ref/new-cli/nix
+ - When you are trying to setup a new configuration part, [GitHub code search](https://github.com/search?q=language%3ANix&type=code) can really help you to find a working configuration. Just filter for `.nix` files and the options you are trying to set up.
+ - getting packages at a different version than your target (or not packaged at all) can be done in most cases easily with fetchFromGithub (https://ryantm.github.io/nixpkgs/builders/fetchers/)
+ - you can easily install old revisions of packages using https://lazamar.co.uk/nix-versions/. You can conveniently spawn a shell with a chosen package available using `vershell `. Just make sure to pick a revision that has flakes enabled, otherwise you will need the legacy way of spawning the shell (see the link for more info)
+
+ - These links are your best friends:
+ - The nix documentation: https://nix.dev/
+ - The nixpkgs reference manual: https://nixos.org/manual/nixpkgs/unstable/#buildpythonapplication-function
+ - the [nixpkgs repository](https://github.com/NixOS/nixpkgs) - especially useful to look at the various READMEs that are in various places in the repository (find using GitHub code search) as well as the [issues](https://github.com/Swarsel/.dotfiles/issues) and [PRs](https://github.com/Swarsel/.dotfiles/pulls) pages
+ - and the [nixpkgs Pull Request Tracker](https://nixpk.gs/pr-tracker.html)
+ - The NixOS manual: https://nixos.org/manual/nixos/stable/
+ - The NixOS package search: https://search.nixos.org/packages
+ - and the nix package version search: https://lazamar.co.uk/nix-versions/
+ - The NixOS option search https://search.nixos.org/options
+ - [mipmip](https://github.com/mipmip)'s home-manager option search: https://mipmip.github.io/home-manager-option-search/
+ - [Alan Pearce](https://alanpearce.eu/)'s nix-darwin search: https://searchix.alanpearce.eu/options/darwin/search (which supports all of the other versions as well :o)
+ - For the above, you can use the CLI tool [manix](https://github.com/mlvzk/manix)
+ - Nix function search: https://noogle.dev/
+ - Search for nix-community options: https://search.nΓΌschtos.de/
+ - But that is not all:
+ - Some nix resources
+ - A tour of Nix: https://nixcloud.io/tour/
+ - The Nix One Pager: https://github.com/tazjin/nix-1p
+ - another one page introduction: https://learnxinyminutes.com/nix/
+ - a very short introduction to Nix features: https://zaynetro.com/explainix
+ - introductory nix article: https://medium.com/@MrJamesFisher/nix-by-example-a0063a1a4c55
+ - and another one: https://web.archive.org/web/20210121042658/https://ebzzry.io/en/nix/#nix
+ - How to learn nix: https://ianthehenry.com/posts/how-to-learn-nix/
+ - the Nix Cookbook: https://github.com/functionalops/nix-cookbook?tab=readme-ov-file
+ - and the Nix Pills: https://nixos.org/guides/nix-pills/
+ - Some resources on flakes
+ - Why to use flakes and introduction to flakes: https://www.tweag.io/blog/2020-05-25-flakes/
+ - The [NixOS & Flakes Book](https://nixos-and-flakes.thiscute.world/)
+ - and [Wombat's book](https://mhwombat.codeberg.page/nix-book/)
+ - or the [Zero to Nix series](https://zero-to-nix.com/)
+ - Practical nix flakes article: https://serokell.io/blog/practical-nix-flakes
+ - A bit on Overlays:
+ - Overview on overlays: [Mastering Nixpkgs overlays article](https://nixcademy.com/posts/mastering-nixpkgs-overlays-techniques-and-best-practice/)
+ - Some examples on best practises: [Do's and Don'ts of overlays](https://flyingcircus.io/news/detailsansicht/nixos-the-dos-and-donts-of-nixpkgs-overlays)
+ - Blog article about overrides: https://bobvanderlinden.me/customizing-packages-in-nix/#using-modified-packages
+ - Also useful is the [official NixOS Wiki](https://wiki.nixos.org/wiki/NixOS_Wiki)
+ - there is also the [unofficial NixOS Wiki](https://nixos.wiki/) that tends to be a bit outdated, use with care
+ - Some resources for specific nix tools:
+ - Flake output reference: https://nixos-and-flakes.thiscute.world/other-usage-of-flakes/outputs
+ - You can find public repositories with modules at https://nur.nix-community.org/ (you should check what you are installing however):
+ - I like to use this for rycee's firefox extensions: https://nur.nix-community.org/repos/rycee/
+ - List of nerdfonts: https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/data/fonts/nerd-fonts/manifests/fonts.json
+ - Stylix configuration options: https://danth.github.io/stylix/
+ - nix-on-droid options: https://nix-community.github.io/nix-on-droid/nix-on-droid-options.html#sec-options
+ - Very useful tools that are mostly not directly used in configuration but instead called on need:
+ - Convert non-NixOS machines to NixOS using [nixos-infect](https://github.com/elitak/nixos-infect)
+ - Create various installation media with [nixos-generators](https://github.com/nix-community/nixos-generators)
+ - Remotely deploy NixOS using [nixos-anywhere](https://github.com/nix-community/nixos-anywhere)
+ - And a few links that are not directly nix-related, but may still serve you well:
+ - List of pre-commit-hooks: https://devenv.sh/reference/options/#pre-commithooks
+ - Waybar configuration: https://github.com/Alexays/Waybar/wiki
+
+
+ ## Attributions, Acknowledgements, Inspirations, etc.
+
+ These are in random order (also known as 'the order in which I discovered them'). I would like to express my gratitude to:
+
+ - All the great people who have contributed code for the nix-community, with special mentions for (this list is unfairly incomplete):
+ Click here for a summary of nix tips & links
+ + - Below is a small list of tips that should be helpful if you are new to the nix ecosystem: + + - Temporarily install any package using `nix shell nixpkgs#
+
+
+ - All the people who have inspired me with their configurations (sadly also highly incomplete):
+ Click here to expand...
+ + - [guibou](https://github.com/guibou/) + - [rycee](https://github.com/rycee) + - [adisbladis](https://github.com/adisbladis) + - [Mic92](https://github.com/Mic92/sops-nix) + - [lassulus](https://github.com/lassulus) + - [danth](https://github.com/danth/) + - [LnL7](https://github.com/LnL7) + - [t184256](https://github.com/t184256) + - [bennofs](https://github.com/bennofs) + - [Pandapip1](https://github.com/Pandapip1) + - [zowoq](https://github.com/zowoq) + - [numtide](https://github.com/numtide) + - [hsjobeki](https://github.com/hsjobeki) + - [blitz](https://github.com/blitz) + - [RaitoBezarius](https://github.com/RaitoBezarius) + - [nikstur](https://github.com/nikstur) + - [talyz](https://github.com/talyz) + - [infinisil](https://github.com/infinisil) + - [zhaofengli](https://github.com/zhaofengli) + - [Artturin](https://github.com/Artturin) + - [oddlama](https://github.com/oddlama) +
+
+
+ If you feel that I forgot to pay you tribute for code that I used in this repository, please shoot me a message and I will fix it :)
+
+
+#+end_src
diff --git a/index.html b/index.html
index 9e5a109..b511e56 100644
--- a/index.html
+++ b/index.html
@@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
+
Click here to expand...
+ + - [theSuess](https://github.com/theSuess) with their [home-manager](https://code.kulupu.party/thesuess/home-manager) + - [hlissner](https://github.com/hlissner) with their [dotfiles](https://github.com/hlissner/dotfiles) + - [drduh](https://github.com/drduh/YubiKey-Guide) with their [YubiKey-Guide](https://github.com/drduh/YubiKey-Guide) + - [AntonHakansson](https://github.com/AntonHakansson) with their [nixos-config](https://github.com/AntonHakansson/nixos-config?tab=readme-ov-file) + - [Guekka](https://github.com/Guekka/) with their [blog](https://guekka.github.io/) + - [NotAShelf](https://github.com/NotAShelf) with their [nyx](https://github.com/NotAShelf/nyx) + - [Misterio77](https://github.com/Misterio77) with their [nix-config](https://github.com/Misterio77/nix-config) + - [0xdade](https://github.com/0xdade) with their [blog](https://0xda.de/blog/) + - [EmergentMind](https://github.com/EmergentMind) with their [nix-config](https://github.com/EmergentMind/nix-config) + - [librephoenix](https://github.com/librephoenix) with their [nixos-config](https://github.com/librephoenix/nixos-config) + - [Xe](https://github.com/Xe) with their [blog](https://xeiaso.net/blog/) + - [oddlama](https://github.com/oddlama) with their absolutely incredible [nix-config](https:/github.com/oddlama/nix-config) +- 1. Introduction (no code)
- 2. flake.nix @@ -359,7 +362,7 @@
- 3.2.5.1. extra-builtins
- 3.2.5.2. sops-decrypt-and-cache
- 3.2.5.3. nix-topology -
- 3.2.5.4. Globals +
- 3.2.5.4. Globals
-This file has 73111 words spanning 19692 lines and was last revised on 2025-06-30 23:10:29 +0200. +This file has 76328 words spanning 20028 lines and was last revised on 2025-07-01 00:53:42 +0200.
@@ -775,9 +780,9 @@ This configuration is part of a NixOS system that is (nearly) fully declarative This literate configuration lets me explain my choices to my future self as well as you, the reader. I go to great lengths to explain the choices for all configuration steps that I take in order for me to pay due diligence in crafting my setup, and not simply copying big chunks of other peoples code. Also, the literate configuration approach is very convenient to me as I only need to keep of (ideally) a single file to manage all of my configuration. I hope that this documentation will make it easier for beginners to get into Emacs and NixOS as I know it can be a struggle in the beginning.
-
-
1.1. Structure of this file
-
+
-
+
-1.1. Structure of this file
+This file is structured as follows:
@@ -798,7 +803,7 @@ This section defines my Emacs configuration. For a while, I considered to use ry-My emacs is built using the emacs-overlay nix flake, which builds a bleeding edge emacs on wayland (pgtk) with utilities like treesitter support. By executing the below source block, the current build setting can be updated at any time, and you can see my most up-to-date build options (last updated: 2025-06-30 23:10:29 +0200) +My emacs is built using the emacs-overlay nix flake, which builds a bleeding edge emacs on wayland (pgtk) with utilities like treesitter support. By executing the below source block, the current build setting can be updated at any time, and you can see my most up-to-date build options (last updated: 2025-07-01 00:53:42 +0200)
@@ -921,9 +926,9 @@ not that noweb-reffed blocks will not be indented correctly. You will want to ac
-
1.2. TODO Structure of this flake
-
+
+
+1.2. TODO Structure of this flake
+The structure of this flake as seen many revisions, however lately I have settled on a system that I have grown to like:
@@ -1002,7 +1007,7 @@ By themselves, most of the files in the modules folder will not do anything. Inprofiles: This folder splits up into home and nixos subfolders, where groupings of module enablers are stored for the respective home and nix setups. Note that home profiles are also used in NixOS setups (extensively even)!nix: This special folder holds mostly .nix files that are not automatically loaded, but rather setup specific things that affect most of the flake. For example, here lies the aforementioned extra-builtins as well as the setup for the Globals system. TODO: Move flake-parts units there and explain them here.nix: This special folder holds mostly .nix files that are not automatically loaded, but rather setup specific things that affect most of the flake. For example, here lies the aforementioned extra-builtins as well as the setup for the Globals system. TODO: Move flake-parts units there and explain them here.lib: This folder holds utility functions that I add to the nixpkgs library under the swarselsystems attribute set. An example would be the mkIfElse function.
+
+1.3. Hosts
+
+
++Here I give a brief overview over the hostmachines that I am using. This is held in markdown so that I can render it into my GitHub README. +
+ +
+
+| Name | Hardware | Use | +|--------------------|-----------------------------------------------------|------------------------------------------------------| +|π» **nbl-imba-2** | Framework Laptop 16, AMD 7940HS, RX 7700S, 64GB RAM | Work laptop | +|π» **nbm-imba-166** | MacBook Pro 2016 | MacOS Sandbox | +|π₯οΈ **winters** | ASRock J4105-ITX, 32GB RAM | Main homeserver and data storgae | +|π₯οΈ **sync** | Oracle Cloud: VM.Standard.E2.1.Micro | Server for lightweight synchronization tasks | +|π₯οΈ **moonside** | Oracle Cloud: VM.Standard.A1.Flex, 4 OCPUs, 24GB RAM| Proxy for local services, some lightweight services | +|π± **magicant** | Samsung Galaxy Z Flip 6 | Phone | +|πΏ **drugstore** | - | ISO installer configuration | +|β **chaotheatre** | - | Demo config for checking out my configurtion | +|β **toto** | - | Helper configuration for bootstrapping a new system | +|π **home** | - | Reference configuration for a home-manager only host | ++
+
+1.4. Programs
+
+
+
+
+| Topic | Program | +|---------------|---------------------------------| +|π **Shell** | [zsh](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/zsh.nix) | +|πͺ **DM** | [greetd](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/common/login.nix) | +|πͺ **WM** | [SwayFX](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/sway.nix) | +|β©οΈ **Bar** | [Waybar](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/waybar.nix) | +|βοΈ **Editor** | [Emacs](https://github.com/Swarsel/.dotfiles/tree/main/programs/emacs/init.el) | +|π₯οΈ **Terminal**| [Kitty](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/kitty.nix) | +|π **Launcher**| [Fuzzel](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/fuzzel.nix) | +|π¨ **Alerts** | [Mako](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/mako.nix) | +|π **Browser** | [Firefox](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/zsh.nix) | +|π¨ **Theme** | [City-Lights (managed by stylix)](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/sharedsetup.nix)| ++
+
1.5. Services
+
+
+
+
+| Topic | Program | +|-----------------------|---------------------------------| +|π **Books** | [Kavita](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/kavita.nix) | +|πΌ **Videos** | [Jellyfin](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/jellyfin.nix) | +|π΅ **Music** | [Navidrome](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/navidrome.nix) + [Spotifyd](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/spotifyd.nix) + [MPD](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/mpd.nix) | +|π¨οΈ **Messaging** | [Matrix](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/matrix.nix) | +|π **Filesharing** | [Nectcloud](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/nextcloud.nix) | +|π· **Photos** | [Immich](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/immich.nix) | +|π **Documents** | [Paperless](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/paperless.nix) | +|π **File Sync** | [Syncthing](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/syncthing.nix) | +|πΎ **Backups** | [Restic](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/restic.nix) | +|ποΈ **Monitoring** | [Grafana](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/monitoring.nix) | +|π΄ **RSS** | [FreshRss](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/freshrss.nix) | +|π³ **Git** | [Forgejo](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/forgejo.nix) | +|β **Anki Sync** | [Anki Sync Server](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/ankisync.nix) | +|πͺͺ **SSO** | [Kanidm](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/kanidm.nix) + [oauth2-proxy](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/oauth2-proxy.nix) | +|πΈ **Finance** | [Firefly-III](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/firefly-iii.nix) | +|π **Collections** | [Koillection](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/koillection.nix) | +|ποΈ **Shell History** | [Atuin](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/atuin.nix) | +|π **CalDav/CardDav** | [Radicale](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/radicale.nix) | +|βοΈ **P2P Filesharing** | [Croc](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/croc.nix) | +|βοΈ **Paste Tool** | [Microbin](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/microbin.nix) | +|π **Link Shortener** | [Shlink](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/shlink.nix) | ++
2. flake.nix
@@ -6815,9 +6895,9 @@ in
-
3.2.5.4. Globals
-
+
+
-3.2.5.4. Globals
+{ inputs, ... }:
{
@@ -7135,9 +7215,9 @@ in
-
3.3.1.5. Global options
-
+
+
+3.3.1.5. Global options
+{ lib, options, ... }:
let
@@ -20856,15 +20936,23 @@ This sets up the dashboard, which is really quite useless. But, it
+
5. Appendix A: Noweb-Ref blocks
+
+
++This sections is no longer used really. An introduction can be found in Structure of this file under the historical note. The little noweb-ref blocks that I still use are found in Hosts and Services. +
+
-
5. Appendix B: Supplementary Files
+6. Appendix B: Supplementary Files
This section now holds some of the configuration files that cannot be defined directly within NixOS configuration. These files are usually symlinked using home.file.
-
5.1. Server Emacs config
+6.1. Server Emacs config
On my server, I use a reduced, self-contained emacs configuration that only serves as an elfeed sync server. This is currently unused, however, I am keeping this in here for now as a reference. The big problem here was the bidirectional syncing using bjm/elfeed-updater. As I am using this both on a laptop client (using elfeed) as well as on a mobile phone (using elfeed-cljsrn over elfeed-web), I set up a Syncthing service to take care of the feeds as well as the db state. However, I could only either achieve changes propagating properly from the laptop to the server or from the phone to the server. Both would not work. This current state represents the state where from-laptop changes would propagate. To allow from-phone changes, change (elfeed-db-load) in bjm/elfeed-updater to (elfeed-db-save).
@@ -20958,7 +21046,7 @@ On my server, I use a reduced, self-contained emacs configuration that only serv
-
5.2. tridactylrc
+6.2. tridactylrc
This is the configuration file for tridactyl, which provides keyboard-driven navigation in firefox. Pay attention to the warnings in this file; depending on your browsing behaviour, you might expose yourself to some vulnerabilities by copying this configuration. @@ -21103,7 +21191,7 @@ autocmd DocStart vc-impimba-1.m.imp.ac.at/ui/webconsole mode ignore
-
+5.3. tridactyl theme
+6.3. tridactyl theme
@@ -21274,7 +21362,7 @@ autocmd DocStart vc-impimba-1.m.imp.ac.at/ui/webconsole mode ignore
-
5.4. Waybar style.css
+6.4. Waybar style.css
This is the stylesheet used by waybar. @@ -21552,7 +21640,7 @@ window#waybar.hidden {
-
+
+5.5. justfile
+6.5. justfile
This file defines a few workflows that I often need to run when working on my configuration. This works similar to make, but is geared towards general tasks and as such requires no extra handling (as long as there are no dependencies involved) or .PHONY recipes.
@@ -21592,6 +21680,299 @@ dd DRIVE ISO:
sync USER HOST:
rsync -av --filter=':- .gitignore' -e "ssh -l {{USER}}" . {{USER}}@{{HOST}}:.dotfiles/
+
+
+
6.6. GitHub Readme
+
+
@@ -21600,7 +21981,7 @@ sync USER HOST:
+Here lies defined the readme for GitHub and Forgejo: +
+ +
+
[](https://actions-badge.atrox.dev/Swarsel/.dotfiles/goto?ref=main) + +###### Disclaimer + +You probably do not want to use this setup verbatim. This is made to fit my specific use cases, and I do not guarantee best practises everywhere. Changes are made on a daily basis. + +That being said, there is a lot of general configuration that you *probably* can use without changes; if you only want to use this repository as a starting point for your own configuration, you should be fine. See below for more information. Also, if you see something that can be done more efficiently or better in general, please let me know! :) + +# \~SwarselSystems\~ + +<p align="center"> + <img src="https://i.imgur.com/bmgLNcu.png" width="49%" title="Tiling"> + <img src="https://i.imgur.com/0G7Be6e.png" width="49%" title="Waybar"> +</p> + +## Overview + +- [Literate configuration](https://swarsel.github.io/.dotfiles/) defining my entire infrastructure, including Emacs +- Configuration based on flakes for personal hosts as well as servers on: + - [NixOS](https://github.com/NixOS/nixpkgs) + - [home-manager](https://github.com/nix-community/home-manager) only (no full NixOS) with support from [nixGL](https://github.com/nix-community/nixGL) + - [nix-darwin](https://github.com/LnL7/nix-darwin) + - [nix-on-droid](https://github.com/nix-community/nix-on-droid) +- Streamlined configuration and deployment pipeline: + - Framework for [packages](https://github.com/Swarsel/.dotfiles/blob/main/pkgs/default.nix), [overlays](https://github.com/Swarsel/.dotfiles/blob/main/overlays/default.nix), [modules](https://github.com/Swarsel/.dotfiles/tree/main/modules), and [library functions](https://github.com/Swarsel/.dotfiles/tree/main/lib/default.nix) + - Dynamically generated host configurations + - Limited local installer (no secrets handling) with a supported demo build + - Fully autonomous remote deployment using [nixos-anywhere](https://github.com/nix-community/nixos-anywhere) and [disko](https://github.com/nix-community/disko) (with secrets handling) + - Improved nix tooling +- Support for advanced features: + - Secrets handling using [sops-nix](https://github.com/Mic92/sops-nix) (pls no pwn β€οΈ) + - Management of personally identifiable information using [nix-plugins](https://github.com/shlevy/nix-plugins) + - Full Yubikey support + - LUKS-encryption + - Secure boot using [Lanzaboote](https://github.com/nix-community/lanzaboote) + - BTRFS-based [Impermanence](https://github.com/nix-community/impermanence) + - Configuration shared between configurations (configuration for one nixosConfiguration can be defined in another nixosConfiguration) + - Global attributes shared between all configurations to reduce attribute redeclaration + +## Documentation + +If you are mainly interested in how I configured this system, check out this page: + +[SwarselSystems literate configuration](https://swarsel.github.io/.dotfiles/) + +This file will take you through my design process, in varying amounts of detail. + +Otherwise, the files that are possibly of biggest interest are found here: + +- [SwarselSystems.org](../SwarselSystems.org) +- [flake.nix](../flake.nix) +- [early-init.el](../programs/emacs/early-init.el) +- [init.el](../programs/emacs/init.el) + + +### Getting started + +#### Demo configuration + +<details> + <summary>Click here for instructions on how to install the demo system</summary> + +If you just want to see if this configuration is for you, run this command on any system that has `nix` installed: + +``` shell +nix run --experimental-features 'nix-command flakes' github:Swarsel/.dotfiles#swarsel-rebuild -- -u <YOUR_USERNAME> +``` + +This will activate the `chaostheatre` configuration on your system, which is a de-facto mirror of my main configuration with secret-based settings removed. +Please keep in mind that this limited installer will make local changes to the cloned repository in order to be able to install it (otherwise the builder would fail at fetching my private secrets repository). As such, this should only be used to evaluate the system - if you want to use it longterm, you will need to create a fork and make some changes. +</details> + +### Deployment + +<details> + <summary>Click here for deployment instructions</summary> + +The deployment process for this configuration is mostly automated, there are only a few steps that are needed to be done manually. You can choose between a remote deployment strategy that is also able to deploy new age keys for sops for you and a local installer that will only install the system without any secret handling. + +#### Remote deployment (recommended if you have at least one running system) + +0) Fork this repo, and write your own host config at `hosts/nixos/<YOUR_CONFIG_NAME>/default.nix` (you can use one of the other configurations as a template. Also see https://github.com/Swarsel/.dotfiles/tree/main/modules for a list of all additional options). At the very least, you should replace the `secrets/` directory with your own secrets and replace the SSH public keys with your own ones (otherwise I will come visit you!πβ€οΈ). I personally recommend to use the literate configuration and `org-babel-tangle-file` in Emacs, but you can also simply edit the separate `.nix` files. +1) Have a system with `nix` available booted (this does not need to be installed, i.e. you can use a NixOS installer image; a custom minimal installer ISO can be built by running `just iso` in the root of this repo) +2) Make sure that your Yubikey is plugged in or that you have your SSH key available (and configured) +3) Run `swarsel-bootstrap -n <CONFIGURATION_NAME> -d <TARGET_IP>` on your existing system. + - Alternatively (if you run this on a system that is not yet running this configuration), you can also run `nix run --experimental-features 'nix-command flakes' github:Swarsel/.dotfiles -- -n <CONFIGURATION_NAME> -d <TARGET_IP>` (this runs the same program as the command above). +4) Follow the installers instructions: + - you will have to choose a disk encryption password (if you want that feature) + - you will have to confirm once that the target system has rebooted + - you will have to enter the root password once during the final system install +5) That should be it! The installer will take care of setting up disks, secrets, and the rest of the hardware configuration! You will still have to sign in manually to some webservices etc. + +#### Local deployment (recommended for setting up the first system) + +1) Boot the latest install ISO from this repository on an UEFI system. +2) Run `swarsel-install -n <CONFIGURATION_NAME>` +3) Reboot + +Alternatively, to install this from any NixOS live ISO, run `nix run --experimental-features 'nix-command flakes' github:Swarsel/.dotfiles#install -- -n <CONFIGURATION_NAME>` at step 2. +</details> + +## Infrastructure + +<details> + <summary>Click here for a summary of my infrastructure</summary> + +### Programs + +| Topic | Program | +|---------------|---------------------------------| +|π **Shell** | [zsh](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/zsh.nix) | +|πͺ **DM** | [greetd](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/common/login.nix) | +|πͺ **WM** | [SwayFX](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/sway.nix) | +|β©οΈ **Bar** | [Waybar](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/waybar.nix) | +|βοΈ **Editor** | [Emacs](https://github.com/Swarsel/.dotfiles/tree/main/programs/emacs/init.el) | +|π₯οΈ **Terminal**| [Kitty](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/kitty.nix) | +|π **Launcher**| [Fuzzel](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/fuzzel.nix) | +|π¨ **Alerts** | [Mako](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/mako.nix) | +|π **Browser** | [Firefox](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/zsh.nix) | +|π¨ **Theme** | [City-Lights (managed by stylix)](https://github.com/Swarsel/.dotfiles/tree/main/modules/home/common/sharedsetup.nix)| + +### Services + +| Topic | Program | +|-----------------------|---------------------------------| +|π **Books** | [Kavita](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/kavita.nix) | +|πΌ **Videos** | [Jellyfin](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/jellyfin.nix) | +|π΅ **Music** | [Navidrome](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/navidrome.nix) + [Spotifyd](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/spotifyd.nix) + [MPD](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/mpd.nix) | +|π¨οΈ **Messaging** | [Matrix](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/matrix.nix) | +|π **Filesharing** | [Nectcloud](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/nextcloud.nix) | +|π· **Photos** | [Immich](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/immich.nix) | +|π **Documents** | [Paperless](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/paperless.nix) | +|π **File Sync** | [Syncthing](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/syncthing.nix) | +|πΎ **Backups** | [Restic](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/restic.nix) | +|ποΈ **Monitoring** | [Grafana](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/monitoring.nix) | +|π΄ **RSS** | [FreshRss](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/freshrss.nix) | +|π³ **Git** | [Forgejo](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/forgejo.nix) | +|β **Anki Sync** | [Anki Sync Server](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/ankisync.nix) | +|πͺͺ **SSO** | [Kanidm](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/kanidm.nix) + [oauth2-proxy](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/oauth2-proxy.nix) | +|πΈ **Finance** | [Firefly-III](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/firefly-iii.nix) | +|π **Collections** | [Koillection](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/koillection.nix) | +|ποΈ **Shell History** | [Atuin](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/atuin.nix) | +|π **CalDav/CardDav** | [Radicale](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/radicale.nix) | +|βοΈ **P2P Filesharing** | [Croc](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/croc.nix) | +|βοΈ **Paste Tool** | [Microbin](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/microbin.nix) | +|π **Link Shortener** | [Shlink](https://github.com/Swarsel/.dotfiles/tree/main/modules/nixos/server/shlink.nix) | + +### Hosts + +| Name | Hardware | Use | +|--------------------|-----------------------------------------------------|------------------------------------------------------| +|π» **nbl-imba-2** | Framework Laptop 16, AMD 7940HS, RX 7700S, 64GB RAM | Work laptop | +|π» **nbm-imba-166** | MacBook Pro 2016 | MacOS Sandbox | +|π₯οΈ **winters** | ASRock J4105-ITX, 32GB RAM | Main homeserver and data storgae | +|π₯οΈ **sync** | Oracle Cloud: VM.Standard.E2.1.Micro | Server for lightweight synchronization tasks | +|π₯οΈ **moonside** | Oracle Cloud: VM.Standard.A1.Flex, 4 OCPUs, 24GB RAM| Proxy for local services, some lightweight services | +|π± **magicant** | Samsung Galaxy Z Flip 6 | Phone | +|πΏ **drugstore** | - | ISO installer configuration | +|β **chaotheatre** | - | Demo config for checking out my configurtion | +|β **toto** | - | Helper configuration for bootstrapping a new system | +|π **home** | - | Reference configuration for a home-manager only host | +</details> + +## General Nix tips & useful links + +<details> + <summary>Click here for a summary of nix tips & links</summary> + +- Below is a small list of tips that should be helpful if you are new to the nix ecosystem: + + - Temporarily install any package using `nix shell nixpkgs#<PACKAGE_NAME>` - this can be e.g. useful if you accidentally removed home-manager from your packages on a non-NixOS machine. Alternatively, use [comma](https://github.com/nix-community/comma) + - More info on `nix [...]` commands: https://nixos.org/manual/nix/stable/command-ref/new-cli/nix + - When you are trying to setup a new configuration part, [GitHub code search](https://github.com/search?q=language%3ANix&type=code) can really help you to find a working configuration. Just filter for `.nix` files and the options you are trying to set up. + - getting packages at a different version than your target (or not packaged at all) can be done in most cases easily with fetchFromGithub (https://ryantm.github.io/nixpkgs/builders/fetchers/) + - you can easily install old revisions of packages using https://lazamar.co.uk/nix-versions/. You can conveniently spawn a shell with a chosen package available using `vershell <NIXPKGS_REVISION> <PACKAGE>`. Just make sure to pick a revision that has flakes enabled, otherwise you will need the legacy way of spawning the shell (see the link for more info) + +- These links are your best friends: + - The nix documentation: https://nix.dev/ + - The nixpkgs reference manual: https://nixos.org/manual/nixpkgs/unstable/#buildpythonapplication-function + - the [nixpkgs repository](https://github.com/NixOS/nixpkgs) - especially useful to look at the various READMEs that are in various places in the repository (find using GitHub code search) as well as the [issues](https://github.com/Swarsel/.dotfiles/issues) and [PRs](https://github.com/Swarsel/.dotfiles/pulls) pages + - and the [nixpkgs Pull Request Tracker](https://nixpk.gs/pr-tracker.html) + - The NixOS manual: https://nixos.org/manual/nixos/stable/ + - The NixOS package search: https://search.nixos.org/packages + - and the nix package version search: https://lazamar.co.uk/nix-versions/ + - The NixOS option search https://search.nixos.org/options + - [mipmip](https://github.com/mipmip)'s home-manager option search: https://mipmip.github.io/home-manager-option-search/ + - [Alan Pearce](https://alanpearce.eu/)'s nix-darwin search: https://searchix.alanpearce.eu/options/darwin/search (which supports all of the other versions as well :o) + - For the above, you can use the CLI tool [manix](https://github.com/mlvzk/manix) + - Nix function search: https://noogle.dev/ + - Search for nix-community options: https://search.nΓΌschtos.de/ +- But that is not all: + - Some nix resources + - A tour of Nix: https://nixcloud.io/tour/ + - The Nix One Pager: https://github.com/tazjin/nix-1p + - another one page introduction: https://learnxinyminutes.com/nix/ + - a very short introduction to Nix features: https://zaynetro.com/explainix + - introductory nix article: https://medium.com/@MrJamesFisher/nix-by-example-a0063a1a4c55 + - and another one: https://web.archive.org/web/20210121042658/https://ebzzry.io/en/nix/#nix + - How to learn nix: https://ianthehenry.com/posts/how-to-learn-nix/ + - the Nix Cookbook: https://github.com/functionalops/nix-cookbook?tab=readme-ov-file + - and the Nix Pills: https://nixos.org/guides/nix-pills/ + - Some resources on flakes + - Why to use flakes and introduction to flakes: https://www.tweag.io/blog/2020-05-25-flakes/ + - The [NixOS & Flakes Book](https://nixos-and-flakes.thiscute.world/) + - and [Wombat's book](https://mhwombat.codeberg.page/nix-book/) + - or the [Zero to Nix series](https://zero-to-nix.com/) + - Practical nix flakes article: https://serokell.io/blog/practical-nix-flakes + - A bit on Overlays: + - Overview on overlays: [Mastering Nixpkgs overlays article](https://nixcademy.com/posts/mastering-nixpkgs-overlays-techniques-and-best-practice/) + - Some examples on best practises: [Do's and Don'ts of overlays](https://flyingcircus.io/news/detailsansicht/nixos-the-dos-and-donts-of-nixpkgs-overlays) + - Blog article about overrides: https://bobvanderlinden.me/customizing-packages-in-nix/#using-modified-packages + - Also useful is the [official NixOS Wiki](https://wiki.nixos.org/wiki/NixOS_Wiki) + - there is also the [unofficial NixOS Wiki](https://nixos.wiki/) that tends to be a bit outdated, use with care +- Some resources for specific nix tools: + - Flake output reference: https://nixos-and-flakes.thiscute.world/other-usage-of-flakes/outputs + - You can find public repositories with modules at https://nur.nix-community.org/ (you should check what you are installing however): + - I like to use this for rycee's firefox extensions: https://nur.nix-community.org/repos/rycee/ + - List of nerdfonts: https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/data/fonts/nerd-fonts/manifests/fonts.json + - Stylix configuration options: https://danth.github.io/stylix/ + - nix-on-droid options: https://nix-community.github.io/nix-on-droid/nix-on-droid-options.html#sec-options +- Very useful tools that are mostly not directly used in configuration but instead called on need: + - Convert non-NixOS machines to NixOS using [nixos-infect](https://github.com/elitak/nixos-infect) + - Create various installation media with [nixos-generators](https://github.com/nix-community/nixos-generators) + - Remotely deploy NixOS using [nixos-anywhere](https://github.com/nix-community/nixos-anywhere) +- And a few links that are not directly nix-related, but may still serve you well: + - List of pre-commit-hooks: https://devenv.sh/reference/options/#pre-commithooks + - Waybar configuration: https://github.com/Alexays/Waybar/wiki +</details> + +## Attributions, Acknowledgements, Inspirations, etc. + +These are in random order (also known as 'the order in which I discovered them'). I would like to express my gratitude to: + +- All the great people who have contributed code for the nix-community, with special mentions for (this list is unfairly incomplete): +<details> + <summary>Click here to expand...</summary> + + - [guibou](https://github.com/guibou/) + - [rycee](https://github.com/rycee) + - [adisbladis](https://github.com/adisbladis) + - [Mic92](https://github.com/Mic92/sops-nix) + - [lassulus](https://github.com/lassulus) + - [danth](https://github.com/danth/) + - [LnL7](https://github.com/LnL7) + - [t184256](https://github.com/t184256) + - [bennofs](https://github.com/bennofs) + - [Pandapip1](https://github.com/Pandapip1) + - [zowoq](https://github.com/zowoq) + - [numtide](https://github.com/numtide) + - [hsjobeki](https://github.com/hsjobeki) + - [blitz](https://github.com/blitz) + - [RaitoBezarius](https://github.com/RaitoBezarius) + - [nikstur](https://github.com/nikstur) + - [talyz](https://github.com/talyz) + - [infinisil](https://github.com/infinisil) + - [zhaofengli](https://github.com/zhaofengli) + - [Artturin](https://github.com/Artturin) + - [oddlama](https://github.com/oddlama) +</details> + +- All the people who have inspired me with their configurations (sadly also highly incomplete): +<details> + <summary>Click here to expand...</summary> + + - [theSuess](https://github.com/theSuess) with their [home-manager](https://code.kulupu.party/thesuess/home-manager) + - [hlissner](https://github.com/hlissner) with their [dotfiles](https://github.com/hlissner/dotfiles) + - [drduh](https://github.com/drduh/YubiKey-Guide) with their [YubiKey-Guide](https://github.com/drduh/YubiKey-Guide) + - [AntonHakansson](https://github.com/AntonHakansson) with their [nixos-config](https://github.com/AntonHakansson/nixos-config?tab=readme-ov-file) + - [Guekka](https://github.com/Guekka/) with their [blog](https://guekka.github.io/) + - [NotAShelf](https://github.com/NotAShelf) with their [nyx](https://github.com/NotAShelf/nyx) + - [Misterio77](https://github.com/Misterio77) with their [nix-config](https://github.com/Misterio77/nix-config) + - [0xdade](https://github.com/0xdade) with their [blog](https://0xda.de/blog/) + - [EmergentMind](https://github.com/EmergentMind) with their [nix-config](https://github.com/EmergentMind/nix-config) + - [librephoenix](https://github.com/librephoenix) with their [nixos-config](https://github.com/librephoenix/nixos-config) + - [Xe](https://github.com/Xe) with their [blog](https://xeiaso.net/blog/) + - [oddlama](https://github.com/oddlama) with their absolutely incredible [nix-config](https:/github.com/oddlama/nix-config) +</details> + +If you feel that I forgot to pay you tribute for code that I used in this repository, please shoot me a message and I will fix it :) + +