SwarselSystems: NixOS + Emacs Configuration
Table of Contents
- 1. Introduction (no code)
- 2. flake.nix
- 3. System
- 3.1. System specific configuration
- 3.2. Additions and modifications
- 3.2.1. Packages
- 3.2.1.1. pass-fuzzel
- 3.2.1.2. cura5
- 3.2.1.3. hm-specialisation
- 3.2.1.4. cdw
- 3.2.1.5. cdb
- 3.2.1.6. bak
- 3.2.1.7. timer
- 3.2.1.8. e
- 3.2.1.9. command-not-found
- 3.2.1.10. swarselcheck
- 3.2.1.11. swarselzellij
- 3.2.1.12. waybarupdate
- 3.2.1.13. opacitytoggle
- 3.2.1.14. fs-diff
- 3.2.1.15. update-checker
- 3.2.1.16. github-notifications
- 3.2.1.17. screenshare
- 3.2.1.18. swarsel-bootstrap
- 3.2.1.19. swarsel-rebuild
- 3.2.1.20. swarsel-install
- 3.2.1.21. swarsel-postinstall
- 3.2.1.22. t2ts
- 3.2.1.23. ts2t
- 3.2.1.24. vershell
- 3.2.1.25. eontimer
- 3.2.1.26. project
- 3.2.1.27. fhs
- 3.2.1.28. swarsel-displaypower
- 3.2.1.29. swarsel-mgba
- 3.2.2. Overlays (additions, overrides, nixpkgs-stable)
- 3.2.3. Modules
- 3.2.4. Library functions
- 3.2.1. Packages
- 3.3. NixOS
- 3.3.1. Common
- 3.3.1.1. Imports, non-server settings
- 3.3.1.2. General NixOS settings (stateVersion)
- 3.3.1.3. System Packages
- 3.3.1.4. Setup home-manager
- 3.3.1.5. Setup login keymap
- 3.3.1.6. User setup, Make users non-mutable
- 3.3.1.7. Environment setup
- 3.3.1.8. Security
- 3.3.1.9. Enable automatic garbage collection
- 3.3.1.10. Enable automatic store optimisation
- 3.3.1.11. Reduce systemd timeouts
- 3.3.1.12. Hardware settings
- 3.3.1.13. Pulseaudio
- 3.3.1.14. Pipewire
- 3.3.1.15. Common network settings
- 3.3.1.16. Time, locale settings
- 3.3.1.17. sops
- 3.3.1.18. Theme (stylix)
- 3.3.1.19. Programs (including zsh setup)
- 3.3.1.20. Services
- 3.3.1.21. Hardware compatibility settings (Yubikey, Ledger, Keyboards) - udev rules
- 3.3.1.22. System Login
- 3.3.1.23. nix-ld
- 3.3.1.24. Impermanence
- 3.3.1.25. Summary of nixos-rebuild diff
- 3.3.1.26. gnome-keyring
- 3.3.1.27. Sway
- 3.3.1.28. xdg-portal
- 3.3.1.29. Podmam (distrobox)
- 3.3.1.30. Handle lid switch correctly
- 3.3.1.31. Low battery notification
- 3.3.1.32. Lanzaboote
- 3.3.2. Server
- 3.3.2.1. Imports
- 3.3.2.2. General NixOS Server settings
- 3.3.2.3. System Packages
- 3.3.2.4. sops
- 3.3.2.5. nfs/samba (smb)
- 3.3.2.6. NGINX
- 3.3.2.7. ssh
- 3.3.2.8. kavita
- 3.3.2.9. jellyfin
- 3.3.2.10. navidrome
- 3.3.2.11. spotifyd
- 3.3.2.12. mpd
- 3.3.2.13. pipewire
- 3.3.2.14. matrix
- 3.3.2.15. nextcloud
- 3.3.2.16. immich
- 3.3.2.17. paperless
- 3.3.2.18. transmission
- 3.3.2.19. syncthing
- 3.3.2.20. restic
- 3.3.2.21. monitoring
- 3.3.2.22. Jenkins
- 3.3.2.23. Emacs elfeed (RSS Server)
- 3.3.2.24. FreshRSS
- 3.3.2.25. forgejo (git server)
- 3.3.2.26. Anki Sync Server
- 3.3.3. Darwin
- 3.3.4. Optional
- 3.3.1. Common
- 3.4. Home-manager
- 3.4.1. Common
- 3.4.1.1. Imports
- 3.4.1.2. General home-manager-settings
- 3.4.1.3. Installed packages
- 3.4.1.4. sops
- 3.4.1.5. SSH Machines
- 3.4.1.6. Theme (stylix)
- 3.4.1.7. Desktop Entries, MIME types (xdg)
- 3.4.1.8. Linking dotfiles (Symlinks home.file)
- 3.4.1.9. Sourcing environment variables
- 3.4.1.10. General Programs: bottom, imv, sioyek, bat, carapace, wlogout, swayr, yt-dlp, mpv, jq, nix-index, ripgrep, pandoc, fzf
- 3.4.1.11. nix-index
- 3.4.1.12. password-store
- 3.4.1.13. direnv
- 3.4.1.14. eza
- 3.4.1.15. git
- 3.4.1.16. Fuzzel
- 3.4.1.17. Starship
- 3.4.1.18. Kitty
- 3.4.1.19. zsh
- 3.4.1.20. zellij
- 3.4.1.21. tmux
- 3.4.1.22. Mail
- 3.4.1.23. Home-manager: Emacs
- 3.4.1.24. Waybar
- 3.4.1.25. Firefox
- 3.4.1.26. Services
- 3.4.1.27. Sway
- 3.4.1.28. gpg-agent
- 3.4.1.29. gammastep
- 3.4.2. Server
- 3.4.3. Darwin
- 3.4.4. Optional
- 3.4.1. Common
- 4. Emacs
- 4.1. Initialization (early-init.el)
- 4.2. Personal settings
- 4.2.1. Custom functions
- 4.2.1.1. Emacs/Evil state toggle
- 4.2.1.2. Switching to last used buffer
- 4.2.1.3. mu4e functions
- 4.2.1.4. Create non-existant directories when finding file
- 4.2.1.5. [crux] Duplicate Lines
- 4.2.1.6. [prot] org-id-headings
- 4.2.1.7. Inhibit Messages in Echo Area
- 4.2.1.8. Move up one directory for find-file
- 4.2.1.9. org-mode: General setup
- 4.2.1.10. org-mode: Visual-fill column
- 4.2.1.11. org-mode: Upon-save actions (Auto-tangle, export to html, formatting)
- 4.2.1.12. org-mode: Fold current heading
- 4.2.1.13. corfu: Do not interrupt navigation
- 4.2.1.14. Disable garbace collection while minibuffer is active
- 4.2.2. Custom Keybindings
- 4.2.3. Directory setup / File structure
- 4.2.4. Unclutter .emacs.d
- 4.2.5. Move backup files to another location
- 4.2.1. Custom functions
- 4.3. General init.el setup + UI
- 4.3.1. General setup
- 4.3.2. Mark all themes as safe
- 4.3.3. Show less compilation warnings
- 4.3.4. Better garbage collection
- 4.3.5. Indentation
- 4.3.6. Scrolling
- 4.3.7. Evil
- 4.3.8. ispell
- 4.3.9. Font Configuration
- 4.3.10. Theme
- 4.3.11. Icons
- 4.3.12. Variable Pitch Mode
- 4.3.13. Modeline
- 4.3.14. mini-modeline
- 4.3.15. Helper Modes
- 4.3.16. Ligatures
- 4.3.17. Popup (popper) + Shackle Buffers
- 4.3.18. Indicate first and last line of buffer
- 4.3.19. Authentication
- 4.4. Modules
- 4.4.1. Org Mode
- 4.4.2. Nix Mode
- 4.4.3. HCL Mode
- 4.4.4. Jenkinsfile/Groovy
- 4.4.5. Ansible
- 4.4.6. Dockerfile
- 4.4.7. Terraform Mode
- 4.4.8. nixpkgs-fmt
- 4.4.9. shfmt
- 4.4.10. Markdown Mode
- 4.4.11. elfeed
- 4.4.12. Ripgrep
- 4.4.13. Tree-sitter
- 4.4.14. direnv (envrc)
- 4.4.15. avy
- 4.4.16. devdocs
- 4.4.17. Projectile
- 4.4.18. Magit
- 4.4.19. Yubikey support
- 4.4.20. Forge
- 4.4.21. git-timemachine
- 4.4.22. Delimiters (brackets): rainbow-delimiters, highlight-parentheses
- 4.4.23. rainbow-mode
- 4.4.24. Corfu
- 4.4.25. cape
- 4.4.26. rust
- 4.4.27. Tramp
- 4.4.28. diff-hl
- 4.4.29. Commenting
- 4.4.30. eglot
- 4.4.31. lsp-mode & company
- 4.4.32. lsp-bridge
- 4.4.33. sideline-flymake
- 4.4.34. Prevent breaking of hardlinks
- 4.4.35. Dirvish
- 4.4.36. undo-tree
- 4.4.37. Hydra
- 4.4.38. Email
- 4.4.39. Calendar
- 4.4.40. Dashboard: emacs startup screen
- 4.4.41. vterm
- 4.4.42. multiple cursors
- 4.4.43. Less logging
- 5. Appendix A: Noweb-Ref blocks
- 6. Appendix B: Supplementary Files
This file has 57742 words spanning 14774 lines and was last revised on 2025-02-26 01:02:54 +0100.
In order to have working links and macros when viewing this file online, you might want to switch to the html version.
1. Introduction (no code)
This literate configuration file holds the entirety of all configuration files for both NixOS as well as home-manager across all machines that I currently use. It also holds an extensive Emacs configuration.
I used to have two separate files (Emacs.org
and Nixos.org
) because the NixOS setting for installing Emacs packages used to break if it found UTF-8 characters in .el
files but not in .org
files. Hence I used to pass Emacs.org
to that function rather than init.el
. This seems to be fixed now however and I was finally able to consolidate both files into one.
This configuration is part of a NixOS system that is (nearly) fully declarative and can be found here:
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.
This file is structured as follows:
- Introduction (no code) This is the block you are currently in. It holds no code that actually builds the system, it just outlines the general approach and explains my rough mentality
- Noweb-Ref blocks This section hold code that can be templated at other parts of the configuration. This is mostly used for the NixOS side of the configuration where I define my host systems that usually have a lot in common.
- flake.nix
This block holds everything related to the heart of the nix side of the configuration - the
flake.nix
file. - System This section holds all configuration options that apply to NixOS or home-manager. In other words, here we are doing system and user level configuration.
Emacs This section defines my Emacs configuration. For a while, I considered to use rycee's
emacs-init
module (https://github.com/nix-community/nur-combined/blob/master/repos/rycee/hm-modules/emacs-init.nix) to manage my Emacs configuration; I have since come to the conclusion that this would be a bad idea: at the moment, even though it might seem as I am very bound to the configuration file that you are currently reading, if I ever decide to change how I run my system, I can simply take the generated.nix
and.el
files and put them wherever I need them. This file only simplifies that generation without putting further restrictions on my. If I were however to switch toemacs-init
then I would be indeed to some level confined to the nix ecosystem with my Emacs configuration, as I would no longer have a valid.org
file to manage it with, instead generating aninit.el
directly from nix code. I like to keep that level of freedom for potential future use. Also, you will notice there is no package system setup in this configuration. This is because packages are automatically handled on the NixOS side by parsing the generatedinit.el
file for package installs.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-02-26 01:02:54 +0100)
system-configuration-options
--prefix=/nix/store/n5jvxqgs8pv4zfs8qvabcnns87ckccmk-emacs-pgtk-20250223.0 --disable-build-details --with-modules --with-pgtk --with-compress-install --with-toolkit-scroll-bars --with-native-compilation --without-imagemagick --with-mailutils --without-small-ja-dic --with-tree-sitter --without-xinput2 --without-xwidgets --with-dbus --with-selinux
This file is not loaded by Emacs directly as the configuration (even though this would be possible) - instead, it generates two more files:
early-init.el
This file handle startup optimization and sets up the basic frame that I will be working in.init.el
This file handles the rest of the Emacs configuration.
By using the configuration offered by this file, the file you are reading right now (SwarselSystems.org
) will not be freshly tangled on every file save, as this slows down emacs over time. However, when you clone this configuration yourself and have not yet activated it, you need to tangle the file yourself. This can be done using the general keybind C-c C-v t
or my personal chord C-SPC o t
. Alternatively, execute the following block:
(org-babel-tangle)
The .html
version of this page can be generated by calling the chord C-SPC o e
, or by executing the below block
(org-html-export-to-html)
The web version is useful because it allows navigation using org-mode links, which makes the configuration easier to follow (I hope!). Lastly, I add this javascript bit to the file in order to have a darkmode toggle when exporting to html:
(concat "<script src=\"https://cdn.jsdelivr.net/npm/darkmode-js@1.5.7/lib/darkmode-js.min.js\"></script>\n" "<script>\n" "function addDarkmodeWidget() {\n" "new Darkmode().showWidget();\n" "}\n" "window.addEventListener('load', addDarkmodeWidget);\n" "</script>")
The rest of this file will now contain actual code that is used in the configuration.
2. flake.nix
Handling the flake.nix file used to be a bit of a chore, since it felt like writing so much boilerplate code just to define new systems. The noweb-approach here makes this a little bit less painful.
These blocks are later inserted here: flake.nix template. Adding new flake inputs is very easy, you just add them to Inputs & Inputs@Outputs first by name in the first source-block, and then the path in the second source-block. Any variables to be set for the host configuration are done in let, and the specific setup is done in either nixosConfigurations (for NixOS systems), homeConfigurations (for home-manager systems), or nixOnDroidConfigurations (for Nix on Android) and darwinConfigurations (for Darwin systems, also known as Macs). There also used to be a [BROKEN LINK: h:6a08495a-8566-4bb5-9fac-b03df01f6c81] section that used to define a Proxmox LXC image when I was still using Proxmox as my main server. An example of the repository at that time would be acc0ad6: Add several NixOS hosts on Proxmox and Oracle Cloud
.
2.1. flake.nix skeleton
This sections puts together the flake.nix
file from the Noweb-Ref blocks section. This tangles the flake.nix file; This block only needs to be touched when updating the general structure of the flake. For everything else, see the respective noweb-ref block.
In general, a nix flake consists of one or more inputs and several outputs. The inputs are used to define where nix should be looking for packages, options, and more. The outputs generate expressions that can be used in .nix files as well as system configurations using these files.
In the start, I enable some public cache repositories. This saves some time during rebuilds because it avoids building as many packages from scratch - this is mainly important for community flakes like emacs-overlay
, which basically would trigger a rebuild whenever updating the flake. The repository does of course not hold everything, but it lightens the pain.
In outputs = inputs@ [...]
, the inputs@
makes it so that all inputs are automatically passed to the outputs and can be called as inputs.<name>
, whereas explicit arguments may just be called by using <name>
. For most flakes this is fully sufficient, as they do not need to be called often and it saves me maintainance effort with this file.
{ description = "SwarseFlake - Nix Flake for all SwarselSystems"; nixConfig = { extra-substituters = [ "https://nix-community.cachix.org" "https://cache.ngi0.nixos.org/" ]; extra-trusted-public-keys = [ "nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=" "cache.ngi0.nixos.org-1:KqH5CBLNSyX184S9BKZJo1LxrxJ9ltnY2uAs5c/f1MA=" ]; }; inputs = { nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; nixpkgs-stable.url = "github:NixOS/nixpkgs/nixos-24.11"; systems.url = "github:nix-systems/default-linux"; home-manager = { url = "github:nix-community/home-manager"; inputs.nixpkgs.follows = "nixpkgs"; }; emacs-overlay = { url = "github:nix-community/emacs-overlay"; inputs.nixpkgs.follows = "nixpkgs"; }; nur.url = "github:nix-community/NUR"; nixgl.url = "github:guibou/nixGL"; stylix.url = "github:danth/stylix"; sops-nix.url = "github:Mic92/sops-nix"; lanzaboote.url = "github:nix-community/lanzaboote"; nix-on-droid = { url = "github:nix-community/nix-on-droid/release-24.05"; inputs.nixpkgs.follows = "nixpkgs"; }; nixos-generators = { url = "github:nix-community/nixos-generators"; inputs.nixpkgs.follows = "nixpkgs"; }; nixos-hardware = { url = "github:NixOS/nixos-hardware/master"; }; nix-alien = { url = "github:thiagokokada/nix-alien"; }; nswitch-rcm-nix = { url = "github:Swarsel/nswitch-rcm-nix"; }; nix-index-database = { url = "github:nix-community/nix-index-database"; inputs.nixpkgs.follows = "nixpkgs"; }; disko = { url = "github:nix-community/disko"; inputs.nixpkgs.follows = "nixpkgs"; }; impermanence.url = "github:nix-community/impermanence"; zjstatus = { url = "github:dj95/zjstatus"; }; fw-fanctrl = { url = "github:TamtamHero/fw-fanctrl/packaging/nix"; inputs.nixpkgs.follows = "nixpkgs"; }; nix-darwin = { url = "github:lnl7/nix-darwin"; inputs.nixpkgs.follows = "nixpkgs"; }; pre-commit-hooks = { url = "github:cachix/git-hooks.nix"; inputs.nixpkgs.follows = "nixpkgs"; }; nix-secrets = { url = "git+ssh://git@github.com/Swarsel/nix-secrets.git?ref=main&shallow=1"; flake = false; inputs = { }; }; nix-topology.url = "github:oddlama/nix-topology"; }; outputs = inputs@{ self , nixpkgs , home-manager , systems , ... }: let inherit (self) outputs; lib = (nixpkgs.lib // home-manager.lib).extend (_: _: { swarselsystems = import ./lib { inherit self lib inputs outputs systems; }; }); in { inherit lib; nixosModules = import ./modules/nixos { inherit lib; }; homeModules = import ./modules/home { inherit lib; }; packages = lib.swarselsystems.forEachSystem (pkgs: import ./pkgs { inherit lib pkgs; }); formatter = lib.swarselsystems.forEachSystem (pkgs: pkgs.nixpkgs-fmt); overlays = import ./overlays { inherit self lib inputs; }; apps = lib.swarselsystems.forAllSystems (system: let appNames = [ "swarsel-bootstrap" "swarsel-install" "swarsel-rebuild" "swarsel-postinstall" ]; appSet = lib.swarselsystems.mkApps system appNames self; in { inherit appSet; default = appSet.bootstrap; }); devShells = lib.swarselsystems.forAllSystems (system: let pkgs = lib.swarselsystems.pkgsFor.${system}; checks = self.checks.${system}; in { default = pkgs.mkShell { NIX_CONFIG = "experimental-features = nix-command flakes"; inherit (checks.pre-commit-check) shellHook; buildInputs = checks.pre-commit-check.enabledPackages; nativeBuildInputs = [ pkgs.nix pkgs.home-manager pkgs.git pkgs.just pkgs.age pkgs.ssh-to-age pkgs.sops pkgs.statix pkgs.deadnix pkgs.nixpkgs-fmt ]; }; } ); templates = import ./templates { inherit lib; }; checks = lib.swarselsystems.forAllSystems (system: let pkgs = lib.swarselsystems.pkgsFor.${system}; in import ./checks { inherit self inputs system pkgs; } ); nixosConfigurations = lib.swarselsystems.mkFullHostConfigs (lib.swarselsystems.readHosts "nixos") "nixos"; homeConfigurations = # "swarsel@home-manager" = inputs.home-manager.lib.homeManagerConfiguration { # pkgs = lib.swarselsystems.pkgsFor.x86_64-linux; # extraSpecialArgs = { inherit inputs outputs; }; # modules = homeModules ++ mixedModules ++ [ # ./hosts/home-manager # ]; # }; lib.swarselsystems.mkHalfHostConfigs (lib.swarselsystems.readHosts "home") "home" lib.swarselsystems.pkgsFor.x86_64-linux; darwinConfigurations = lib.swarselsystems.mkFullHostConfigs (lib.swarselsystems.readHosts "darwin") "darwin"; nixOnDroidConfigurations = # magicant = inputs.nix-on-droid.lib.nixOnDroidConfiguration { # pkgs = lib.swarselsystems.pkgsFor.aarch64-linux; # modules = [ # ./hosts/magicant # ]; # }; lib.swarselsystems.mkHalfHostConfigs (lib.swarselsystems.readHosts "android") "android" lib.swarselsystems.pkgsFor.aarch64-linux; topology = lib.swarselsystems.forEachSystem (pkgs: import inputs.nix-topology { inherit pkgs; modules = [ # Your own file to define global topology. Works in principle like a nixos module but uses different options. # ./topology.nix { inherit (self) nixosConfigurations; } ]; }); }; }
2.2. Inputs
Here we define inputs and outputs of the flake. First, the following list is for the outputs of the flake.
Format: <name>,
Mind the comma at the end. You need this because the ...
is being passed as the last argument in the template at flake.nix template.
Here, just add the input names, urls and other options that are needed, like nixpkgs.follows
. By using the latter option, you tell the package to not provide it's own package repository, but instead 'nest' itself into another, which is very useful.
A short overview over each input and what it does:
- nixpkgs This is the base repository that I am following for all packages. I follow the unstable branch.
- home-manager
This handles user-level configuration and mostly provides dotfiles that are generated and symlinked to
~/.config/
. - NUR The nix user repository contains user provided modules, packages and expressions. These are not audited by the nix community, so be aware of supply chain vulnerabilities when using those. I am only really using rycee's firefox addons from there which saves me a lot of hassle, and it seems to be a safe resource.
- nixGL This solves the problem that nix has with "OpenGL", as libraries are not linked and programs will often fail to find drivers. But I do not fully understand what it does. All I know is that I usually have to use this on non-NIxoS systems.
- stylix As described before, this handles all theme related options.
- sops-nix This provides declarative secrets management for NixOS and home manager using sops and age keys. It is a bit more cumbersome to use on home manager systems - which is a bother because I then have to resort to that configuration to keep everything supported - but it is super practical and really the primary reason why it makes sense for me to go for NixOS, as I do not have to do any extra secrets provisioning.
- Lanzaboote Provides secure boot for NixOS. Needed for my Surface Pro 3.
- nix-on-droid This brings nix to android in an app that is similar to tmux! Of course most of the configuration does not apply to this, but it is still neat to have!
- nixos-hardware Provides specific hardware setting for some hardware configurations. For example, this sets some better defaults for my Lenovo Thinkpad P14s Gen2.
- nix-alien
This is supposed to allow me to run unpatched libraries directly without a need for ELF patching or resorting to
steam-run
. However, I have not yet gotten this to work. - nixos-generators Provides me with images that I can use to create LXCs on Proxmox.
- nswitch-rcm-nix Allows auto injection of payloads upon connecting a Nintendo Switch.
- nix-index-database
This provides a database for
nix-index
that is updated weekly. This allows for declarative management, without needing to run thenix-index
command for database assembly. - disko disko provides declarative disk partitioning, which I use for impermanence as well as nixos-anywhere.
- Impermanence Some of my machines are using a btrfs filesystem that wipes the root directory on each reboot. This forces me to pay more attention in keeping my system declarative as well as helping me keeping the system uncluttered. However, it is a chore to make sure that important files are not deleted. This flake helps with this problem, allowing me to select files and directories for persisting.
- zjstatus This provides utilities for customizing a statusbar in zellij. Currently unused as I prefer tmux for now and might be removed in the future.
- fw-fanctrl This provides access to the internal fans of Frameworks laptops. This is a bit more nice to use than directly using ectool.
- nix-darwin After learning that MacOS systems can also be configured using nix, I managed to get access to an old MacBook for testing. This allows to set most general settings that can otherwise be set using the Mac GUI.
- pre-commit-hooks Provides access to several checks that can be hooked to be run before several stages in the process.
- nix-secrets
This is a private repository that I use for settings in modules that do not expose a
secretsFile
(or similar) option. An example is theLastFM.ApiKey
option in navidrome:LastFM.ApiKey = builtins.readFile "${secretsDirectory}/navidrome/lastfm-secret";
When setting this option normally, the password would normally be written world-readable not only in the nix store, but also in the configuration. Hence, I put such passwords into a private repository. This allows me to keep purity of the flake while keeping a level of security on these secrets.
- nix-topology This automatically creates a topology diagram of my configuration.
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; nixpkgs-stable.url = "github:NixOS/nixpkgs/nixos-24.11"; systems.url = "github:nix-systems/default-linux"; home-manager = { url = "github:nix-community/home-manager"; inputs.nixpkgs.follows = "nixpkgs"; }; emacs-overlay = { url = "github:nix-community/emacs-overlay"; inputs.nixpkgs.follows = "nixpkgs"; }; nur.url = "github:nix-community/NUR"; nixgl.url = "github:guibou/nixGL"; stylix.url = "github:danth/stylix"; sops-nix.url = "github:Mic92/sops-nix"; lanzaboote.url = "github:nix-community/lanzaboote"; nix-on-droid = { url = "github:nix-community/nix-on-droid/release-24.05"; inputs.nixpkgs.follows = "nixpkgs"; }; nixos-generators = { url = "github:nix-community/nixos-generators"; inputs.nixpkgs.follows = "nixpkgs"; }; nixos-hardware = { url = "github:NixOS/nixos-hardware/master"; }; nix-alien = { url = "github:thiagokokada/nix-alien"; }; nswitch-rcm-nix = { url = "github:Swarsel/nswitch-rcm-nix"; }; nix-index-database = { url = "github:nix-community/nix-index-database"; inputs.nixpkgs.follows = "nixpkgs"; }; disko = { url = "github:nix-community/disko"; inputs.nixpkgs.follows = "nixpkgs"; }; impermanence.url = "github:nix-community/impermanence"; zjstatus = { url = "github:dj95/zjstatus"; }; fw-fanctrl = { url = "github:TamtamHero/fw-fanctrl/packaging/nix"; inputs.nixpkgs.follows = "nixpkgs"; }; nix-darwin = { url = "github:lnl7/nix-darwin"; inputs.nixpkgs.follows = "nixpkgs"; }; pre-commit-hooks = { url = "github:cachix/git-hooks.nix"; inputs.nixpkgs.follows = "nixpkgs"; }; nix-secrets = { url = "git+ssh://git@github.com/Swarsel/nix-secrets.git?ref=main&shallow=1"; flake = false; inputs = { }; }; nix-topology.url = "github:oddlama/nix-topology";
2.3. let
Here I define a few variables that I need for my system specifications. There used to be more here, but I managed to optimize my configuration, and only two things remain:
outputs
, which is needed forlib
lib
: This exposes a commonlib
for NixOS and home-manager that is extended by my own personallib
functions.
inherit (self) outputs; lib = (nixpkgs.lib // home-manager.lib).extend (_: _: { swarselsystems = import ./lib { inherit self lib inputs outputs systems; }; });
2.4. General (outputs)
In this section I am creating some attributes that define general concepts of my configuration:
nixosModules
imports self-defined options that I only want to use on NixOS systems. All modules are held as separately as possible, to allow for easier sharing with other people mostly.homeModules
imports modules that are to be used on NixOS and non-NixOS systems. These are mostly used to define outputs (monitors), keyboards and special commands for machines.packages
holds packages that I am building myself. These are mostly shell scripts, but also a few others such as AppImages and firefox addons.devShells
provides a development shell that can be used as a bootstrap for new installs usingnix develop
while inside the flake directory. It received an overhaul in0a6cf0e feat: add checks to devShell
, since when it is handled usingforAllSystems
and now including pre-commit-hook checks.formatter
provides the formatter that is to be used on.nix
files. It can be called by usingnix fmt
.check
provides the pre-commit-hook checks that I have explained in Pre-commit-hooks (Checks).overlays
imports a few community overlays (such as the emacs-overlay) and also three overlays of my own:additions
holds derivations that I am adding myself to nixpkgs - i.e. this is where the packages defined in/pkgs
get added to nixpkgs.modifications
holds derivations that I have performed overrides on. The list of interesting attribute overrides can be found by looking at the source code of a derivation and looking at the start of the file for lines of the form<name> ? <val>
. But this can also be used to, for example, fetch a different version of a package instead.nixpkgs-stable
holds the newest version of stable nixpkgs. I only use this on packages that seem broken on unstable, which are not many.zjstatus
holds some options forzellij
, but I have stopped using it since I prefertmux
.
They are defined in Overlays (additions, overrides, nixpkgs-stable). The way this is handled was simplified in
647a2ae feat: simplify overlay structure
; however, the old structure might be easier to understand as a reference.
inherit lib; nixosModules = import ./modules/nixos { inherit lib; }; homeModules = import ./modules/home { inherit lib; }; packages = lib.swarselsystems.forEachSystem (pkgs: import ./pkgs { inherit lib pkgs; }); formatter = lib.swarselsystems.forEachSystem (pkgs: pkgs.nixpkgs-fmt); overlays = import ./overlays { inherit self lib inputs; }; apps = lib.swarselsystems.forAllSystems (system: let appNames = [ "swarsel-bootstrap" "swarsel-install" "swarsel-rebuild" "swarsel-postinstall" ]; appSet = lib.swarselsystems.mkApps system appNames self; in { inherit appSet; default = appSet.bootstrap; }); devShells = lib.swarselsystems.forAllSystems (system: let pkgs = lib.swarselsystems.pkgsFor.${system}; checks = self.checks.${system}; in { default = pkgs.mkShell { NIX_CONFIG = "experimental-features = nix-command flakes"; inherit (checks.pre-commit-check) shellHook; buildInputs = checks.pre-commit-check.enabledPackages; nativeBuildInputs = [ pkgs.nix pkgs.home-manager pkgs.git pkgs.just pkgs.age pkgs.ssh-to-age pkgs.sops pkgs.statix pkgs.deadnix pkgs.nixpkgs-fmt ]; }; } ); templates = import ./templates { inherit lib; }; checks = lib.swarselsystems.forAllSystems (system: let pkgs = lib.swarselsystems.pkgsFor.${system}; in import ./checks { inherit self inputs system pkgs; } );
2.5. Pre-commit-hooks (Checks)
This file defines a number of checks that can either be run by calling nix flake check
or while in a nix-shell
or nix develop
. This helps me make sure that my flake confirms to my self-imposed standards. The GitHub actions perform less checks than are being done here (they are only checking the formatting, as well as statix
and deadnix
)
{ self, inputs, pkgs, system, ... }: { pre-commit-check = inputs.pre-commit-hooks.lib.${system}.run { src = "${self}"; hooks = { check-added-large-files.enable = true; check-case-conflicts.enable = true; check-executables-have-shebangs.enable = true; check-shebang-scripts-are-executable.enable = false; check-merge-conflicts.enable = true; deadnix.enable = true; detect-private-keys.enable = true; end-of-file-fixer.enable = true; fix-byte-order-marker.enable = true; flake-checker.enable = true; forbid-new-submodules.enable = true; mixed-line-endings.enable = true; nixpkgs-fmt.enable = true; statix.enable = true; trim-trailing-whitespace.enable = true; destroyed-symlinks = { enable = true; entry = "${inputs.pre-commit-hooks.checks.${system}.pre-commit-hooks}/bin/destroyed-symlinks"; }; shellcheck = { enable = true; entry = "${pkgs.shellcheck}/bin/shellcheck --shell=bash"; }; shfmt = { enable = true; entry = "${pkgs.shfmt}/bin/shfmt -i 4 -sr -d -s -l"; }; }; }; }
2.6. Templates
This file defines the templates that are being exposed by the flake. These can be used by running nix flake init -t github:Swarsel/.dotfiles#<TEMPLATE_NAME>
.
{ lib, ... }: let templateNames = [ "python" "rust" "go" "cpp" "latex" "default" ]; in lib.swarselsystems.mkTemplates templateNames
2.7. nixosConfigurations
This section used to be much longer, since I performed all of my imports right here in the past. Since then, I have however refactored and now my important hosts can be defined in little space. Once I have fully transitioned my server to NixOS too this section will become even smaller once more.
Note: The preceding nixosConfigurations
is found in flake.nix template. Also, the method of generating the hosts was changed in commit
3a272b1 feat!: dynamically create hosts
, and the deprecated system definitions removed in 7457109 main chore: remove deprecated static host config
. See those commits for a state with a simpler config.
lib.swarselsystems.mkFullHostConfigs (lib.swarselsystems.readHosts "nixos") "nixos";
2.8. darwinConfigurations
And this defines darwin systems (MacOS), which I only have one of, that serves as a template mostly.
Note: The preceding darwinConfigurations
is found in flake.nix template. Also, the method of generating the hosts was changed in commit
3a272b1 feat!: dynamically create hosts
, and the deprecated system definitions removed in 7457109 main chore: remove deprecated static host config
. See those commits for a state with a simpler config.
lib.swarselsystems.mkFullHostConfigs (lib.swarselsystems.readHosts "darwin") "darwin";
2.9. homeConfigurations
In contrast, this defines home-manager systems, which I only have one of, that serves as a template mostly.
# "swarsel@home-manager" = inputs.home-manager.lib.homeManagerConfiguration { # pkgs = lib.swarselsystems.pkgsFor.x86_64-linux; # extraSpecialArgs = { inherit inputs outputs; }; # modules = homeModules ++ mixedModules ++ [ # ./hosts/home-manager # ]; # }; lib.swarselsystems.mkHalfHostConfigs (lib.swarselsystems.readHosts "home") "home" lib.swarselsystems.pkgsFor.x86_64-linux;
2.10. nixOnDroidConfigurations
Nix on Android also demands an own flake output, which is provided here.
# magicant = inputs.nix-on-droid.lib.nixOnDroidConfiguration { # pkgs = lib.swarselsystems.pkgsFor.aarch64-linux; # modules = [ # ./hosts/magicant # ]; # }; lib.swarselsystems.mkHalfHostConfigs (lib.swarselsystems.readHosts "android") "android" lib.swarselsystems.pkgsFor.aarch64-linux;
2.11. topologyConfigurations
lib.swarselsystems.forEachSystem (pkgs: import inputs.nix-topology { inherit pkgs; modules = [ # Your own file to define global topology. Works in principle like a nixos module but uses different options. # ./topology.nix { inherit (self) nixosConfigurations; } ]; });
3. System
This holds most of the NixOS side of configuration.
3.1. System specific configuration
This section mainly exists house different `default.nix` files to define some modules that should be loaded on respective systems.
Every host is housed in the hosts/
directory, which is then subdivided by each respective system (nixos/
, home-manager/
, nix-on-droid/
, darwin/
). As described earlier, some of these configurations (nixos and darwin) can be defined automatically in this flake. For home-manager and nix-on-droid, the system architecture must be defined manually.
3.1.1. Template
This is the template that I use for new deployments of personal machines. Servers are usually highly tailored to their specific task and I do not consider it worth a time to craft a template for that. Also, at least at the current time, I only provide a template for NixOS hosts, as I rarely ever use anything else.
3.1.1.1. Main Configuration
{ self, inputs, pkgs, lib, ... }: let profilesPath = "${self}/profiles"; sharedOptions = { isBtrfs = true; }; in { imports = [ # ---- nixos-hardware here ---- ./hardware-configuration.nix ./disk-config.nix "${profilesPath}/nixos/optional/virtualbox.nix" # "${profilesPath}/nixos/optional/vmware.nix" "${profilesPath}/nixos/optional/autologin.nix" "${profilesPath}/nixos/optional/nswitch-rcm.nix" "${profilesPath}/nixos/optional/gaming.nix" inputs.home-manager.nixosModules.home-manager { home-manager.users.swarsel.imports = [ "${profilesPath}/home/optional/gaming.nix" ]; } ]; boot = { kernelPackages = lib.mkDefault pkgs.linuxPackages_latest; }; networking = { hostName = "TEMPLATE"; firewall.enable = true; }; swarselsystems = lib.recursiveUpdate { wallpaper = self + /wallpaper/lenovowp.png; hasBluetooth = true; hasFingerprint = true; isImpermanence = true; isSecureBoot = true; isCrypted = true; isSwap = true; swapSize = "32G"; rootDisk = "TEMPLATE"; } sharedOptions; home-manager.users.swarsel.swarselsystems = lib.recursiveUpdate { isLaptop = true; isNixos = true; flakePath = "/home/swarsel/.dotfiles"; cpuCount = 16; startup = [ { command = "nextcloud --background"; } { command = "vesktop --start-minimized --enable-speech-dispatcher --ozone-platform-hint=auto --enable-features=WaylandWindowDecorations --enable-wayland-ime"; } { command = "element-desktop --hidden --enable-features=UseOzonePlatform --ozone-platform=wayland --disable-gpu-driver-bug-workarounds"; } { command = "ANKI_WAYLAND=1 anki"; } { command = "OBSIDIAN_USE_WAYLAND=1 obsidian"; } { command = "nm-applet"; } { command = "feishin"; } ]; } sharedOptions; }
3.1.1.2. disko
Acceptance of arbitraty argumments is here needed because disko
passes diskoFile
to this file.
{ lib, pkgs, config, rootDisk, ... }: let type = "btrfs"; extraArgs = [ "-L" "nixos" "-f" ]; # force overwrite subvolumes = { "/root" = { mountpoint = "/"; mountOptions = [ "subvol=root" "compress=zstd" "noatime" ]; }; "/home" = lib.mkIf config.swarselsystems.isImpermanence { mountpoint = "/home"; mountOptions = [ "subvol=home" "compress=zstd" "noatime" ]; }; "/persist" = lib.mkIf config.swarselsystems.isImpermanence { mountpoint = "/persist"; mountOptions = [ "subvol=persist" "compress=zstd" "noatime" ]; }; "/log" = lib.mkIf config.swarselsystems.isImpermanence { mountpoint = "/var/log"; mountOptions = [ "subvol=log" "compress=zstd" "noatime" ]; }; "/nix" = { mountpoint = "/nix"; mountOptions = [ "subvol=nix" "compress=zstd" "noatime" ]; }; "/swap" = lib.mkIf config.swarselsystems.isSwap { mountpoint = "/.swapvol"; swap.swapfile.size = config.swarselsystems.swapSize; }; }; in { disko.devices = { disk = { disk0 = { type = "disk"; device = config.swarselsystems.rootDisk; content = { type = "gpt"; partitions = { ESP = { priority = 1; name = "ESP"; size = "512M"; type = "EF00"; content = { type = "filesystem"; format = "vfat"; mountpoint = "/boot"; mountOptions = [ "defaults" ]; }; }; root = lib.mkIf (!config.swarselsystems.isCrypted) { size = "100%"; content = { inherit type subvolumes extraArgs; postCreateHook = lib.mkIf config.swarselsystems.isImpermanence '' MNTPOINT=$(mktemp -d) mount "/dev/disk/by-label/nixos" "$MNTPOINT" -o subvolid=5 trap 'umount $MNTPOINT; rm -rf $MNTPOINT' EXIT btrfs subvolume snapshot -r $MNTPOINT/root $MNTPOINT/root-blank ''; }; }; luks = lib.mkIf config.swarselsystems.isCrypted { size = "100%"; content = { type = "luks"; name = "cryptroot"; passwordFile = "/tmp/disko-password"; # this is populated by bootstrap.sh settings = { allowDiscards = true; # https://github.com/hmajid2301/dotfiles/blob/a0b511c79b11d9b4afe2a5e2b7eedb2af23e288f/systems/x86_64-linux/framework/disks.nix#L36 crypttabExtraOpts = [ "fido2-device=auto" "token-timeout=10" ]; }; content = { inherit type subvolumes extraArgs; postCreateHook = lib.mkIf config.swarselsystems.isImpermanence '' MNTPOINT=$(mktemp -d) mount "/dev/mapper/cryptroot" "$MNTPOINT" -o subvolid=5 trap 'umount $MNTPOINT; rm -rf $MNTPOINT' EXIT btrfs subvolume snapshot -r $MNTPOINT/root $MNTPOINT/root-blank ''; }; }; }; }; }; }; }; }; fileSystems."/persist".neededForBoot = lib.mkIf config.swarselsystems.isImpermanence true; fileSystems."/home".neededForBoot = lib.mkIf config.swarselsystems.isImpermanence true; environment.systemPackages = [ pkgs.yubikey-manager ]; }
3.1.2. Physical hosts
This is a list of all physical machines that I maintain.
3.1.2.1. nbl-imba-2 (Framework Laptop 16)
My work machine. Built for more security, this is the gold standard of my configurations at the moment.
3.1.2.1.1. Main Configuration
{ self, inputs, pkgs, lib, ... }: let profilesPath = "${self}/profiles"; sharedOptions = { isBtrfs = true; isLinux = true; }; in { imports = [ inputs.nixos-hardware.nixosModules.framework-16-7040-amd inputs.fw-fanctrl.nixosModules.default ./disk-config.nix ./hardware-configuration.nix "${profilesPath}/nixos/optional/virtualbox.nix" # "${profilesPath}/nixos/optional/vmware.nix" "${profilesPath}/nixos/optional/autologin.nix" "${profilesPath}/nixos/optional/nswitch-rcm.nix" "${profilesPath}/nixos/optional/gaming.nix" "${profilesPath}/nixos/optional/work.nix" inputs.home-manager.nixosModules.home-manager { home-manager.users.swarsel.imports = [ "${profilesPath}/home/optional/gaming.nix" "${profilesPath}/home/optional/work.nix" ]; } ]; networking.networkmanager.wifi.scanRandMacAddress = false; boot = { supportedFilesystems = [ "btrfs" ]; kernelPackages = lib.mkDefault pkgs.linuxPackages_latest; kernelParams = [ "resume_offset=533760" ]; resumeDevice = "/dev/disk/by-label/nixos"; }; hardware = { amdgpu = { opencl.enable = true; amdvlk = { enable = true; support32Bit.enable = true; }; }; }; programs.fw-fanctrl.enable = true; networking = { hostName = "nbl-imba-2"; fqdn = "nbl-imba-2.imp.univie.ac.at"; firewall.enable = true; }; services = { fwupd.enable = true; udev.extraRules = '' ACTION=="add", SUBSYSTEM=="usb", ATTR{idVendor}=="0bda", ATTR{idProduct}=="8156", ATTR{power/autosuspend}="20" ''; }; swarselsystems = lib.recursiveUpdate { wallpaper = self + /wallpaper/lenovowp.png; hasBluetooth = true; hasFingerprint = true; isImpermanence = false; isSecureBoot = true; isCrypted = true; } sharedOptions; home-manager.users.swarsel.swarselsystems = lib.recursiveUpdate { isLaptop = true; isNixos = true; flakePath = "/home/swarsel/.dotfiles"; cpuCount = 16; # temperatureHwmon = { # isAbsolutePath = true; # path = "/sys/devices/platform/thinkpad_hwmon/hwmon/"; # input-filename = "temp1_input"; # }; # ------ ----- # | DP-4 | |eDP-1| # ------ ----- startup = [ { command = "nextcloud --background"; } { command = "vesktop --start-minimized --enable-speech-dispatcher --ozone-platform-hint=auto --enable-features=WaylandWindowDecorations --enable-wayland-ime"; } { command = "element-desktop --hidden --enable-features=UseOzonePlatform --ozone-platform=wayland --disable-gpu-driver-bug-workarounds"; } { command = "ANKI_WAYLAND=1 anki"; } { command = "OBSIDIAN_USE_WAYLAND=1 obsidian"; } { command = "nm-applet"; } { command = "teams-for-linux"; } { command = "1password"; } { command = "feishin"; } ]; sharescreen = "eDP-2"; lowResolution = "1280x800"; highResolution = "2560x1600"; monitors = { main = { name = "BOE 0x0BC9 Unknown"; mode = "2560x1600"; # TEMPLATE scale = "1"; position = "2560,0"; workspace = "15:L"; output = "eDP-2"; }; homedesktop = { name = "Philips Consumer Electronics Company PHL BDM3270 AU11806002320"; mode = "2560x1440"; scale = "1"; position = "0,0"; workspace = "1:一"; output = "DP-11"; }; work_back_middle = { name = "LG Electronics LG Ultra HD 0x000305A6"; mode = "2560x1440"; scale = "1"; position = "5120,0"; workspace = "1:一"; output = "DP-10"; }; work_front_left = { name = "LG Electronics LG Ultra HD 0x0007AB45"; mode = "3840x2160"; scale = "1"; position = "5120,0"; workspace = "1:一"; output = "DP-7"; }; work_back_right = { name = "HP Inc. HP Z32 CN41212T55"; mode = "3840x2160"; scale = "1"; position = "5120,0"; workspace = "1:一"; output = "DP-3"; }; work_middle_middle_main = { name = "HP Inc. HP 732pk CNC4080YL5"; mode = "3840x2160"; scale = "1"; position = "-1280,0"; workspace = "11:M"; output = "DP-8"; }; work_middle_middle_side = { name = "Hewlett Packard HP Z24i CN44250RDT"; mode = "1920x1200"; transform = "270"; scale = "1"; position = "-2480,0"; workspace = "12:S"; output = "DP-9"; }; work_seminary = { name = "Applied Creative Technology Transmitter QUATTRO201811"; mode = "1280x720"; scale = "1"; position = "10000,10000"; # i.e. this screen is inaccessible by moving the mouse workspace = "12:S"; output = "DP-4"; }; }; inputs = { "12972:18:Framework_Laptop_16_Keyboard_Module_-_ANSI_Keyboard" = { xkb_layout = "us"; xkb_variant = "altgr-intl"; }; "1133:45081:MX_Master_2S_Keyboard" = { xkb_layout = "us"; xkb_variant = "altgr-intl"; }; "2362:628:PIXA3854:00_093A:0274_Touchpad" = { dwt = "enabled"; tap = "enabled"; natural_scroll = "enabled"; middle_emulation = "enabled"; drag_lock = "disabled"; }; "1133:50504:Logitech_USB_Receiver" = { xkb_layout = "us"; xkb_variant = "altgr-intl"; }; "1133:45944:MX_KEYS_S" = { xkb_layout = "us"; xkb_variant = "altgr-intl"; }; }; keybindings = { "Mod4+Ctrl+Shift+p" = "exec screenshare"; }; shellAliases = { ans2-15_3-9 = ". ~/.venvs/ansible39_2_15_0/bin/activate"; ans3-9 = ". ~/.venvs/ansible39/bin/activate"; ans = ". ~/.venvs/ansible/bin/activate"; ans2-15 = ". ~/.venvs/ansible2.15.0/bin/activate"; }; } sharedOptions; }
3.1.2.1.2. hardware-configuration
{ config, lib, modulesPath, ... }: { imports = [ (modulesPath + "/installer/scan/not-detected.nix") ]; boot.initrd.availableKernelModules = [ "nvme" "xhci_pci" "thunderbolt" "usb_storage" "cryptd" "usbhid" "sd_mod" "r8152" ]; boot.initrd.kernelModules = [ ]; boot.kernelModules = [ "kvm-amd" ]; # Fix screen flickering issue at the cost of battery life (disable PSR and PSR-SU, keep PR enabled) # TODO: figure out if this is worth it # test PSR/PR state with 'sudo grep '' /sys/kernel/debug/dri/0000*/eDP-2/*_capability' # ref: # https://old.reddit.com/r/framework/comments/1goh7hc/anyone_else_get_this_screen_flickering_issue/ # https://www.reddit.com/r/NixOS/comments/1hjruq1/graphics_corruption_on_kernel_6125_and_up/ # https://gitlab.freedesktop.org/drm/amd/-/issues/3797 boot.kernelParams = [ "amdgpu.dcdebugmask=0x410" ]; boot.extraModulePackages = [ ]; boot.initrd.luks.devices."cryptroot" = { # improve performance on ssds bypassWorkqueues = true; preLVM = true; }; # Enables DHCP on each ethernet and wireless interface. In case of scripted networking # (the default) this is the recommended approach. When using systemd-networkd it's # still possible to use this option, but it's recommended to use it in conjunction # with explicit per-interface declarations with `networking.interfaces.<interface>.useDHCP`. networking.useDHCP = lib.mkDefault true; # networking.interfaces.enp196s0f3u1c2.useDHCP = lib.mkDefault true; # networking.interfaces.wlp4s0.useDHCP = lib.mkDefault true; nixpkgs.hostPlatform = lib.mkDefault "x86_64-linux"; hardware.cpu.amd.updateMicrocode = lib.mkDefault config.hardware.enableRedistributableFirmware; }
3.1.2.1.3. disko
{ disko.devices = { disk = { nvme0n1 = { type = "disk"; device = "/dev/nvme0n1"; content = { type = "gpt"; partitions = { ESP = { label = "boot"; name = "ESP"; size = "512M"; type = "EF00"; content = { type = "filesystem"; format = "vfat"; mountpoint = "/boot"; mountOptions = [ "defaults" ]; }; }; luks = { size = "100%"; label = "luks"; content = { type = "luks"; name = "cryptroot"; extraOpenArgs = [ "--allow-discards" "--perf-no_read_workqueue" "--perf-no_write_workqueue" ]; # https://0pointer.net/blog/unlocking-luks2-volumes-with-tpm2-fido2-pkcs11-security-hardware-on-systemd-248.html settings = { crypttabExtraOpts = [ "fido2-device=auto" "token-timeout=10" ]; }; content = { type = "btrfs"; extraArgs = [ "-L" "nixos" "-f" ]; subvolumes = { "/root" = { mountpoint = "/"; mountOptions = [ "subvol=root" "compress=zstd" "noatime" ]; }; "/home" = { mountpoint = "/home"; mountOptions = [ "subvol=home" "compress=zstd" "noatime" ]; }; "/nix" = { mountpoint = "/nix"; mountOptions = [ "subvol=nix" "compress=zstd" "noatime" ]; }; "/persist" = { mountpoint = "/persist"; mountOptions = [ "subvol=persist" "compress=zstd" "noatime" ]; }; "/log" = { mountpoint = "/var/log"; mountOptions = [ "subvol=log" "compress=zstd" "noatime" ]; }; "/swap" = { mountpoint = "/swap"; swap.swapfile.size = "64G"; }; }; }; }; }; }; }; }; }; }; fileSystems."/persist".neededForBoot = true; fileSystems."/var/log".neededForBoot = true; }
3.1.2.2. Winters (Server)
This is my main server that I run at home. It handles most tasks that require bigger amounts of storage than I can receive for free at OCI. Also it houses some data that I find too sensitive to hand over to Oracle.
3.1.2.2.1. Main Configuration
{ self, inputs, ... }: let profilesPath = "${self}/profiles"; in { imports = [ ./hardware-configuration.nix "${profilesPath}/nixos/optional/autologin.nix" "${profilesPath}/nixos/server" inputs.home-manager.nixosModules.home-manager { home-manager.users.swarsel.imports = [ "${profilesPath}/home/server" ]; } ]; boot = { loader.systemd-boot.enable = true; loader.efi.canTouchEfiVariables = true; }; networking = { hostName = "winters"; hostId = "b7778a4a"; firewall.enable = true; enableIPv6 = false; firewall.allowedTCPPorts = [ 80 443 ]; }; swarselsystems = { hasBluetooth = false; hasFingerprint = false; isImpermanence = false; isBtrfs = false; isLinux = true; flakePath = "/home/swarsel/.dotfiles"; server = { enable = true; kavita = true; navidrome = true; jellyfin = true; spotifyd = true; mpd = false; matrix = true; nextcloud = true; immich = true; paperless = true; transmission = true; syncthing = true; monitoring = true; freshrss = true; }; }; }
3.1.2.2.2. hardware-configuration
{ config, lib, modulesPath, ... }: { imports = [ (modulesPath + "/installer/scan/not-detected.nix") ]; boot.initrd.availableKernelModules = [ "ahci" "xhci_pci" "usbhid" "usb_storage" "sd_mod" ]; boot.initrd.kernelModules = [ ]; boot.kernelModules = [ "kvm-intel" ]; boot.extraModulePackages = [ ]; boot.supportedFilesystems = [ "zfs" ]; boot.zfs.extraPools = [ "Vault" ]; fileSystems."/" = { device = "/dev/disk/by-uuid/30e2f96a-b01d-4c27-9ebb-d5d7e9f0031f"; fsType = "ext4"; }; fileSystems."/boot" = { device = "/dev/disk/by-uuid/F0D8-8BD1"; fsType = "vfat"; }; swapDevices = [{ device = "/dev/disk/by-uuid/a8eb6f3b-69bf-4160-90aa-9247abc108e0"; }]; # Enables DHCP on each ethernet and wireless interface. In case of scripted networking # (the default) this is the recommended approach. When using systemd-networkd it's # still possible to use this option, but it's recommended to use it in conjunction # with explicit per-interface declarations with `networking.interfaces.<interface>.useDHCP`. networking.useDHCP = lib.mkDefault true; # networking.interfaces.enp3s0.useDHCP = lib.mkDefault true; nixpkgs.hostPlatform = lib.mkDefault "x86_64-linux"; hardware.cpu.intel.updateMicrocode = lib.mkDefault config.hardware.enableRedistributableFirmware; }
3.1.2.3. nbm-imba-166 (MacBook Pro)
A Mac notebook that I have received from work. I use this machine for getting accustomed to the Apple ecosystem as well as as a sandbox for nix-darwin configurations.
{ lib, ... }: { # Auto upgrade nix package and the daemon service. services.nix-daemon.enable = true; services.karabiner-elements.enable = true; home-manager.users."leon.schwarzaeugl".home = { username = lib.mkForce "leon.schwarzaeugl"; swarselsystems = { isDarwin = true; isLaptop = true; isNixos = false; isBtrfs = false; }; }; }
3.1.2.4. Magicant (Phone)
My phone. I use only a minimal config for remote debugging here.
{ pkgs, ... }: { environment = { packages = with pkgs; [ vim git openssh # toybox dig man gnupg curl deadnix statix nixpgks-fmt nvd ]; etcBackupExtension = ".bak"; extraOutputsToInstall = [ "doc" "info" "devdoc" ]; motd = null; }; android-integration = { termux-open.enable = true; xdg-open.enable = true; termux-open-url.enable = true; termux-reload-settings.enable = true; termux-setup-storage.enable = true; }; # Backup etc files instead of failing to activate generation if a file already exists in /etc # Read the changelog before changing this value system.stateVersion = "23.05"; # Set up nix for flakes nix.extraOptions = '' experimental-features = nix-command flakes ''; }
3.1.3. Virtual hosts
My server setup was originally built on Proxmox VE; back when I started, I created all kinds of wild Debian/Ubuntu/etc. KVMs and LXCs on there. However, the root disk has suffered a weird failure where it has become unable to be cloned, but it is still functional for now. I was for a long time rewriting all machines on there to use NixOS instead; this process is now finished.
I have removed most of the machines from this section. What remains are some hosts that I have deployed on OCI (mostly sync for medium-important data) and one other machine that I left for now as a reference.
3.1.3.1. Sync (OCI)
This machine mainly acts as an external sync helper. It manages the following things:
- Anki syncing
- Forgejo git server
- Elfeed sync server (RSS)
Syncthing backup of replaceable data
All of these are processes that use little cpu but can take a lot of storage. For this I use a free Ampere instance from OCI with 50G of space. In case my account gets terminated, all of this data is easily replaceable or backed up regularly anyways.
{ self, inputs, lib, ... }: let profilesPath = "${self}/profiles"; in { imports = [ "${profilesPath}/nixos/server" ./hardware-configuration.nix inputs.home-manager.nixosModules.home-manager { home-manager.users.swarsel.imports = [ "${profilesPath}/home/server" ]; } ]; sops = { defaultSopsFile = lib.mkForce "/root/.dotfiles/secrets/sync/secrets.yaml"; }; services.nginx = { virtualHosts = { "sync.swarsel.win" = { enableACME = true; forceSSL = true; acmeRoot = null; locations = { "/" = { proxyPass = "http://localhost:8384/"; extraConfig = '' client_max_body_size 0; ''; }; }; }; }; }; boot = { tmp.cleanOnBoot = true; loader.grub.device = "nodev"; }; zramSwap.enable = false; networking = { nftables.enable = lib.mkForce false; firewall.allowedTCPPorts = [ 8384 22000 ]; firewall.allowedUDPPorts = [ 21027 22000 ]; hostName = "sync"; enableIPv6 = false; domain = "subnet03112148.vcn03112148.oraclevcn.com"; firewall.extraCommands = '' iptables -I INPUT -m state --state NEW -p tcp --dport 80 -j ACCEPT iptables -I INPUT -m state --state NEW -p tcp --dport 443 -j ACCEPT iptables -I INPUT -m state --state NEW -p tcp --dport 27701 -j ACCEPT iptables -I INPUT -m state --state NEW -p tcp --dport 8384 -j ACCEPT iptables -I INPUT -m state --state NEW -p tcp --dport 3000 -j ACCEPT iptables -I INPUT -m state --state NEW -p tcp --dport 22000 -j ACCEPT iptables -I INPUT -m state --state NEW -p udp --dport 22000 -j ACCEPT iptables -I INPUT -m state --state NEW -p udp --dport 21027 -j ACCEPT iptables -I INPUT -m state --state NEW -p tcp --dport 9812 -j ACCEPT ''; }; # system.stateVersion = "23.11"; # TEMPLATE - but probably no need to change # do not manage OCI syncthing through nix config services.syncthing = { enable = true; guiAddress = "0.0.0.0:8384"; openDefaultPorts = true; }; swarselsystems = { hasBluetooth = false; hasFingerprint = false; isImpermanence = false; isLinux = true; isBtrfs = false; flakePath = "/root/.dotfiles"; server = { enable = true; forgejo = true; ankisync = true; }; }; }
3.1.4. Utility hosts
3.1.4.1. Toto (Physical/VM)
This is a slim setup for developing base configuration. I do not track the hardware-configuration for this host here because I often switch this configuration between running on a QEMU VM and a physical laptop and do not want to constantly adapt the config here to reflect the current state.
3.1.4.1.1. Main Configuration
{ self, inputs, outputs, pkgs, lib, ... }: let profilesPath = "${self}/profiles"; sharedOptions = { isBtrfs = true; isLinux = true; }; in { imports = [ "${self}/hosts/nixos/toto/disk-config.nix" ./hardware-configuration.nix "${profilesPath}/nixos/optional/autologin.nix" "${profilesPath}/nixos/common/settings.nix" "${profilesPath}/nixos/common/home-manager.nix" "${profilesPath}/nixos/common/xserver.nix" "${profilesPath}/nixos/common/users.nix" "${profilesPath}/nixos/common/impermanence.nix" "${profilesPath}/nixos/common/lanzaboote.nix" "${profilesPath}/nixos/common/sops.nix" "${profilesPath}/nixos/server/ssh.nix" inputs.home-manager.nixosModules.home-manager { home-manager.users.swarsel.imports = [ inputs.sops-nix.homeManagerModules.sops "${profilesPath}/home/common/settings.nix" "${profilesPath}/home/common/sops.nix" "${profilesPath}/home/common/ssh.nix" ] ++ (builtins.attrValues outputs.homeModules); } ] ++ (builtins.attrValues outputs.nixosModules) ++ (builtins.attrValues outputs.homeModules); environment.systemPackages = with pkgs; [ curl git gnupg rsync ssh-to-age sops vim just sbctl ]; system.stateVersion = lib.mkForce "23.05"; boot = { supportedFilesystems = [ "btrfs" ]; kernelPackages = lib.mkDefault pkgs.linuxPackages_latest; }; networking = { hostName = "toto"; firewall.enable = false; }; swarselsystems = lib.recursiveUpdate { wallpaper = self + /wallpaper/lenovowp.png; isImpermanence = true; isCrypted = true; isSecureBoot = false; isSwap = true; swapSize = "8G"; # rootDisk = "/dev/nvme0n1"; rootDisk = "/dev/vda"; } sharedOptions; home-manager.users.swarsel.swarselsystems = lib.recursiveUpdate { isLaptop = false; isNixos = true; flakePath = "/home/swarsel/.dotfiles"; } sharedOptions; }
3.1.4.1.2. disko
# NOTE: ... is needed because dikso passes diskoFile { lib , pkgs , config , rootDisk , ... }: let type = "btrfs"; extraArgs = [ "-L" "nixos" "-f" ]; # force overwrite subvolumes = { "/root" = { mountpoint = "/"; mountOptions = [ "subvol=root" "compress=zstd" "noatime" ]; }; "/home" = lib.mkIf config.swarselsystems.isImpermanence { mountpoint = "/home"; mountOptions = [ "subvol=home" "compress=zstd" "noatime" ]; }; "/persist" = lib.mkIf config.swarselsystems.isImpermanence { mountpoint = "/persist"; mountOptions = [ "subvol=persist" "compress=zstd" "noatime" ]; }; "/log" = lib.mkIf config.swarselsystems.isImpermanence { mountpoint = "/var/log"; mountOptions = [ "subvol=log" "compress=zstd" "noatime" ]; }; "/nix" = { mountpoint = "/nix"; mountOptions = [ "subvol=nix" "compress=zstd" "noatime" ]; }; "/swap" = lib.mkIf config.swarselsystems.isSwap { mountpoint = "/.swapvol"; swap.swapfile.size = config.swarselsystems.swapSize; }; }; in { disko.devices = { disk = { disk0 = { type = "disk"; device = config.swarselsystems.rootDisk; content = { type = "gpt"; partitions = { ESP = { priority = 1; name = "ESP"; size = "512M"; type = "EF00"; content = { type = "filesystem"; format = "vfat"; mountpoint = "/boot"; mountOptions = [ "defaults" ]; }; }; root = lib.mkIf (!config.swarselsystems.isCrypted) { size = "100%"; content = { inherit type subvolumes extraArgs; postCreateHook = lib.mkIf config.swarselsystems.isImpermanence '' MNTPOINT=$(mktemp -d) mount "/dev/disk/by-label/nixos" "$MNTPOINT" -o subvolid=5 trap 'umount $MNTPOINT; rm -rf $MNTPOINT' EXIT btrfs subvolume snapshot -r $MNTPOINT/root $MNTPOINT/root-blank ''; }; }; luks = lib.mkIf config.swarselsystems.isCrypted { size = "100%"; content = { type = "luks"; name = "cryptroot"; passwordFile = "/tmp/disko-password"; # this is populated by bootstrap.sh settings = { allowDiscards = true; # https://github.com/hmajid2301/dotfiles/blob/a0b511c79b11d9b4afe2a5e2b7eedb2af23e288f/systems/x86_64-linux/framework/disks.nix#L36 crypttabExtraOpts = [ "fido2-device=auto" "token-timeout=10" ]; }; content = { inherit type subvolumes extraArgs; postCreateHook = lib.mkIf config.swarselsystems.isImpermanence '' MNTPOINT=$(mktemp -d) mount "/dev/mapper/cryptroot" "$MNTPOINT" -o subvolid=5 trap 'umount $MNTPOINT; rm -rf $MNTPOINT' EXIT btrfs subvolume snapshot -r $MNTPOINT/root $MNTPOINT/root-blank ''; }; }; }; }; }; }; }; }; fileSystems."/persist".neededForBoot = lib.mkIf config.swarselsystems.isImpermanence true; fileSystems."/home".neededForBoot = lib.mkIf config.swarselsystems.isImpermanence true; environment.systemPackages = [ pkgs.yubikey-manager ]; }
3.1.4.2. drugstore (ISO)
This is a live environment ISO that I use to bootstrap new systems. It only loads a minimal configuration and no graphical interface. After booting this image on a host, find out its IP and bootstrap the system using the bootstrap
utility.
For added convenience, the live environment displays a helpful text on login, we define it here (will be put into /etc/issue
):
[32m~SwarselSystems~[0m IP of primary interface: [31m\4[0m The Password for all users & root is '[31msetup[0m'. Install the system remotely by running '[33mbootstrap -n <CONFIGURATION_NAME> -d <IP_FROM_ABOVE> [0m' on a machine with deployed secrets. Alternatively, run '[33mswarsel-install -n <CONFIGURATION_NAME>[0m' for a local install. For your convenience, an example call is in the bash history (press up on the keyboard to access).
Also, an initial bash history is provided to allow for a very quick local deployment:
swarsel-install -n chaostheatre
{ self, pkgs, inputs, outputs, config, lib, modulesPath, ... }: let pubKeys = lib.filesystem.listFilesRecursive "${self}/secrets/keys/ssh"; in { imports = [ "${modulesPath}/installer/cd-dvd/installation-cd-minimal.nix" "${modulesPath}/installer/cd-dvd/channel.nix" "${self}/profiles/iso/minimal.nix" inputs.home-manager.nixosModules.home-manager { home-manager.users.swarsel.imports = [ "${self}/profiles/home/common/settings.nix" ] ++ (builtins.attrValues outputs.homeModules); } ]; home-manager.users.swarsel.home = { file = { ".bash_history" = { source = self + /programs/bash/.bash_history; }; }; }; home-manager.users.root.home = { stateVersion = "23.05"; file = { ".bash_history" = { source = self + /programs/bash/.bash_history; }; }; }; # environment.etc."issue".text = "\x1B[32m~SwarselSystems~\x1B[0m\nIP of primary interface: \x1B[31m\\4\x1B[0m\nThe Password for all users & root is '\x1B[31msetup\x1B[0m'.\nInstall the system remotely by running '\x1B[33mbootstrap -n <HOSTNAME> -d <IP_FROM_ABOVE> [--impermanence] [--encryption]\x1B[0m' on a machine with deployed secrets.\nAlternatively, run '\x1B[33mswarsel-install -d <DISK> -f <flake>\x1B[0m' for a local install.\n"; environment.etc."issue".source = "${self}/programs/etc/issue"; networking.dhcpcd.runHook = "${pkgs.utillinux}/bin/agetty --reload"; isoImage = { makeEfiBootable = true; makeUsbBootable = true; squashfsCompression = "zstd -Xcompression-level 3"; }; nixpkgs = { hostPlatform = lib.mkDefault "x86_64-linux"; config.allowUnfree = true; }; services.getty.autologinUser = lib.mkForce "swarsel"; users = { allowNoPasswordLogin = true; groups.swarsel = { }; users = { swarsel = { name = "swarsel"; group = "swarsel"; isNormalUser = true; password = "setup"; # this is overwritten after install openssh.authorizedKeys.keys = lib.lists.forEach pubKeys (key: builtins.readFile key); extraGroups = [ "wheel" ]; }; root = { # password = lib.mkForce config.users.users.swarsel.password; # this is overwritten after install openssh.authorizedKeys.keys = config.users.users.swarsel.openssh.authorizedKeys.keys; }; }; }; boot = { loader.systemd-boot.enable = lib.mkForce true; loader.efi.canTouchEfiVariables = true; }; programs.bash.shellAliases = { "swarsel-install" = "nix run github:Swarsel/.dotfiles#swarsel-install --"; }; system.activationScripts.cache = { text = '' mkdir -p -m=0777 /home/swarsel/.local/state/nix/profiles mkdir -p -m=0777 /home/swarsel/.local/state/home-manager/gcroots mkdir -p -m=0777 /home/swarsel/.local/share/nix/ printf '{\"extra-substituters\":{\"https://nix-community.cachix.org\":true,\"https://nix-community.cachix.org https://cache.ngi0.nixos.org/\":true},\"extra-trusted-public-keys\":{\"nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=\":true,\"nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs= cache.ngi0.nixos.org-1:KqH5CBLNSyX184S9BKZJo1LxrxJ9ltnY2uAs5c/f1MA=\":true}}' | tee /home/swarsel/.local/share/nix/trusted-settings.json > /dev/null mkdir -p /root/.local/share/nix/ printf '{\"extra-substituters\":{\"https://nix-community.cachix.org\":true,\"https://nix-community.cachix.org https://cache.ngi0.nixos.org/\":true},\"extra-trusted-public-keys\":{\"nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=\":true,\"nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs= cache.ngi0.nixos.org-1:KqH5CBLNSyX184S9BKZJo1LxrxJ9ltnY2uAs5c/f1MA=\":true}}' | tee /root/.local/share/nix/trusted-settings.json > /dev/null ''; }; systemd = { services.sshd.wantedBy = lib.mkForce [ "multi-user.target" ]; targets = { sleep.enable = false; suspend.enable = false; hibernate.enable = false; hybrid-sleep.enable = false; }; }; system.stateVersion = lib.mkForce "23.05"; networking = { hostName = "drugstore"; wireless.enable = false; }; }
3.1.4.3. Home-manager only (default non-NixOS)
This is the "reference implementation" of a setup that runs without NixOS, only relying on home-manager. I try to test this every now and then and keep it supported. However, manual steps are needed to get the system to work fully, depending on what distribution you are running on.
{ self, outputs, config, ... }: { imports = [ inputs.stylix.homeManagerModules.stylix inputs.sops-nix.homeManagerModules.sops inputs.nix-index-database.hmModules.nix-index ./profiles/home/common ] ++ (builtins.attrValues outputs.homeModules); nixpkgs = { overlays = [ outputs.overlays.default ]; config = { allowUnfree = true; }; }; services.xcape = { enable = true; mapExpression = { Control_L = "Escape"; }; }; programs.zsh.initExtra = " export GPG_TTY=\"$(tty)\" export SSH_AUTH_SOCK=$(gpgconf --list-dirs agent-ssh-socket) gpgconf --launch gpg-agent "; swarselsystems = { isLaptop = true; isNixos = false; wallpaper = self + /wallpaper/surfacewp.png; }; }
3.1.4.4. ChaosTheatre (Demo Physical/VM)
This is just a demo host. It applies all the configuration found in the common parts of the flake, but disables all secrets-related features (as they would not work without the proper SSH keys).
I also set the WLR_RENDERER_ALLOW_SOFTWARE=1
to allow this configuration to run in a virtualized environment. I also enable qemuGuest
for a smoother experience when testing on QEMU.
{ self, pkgs, lib, ... }: let profilesPath = "${self}/profiles"; in { imports = [ ./hardware-configuration.nix "${profilesPath}/nixos/optional/autologin.nix" ]; environment.variables = { WLR_RENDERER_ALLOW_SOFTWARE = 1; }; services.qemuGuest.enable = true; boot = { loader.systemd-boot.enable = lib.mkForce true; loader.efi.canTouchEfiVariables = true; kernelPackages = lib.mkDefault pkgs.linuxPackages_latest; }; networking = { hostName = "chaostheatre"; firewall.enable = true; }; swarselsystems = { wallpaper = self + /wallpaper/lenovowp.png; initialSetup = true; isPublic = true; isLinux = true; }; home-manager.users.swarsel.swarselsystems = { isNixos = true; isPublic = true; flakePath = "/home/swarsel/.dotfiles"; }; }
3.2. Additions and modifications
In this section I define packages that I manually want to nixpkgs. This can be useful for packages that are currently awaiting a PR or public packages that I do not want to maintain.
As such, I also define three additional overlays:
additions
These are for the aforementioned added packagesmodification
These are for packages that are on nixpkgs, but do not fit my usecase, meaning I need to perform modifications on them.nixpkgs-stable
This is simply a mirror of the most recent stable branch of nixpkgs. Useful for packages that are broken on nixpkgs, but do not need to be on bleeding edge anyways.
Also, this is where I define all of my own modules. These are mostly used for setting some host-specifics directly than opposed to through multiple options.
Lastly, I add some of my own library functions to be used alongside the functions provided by nixpkgs
and home-manager
.
3.2.1. Packages
This is the central station for self-defined packages. These are all referenced in default.nix
. Wherever possible, I am keeping the shell version of these scripts in this file as well and then read it using builtin.readFile
in the NixOS configurations. This lets me keep full control in this one file but also keep the separate files uncluttered.
Note: The structure of generating the packages was changed in commit 2cf03a3 refactor: package and module generation
. That commit can be checked out in order to see a simpler version of achieving the same thing.
{ lib, pkgs, ... }: let packageNames = lib.swarselsystems.readNix "pkgs"; in lib.swarselsystems.mkPackages packageNames pkgs
3.2.1.1. pass-fuzzel
This app allows me, in conjunction with my Yubikey, to quickly enter passwords when the need arises. Normal and TOTP passwords are supported, and they can either be printed directly or copied to the clipboard.
# Adapted from https://code.kulupu.party/thesuess/home-manager/src/branch/main/modules/river.nix shopt -s nullglob globstar otp=0 typeit=0 while :; do case ${1:-} in -t | --type) typeit=1 ;; -o | --otp) otp=1 ;; *) break ;; esac shift done export PASSWORD_STORE_DIR=~/.local/share/password-store prefix=${PASSWORD_STORE_DIR-~/.local/share/password-store} if [[ $otp -eq 0 ]]; then password_files=("$prefix"/**/*.gpg) else password_files=("$prefix"/otp/**/*.gpg) fi password_files=("${password_files[@]#"$prefix"/}") password_files=("${password_files[@]%.gpg}") password=$(printf '%s\n' "${password_files[@]}" | fuzzel --dmenu "$@") [[ -n $password ]] || exit if [[ $otp -eq 0 ]]; then if [[ $typeit -eq 0 ]]; then pass show -c "$password" &> /tmp/pass-fuzzel else pass show "$password" | { IFS= read -r pass printf %s "$pass" } | wtype - fi else if [[ $typeit -eq 0 ]]; then pass otp -c "$password" &> /tmp/pass-fuzzel else pass otp "$password" | { IFS= read -r pass printf %s "$pass" } | wtype - fi fi notify-send -u critical -a pass -t 1000 "Copied/Typed Password"
{ self, name, writeShellApplication, libnotify, pass, fuzzel, wtype }: writeShellApplication { inherit name; runtimeInputs = [ libnotify (pass.withExtensions (exts: [ exts.pass-otp ])) fuzzel wtype ]; text = builtins.readFile "${self}/scripts/${name}.sh"; }
3.2.1.2. cura5
The version of cura
used to be quite outdated in nixpkgs. I am fetching a newer AppImage here and use that instead.
# taken from https://github.com/NixOS/nixpkgs/issues/186570#issuecomment-1627797219 { appimageTools, fetchurl, writeScriptBin, pkgs, ... }: let cura5 = appimageTools.wrapType2 rec { pname = "cura5"; version = "5.9.0"; src = fetchurl { url = "https://github.com/Ultimaker/Cura/releases/download/${version}/UltiMaker-Cura-${version}-linux-X64.AppImage"; hash = "sha256-STtVeM4Zs+PVSRO3cI0LxnjRDhOxSlttZF+2RIXnAp4="; }; extraPkgs = pkgs: with pkgs; [ ]; }; in writeScriptBin "cura" '' #! ${pkgs.bash}/bin/bash # AppImage version of Cura loses current working directory and treats all paths relative to $HOME. # So we convert each of the files passed as argument to an absolute path. # This fixes use cases like `cd /path/to/my/files; cura mymodel.stl anothermodel.stl`. args=() for a in "$@"; do if [ -e "$a" ]; then a="$(realpath "$a")" fi args+=("$a") done exec "${cura5}/bin/cura5" "''${args[@]}" ''
3.2.1.3. hm-specialisation
This script allows for quick git home-manager specialisation switching.
{ name, writeShellApplication, fzf, findutils, home-manager, ... }: writeShellApplication { inherit name; runtimeInputs = [ fzf findutils home-manager ]; text = '' genpath=$(home-manager generations | head -1 | awk '{print $7}') dirs=$(find "$genpath/specialisation" -type l 2>/dev/null; [ -d "$genpath" ] && echo "$genpath") "$(echo "$dirs" | fzf --prompt="Choose home-manager specialisation to activate")"/activate ''; }
3.2.1.4. cdw
This script allows for quick git worktree switching.
{ name, writeShellApplication, fzf, ... }: writeShellApplication { inherit name; runtimeInputs = [ fzf ]; text = '' cd "$(git worktree list | fzf | awk '{print $1}')" ''; }
3.2.1.5. cdb
This script allows for quick git branch switching.
{ name, writeShellApplication, fzf, ... }: writeShellApplication { inherit name; runtimeInputs = [ fzf ]; text = '' git checkout "$(git branch --list | grep -v "^\*" | fzf | awk '{print $1}')" ''; }
3.2.1.6. bak
This script lets me quickly backup files by appending .bak
to the filename.
{ name, writeShellApplication, ... }: writeShellApplication { inherit name; text = '' cp -r "$1"{,.bak} ''; }
3.2.1.7. timer
This app starts a configuratble timer and uses TTS to say something once the timer runs out.
{ name, writeShellApplication, speechd, ... }: writeShellApplication { inherit name; runtimeInputs = [ speechd ]; text = '' sleep "$1"; while true; do spd-say "$2"; sleep 0.5; done; ''; }
3.2.1.8. e
This is a shorthand for calling emacsclient mostly. Also, it hides the kittyterm scratchpad window that I sometimes use for calling a command quickly, in case it is on the screen. After emacs closes, the kittyterm window is then shown again if it was visible earlier.
wait=0 while :; do case ${1:-} in -w | --wait) wait=1 ;; *) break ;; esac shift done STR=$(swaymsg -t get_tree | jq -r 'recurse(.nodes[]) | select(.name == "__i3_scratch")' | grep kittyterm || true) if [ "$STR" == "" ]; then swaymsg '[title="kittyterm"]' scratchpad show emacsclient -c -a "" "$@" swaymsg '[title="kittyterm"]' scratchpad show else if [[ $wait -eq 0 ]]; then emacsclient -n -c -a "" "$@" else emacsclient -c -a "" "$@" fi fi
{ self, name, writeShellApplication, emacs30-pgtk, sway, jq }: writeShellApplication { inherit name; runtimeInputs = [ emacs30-pgtk sway jq ]; text = builtins.readFile "${self}/scripts/${name}.sh"; }
3.2.1.9. command-not-found
The normal command-not-found.sh
uses the outdated nix-shell
commands as suggestions. This version supplies me with the more modern nixpkgs#<name>
version.
# Adapted from https://github.com/bennofs/nix-index/blob/master/command-not-found.sh command_not_found_handle() { if [ -n "${MC_SID-}" ] || ! [ -t 1 ]; then >&2 echo "$1: command not found" return 127 fi echo -n "searching nix-index..." ATTRS=$(@nix-locate@ --minimal --no-group --type x --type s --top-level --whole-name --at-root "/bin/$1") case $(echo -n "$ATTRS" | grep -c "^") in 0) >&2 echo -ne "$(@tput@ el1)\r" >&2 echo "$1: command not found" ;; *) >&2 echo -ne "$(@tput@ el1)\r" >&2 echo "The program ‘$(@tput@ setaf 4)$1$(@tput@ sgr0)’ is currently not installed." >&2 echo "It is provided by the following derivation(s):" while read -r ATTR; do ATTR=${ATTR%.out} >&2 echo " $(@tput@ setaf 12)nixpkgs#$(@tput@ setaf 4)$ATTR$(@tput@ sgr0)" done <<< "$ATTRS" ;; esac return 127 } command_not_found_handler() { command_not_found_handle "$@" return $? }
3.2.1.10. swarselcheck
This app checks for different apps that I keep around in the scratchpad for quick viewing and hiding (messengers and music players mostly) and then behaves like the kittyterm hider that I described in e.
kitty=0 element=0 vesktop=0 spotifyplayer=0 while :; do case ${1:-} in -k | --kitty) kitty=1 ;; -e | --element) element=1 ;; -d | --vesktop) vesktop=1 ;; -s | --spotifyplayer) spotifyplayer=1 ;; *) break ;; esac shift done if [[ $kitty -eq 1 ]]; then STR=$(swaymsg -t get_tree | jq -r 'recurse(.nodes[]) | select(.name == "__i3_scratch")' | grep kittyterm || true) CHECK=$(swaymsg -t get_tree | grep kittyterm || true) if [ "$CHECK" == "" ]; then exec kitty -T kittyterm -o confirm_os_window_close=0 zellij attach --create kittyterm & sleep 1 fi if [ "$STR" == "" ]; then exec swaymsg '[title="kittyterm"]' scratchpad show else exec swaymsg '[title="kittyterm"]' scratchpad show fi elif [[ $element -eq 1 ]]; then STR=$(swaymsg -t get_tree | grep Element || true) if [ "$STR" == "" ]; then exec element-desktop else exec swaymsg '[app_id=Element]' kill fi elif [[ $vesktop -eq 1 ]]; then STR=$(swaymsg -t get_tree | grep vesktop || true) if [ "$STR" == "" ]; then exec vesktop else exec swaymsg '[app_id=vesktop]' kill fi elif [[ $spotifyplayer -eq 1 ]]; then STR=$(swaymsg -t get_tree | jq -r 'recurse(.nodes[]) | select(.name == "__i3_scratch")' | grep spotifytui || true) CHECK=$(swaymsg -t get_tree | grep spotifytui || true) if [ "$CHECK" == "" ]; then exec kitty -T spotifytui -o confirm_os_window_close=0 spotify_player & sleep 1 fi if [ "$STR" == "" ]; then exec swaymsg '[title="spotifytui"]' scratchpad show else exec swaymsg '[title="spotifytui"]' scratchpad show fi fi
{ self, name, writeShellApplication, kitty, element-desktop, vesktop, spotify-player, jq }: writeShellApplication { inherit name; runtimeInputs = [ kitty element-desktop vesktop spotify-player jq ]; text = builtins.readFile "${self}/scripts/${name}.sh"; }
3.2.1.11. swarselzellij
KITTIES=$(($(pgrep -P 1 kitty | wc -l) - 1)) if [[ $KITTIES -lt 1 ]]; then exec kitty -o confirm_os_window_close=0 zellij attach --create main else exec kitty -o confirm_os_window_close=0 zellij attach --create "temp $KITTIES" fi
{ self, name, writeShellApplication, kitty }: writeShellApplication { inherit name; runtimeInputs = [ kitty ]; text = builtins.readFile "${self}/scripts/${name}.sh"; }
3.2.1.12. waybarupdate
This scripts checks if there are uncommited changes in either my dotfile repo, my university repo, or my passfile repo. In that case a warning will be shown in waybar.
CFG=$(git --git-dir="$HOME"/.dotfiles/.git --work-tree="$HOME"/.dotfiles/ status -s | wc -l) CSE=$(git --git-dir="$DOCUMENT_DIR_PRIV"/CSE_TUWIEN/.git --work-tree="$DOCUMENT_DIR_PRIV"/CSE_TUWIEN/ status -s | wc -l) PASS=$(($(git --git-dir="$HOME"/.local/share/password-store/.git --work-tree="$HOME"/.local/share/password-store/ status -s | wc -l) + $(git --git-dir="$HOME"/.local/share/password-store/.git --work-tree="$HOME"/.local/share/password-store/ diff origin/main..HEAD | wc -l))) if [[ $CFG != 0 ]]; then CFG_STR='CONFIG' else CFG_STR='' fi if [[ $CSE != 0 ]]; then CSE_STR=' CSE' else CSE_STR='' fi if [[ $PASS != 0 ]]; then PASS_STR=' PASS' else PASS_STR='' fi OUT="$CFG_STR""$CSE_STR""$PASS_STR" echo "$OUT"
{ self, name, writeShellApplication, git }: writeShellApplication { inherit name; runtimeInputs = [ git ]; text = builtins.readFile "${self}/scripts/${name}.sh"; }
3.2.1.13. opacitytoggle
This app quickly toggles between 5% and 0% transparency.
if swaymsg opacity plus 0.01 -q; then swaymsg opacity 1 else swaymsg opacity 0.95 fi
{ self, name, writeShellApplication, sway }: writeShellApplication { inherit name; runtimeInputs = [ sway ]; text = builtins.readFile "${self}/scripts/${name}.sh"; }
3.2.1.14. fs-diff
This utility is used to compare the current state of the root directory with the blanket state that is stored in /root-blank (the snapshot that is restored on each reboot of an impermanence machine). Using this, I can find files that I will lose once I reboot - if there are important files in that list, I can then easily add them to the persist options.
set -euo pipefail OLD_TRANSID=$(sudo btrfs subvolume find-new /mnt/root-blank 9999999) OLD_TRANSID=${OLD_TRANSID#transid marker was } sudo btrfs subvolume find-new "/mnt/root" "$OLD_TRANSID" | sed '$d' | cut -f17- -d' ' | sort | uniq | while read -r path; do path="/$path" if [ -L "$path" ]; then : # The path is a symbolic link, so is probably handled by NixOS already elif [ -d "$path" ]; then : # The path is a directory, ignore else echo "$path" fi done
{ self, name, writeShellApplication }: writeShellApplication { inherit name; text = builtins.readFile "${self}/scripts/${name}.sh"; }
3.2.1.15. update-checker
This utility checks if there are updated packages in nixpkgs-unstable. It does so by fully building the most recent configuration, which I do not love, but it has its merits once I am willing to switch to the newer version.
updates="$({ cd /home/swarsel/.dotfiles && nix flake lock --update-input nixpkgs && nix build .#nixosConfigurations."$(eval hostname)".config.system.build.toplevel && nvd diff /run/current-system ./result | grep -c '\[U'; } || true)" alt="has-updates" if [[ $updates -eq 0 ]]; then alt="updated" fi tooltip="System updated" if [[ $updates != 0 ]]; then tooltip=$(cd ~/.dotfiles && nvd diff /run/current-system ./result | grep -e '\[U' | awk '{ for (i=3; i<NF; i++) printf $i " "; if (NF >= 3) print $NF; }' ORS='\\n') echo "{ \"text\":\"$updates\", \"alt\":\"$alt\", \"tooltip\":\"$tooltip\" }" else echo "{ \"text\":\"\", \"alt\":\"$alt\", \"tooltip\":\"\" }" fi
{ self, name, writeShellApplication, nvd }: writeShellApplication { inherit name; runtimeInputs = [ nvd ]; text = builtins.readFile "${self}/scripts/${name}.sh"; }
3.2.1.16. github-notifications
This utility checks if there are updated packages in nixpkgs-unstable. It does so by fully building the most recent configuration, which I do not love, but it has its merits once I am willing to switch to the newer version.
{ name, writeShellApplication, jq, ... }: writeShellApplication { inherit name; runtimeInputs = [ jq ]; text = '' count=$(curl -u Swarsel:"$(cat /run/user/1000/secrets/github_notif)" https://api.github.com/notifications | jq '. | length') if [[ "$count" != "0" ]]; then echo "{\"text\":\"$count\"}" fi ''; }
3.2.1.17. screenshare
SHARESCREEN="$(nix eval --raw ~/.dotfiles#nixosConfigurations."$(hostname)".config.home-manager.users."$(whoami)".swarselsystems.sharescreen)" touch /tmp/screenshare.state STATE=$(< /tmp/screenshare.state) if [[ $STATE != "1" ]]; then wl-mirror "$SHARESCREEN" & sleep 0.1 swaymsg output "$SHARESCREEN" mode "$SWARSEL_LO_RES" echo 1 > /tmp/screenshare.state swaymsg '[app_id=at.yrlf.wl_mirror] move to workspace 12:S' swaymsg '[app_id=at.yrlf.wl_mirror] fullscreen' else swaymsg output "$SHARESCREEN" mode "$SWARSEL_HI_RES" echo 0 > /tmp/screenshare.state swaymsg '[app_id=at.yrlf.wl_mirror] kill' fi
{ self, name, writeShellApplication, sway }: writeShellApplication { inherit name; runtimeInputs = [ sway ]; text = builtins.readFile "${self}/scripts/${name}.sh"; }
3.2.1.18. swarsel-bootstrap
This program sets up a new NixOS host remotely. It also takes care of secret management on the new host.
# highly inspired by https://github.com/EmergentMind/nix-config/blob/dev/scripts/bootstrap-nixos.sh set -eo pipefail target_hostname="" target_destination="" target_user="swarsel" ssh_port="22" persist_dir="" disk_encryption=0 temp=$(mktemp -d) function help_and_exit() { echo echo "Remotely installs SwarselSystem on a target machine including secret deployment." echo echo "USAGE: $0 -n <target_hostname> -d <target_destination> [OPTIONS]" echo echo "ARGS:" echo " -n <target_hostname> specify target_hostname of the target host to deploy the nixos config on." echo " -d <target_destination> specify ip or url to the target host." echo " target during install process." echo echo "OPTIONS:" echo " -u <target_user> specify target_user with sudo access. nix-config will be cloned to their home." echo " Default='${target_user}'." echo " --port <ssh_port> specify the ssh port to use for remote access. Default=${ssh_port}." echo " --debug Enable debug mode." echo " -h | --help Print this help." exit 0 } function cleanup() { rm -rf "$temp" } trap cleanup exit function red() { echo -e "\x1B[31m[!] $1 \x1B[0m" if [ -n "${2-}" ]; then echo -e "\x1B[31m[!] $($2) \x1B[0m" fi } function green() { echo -e "\x1B[32m[+] $1 \x1B[0m" if [ -n "${2-}" ]; then echo -e "\x1B[32m[+] $($2) \x1B[0m" fi } function yellow() { echo -e "\x1B[33m[*] $1 \x1B[0m" if [ -n "${2-}" ]; then echo -e "\x1B[33m[*] $($2) \x1B[0m" fi } function yes_or_no() { echo -en "\x1B[32m[+] $* [y/n] (default: y): \x1B[0m" while true; do read -rp "" yn yn=${yn:-y} case $yn in [Yy]*) return 0 ;; [Nn]*) return 1 ;; esac done } function update_sops_file() { key_name=$1 key_type=$2 key=$3 if [ ! "$key_type" == "hosts" ] && [ ! "$key_type" == "users" ]; then red "Invalid key type passed to update_sops_file. Must be either 'hosts' or 'users'." exit 1 fi cd "${git_root}" SOPS_FILE=".sops.yaml" sed -i "{ # Remove any * and & entries for this host /[*&]$key_name/ d; # Inject a new age: entry # n matches the first line following age: and p prints it, then we transform it while reusing the spacing /age:/{n; p; s/\(.*- \*\).*/\1$key_name/}; # Inject a new hosts or user: entry /&$key_type/{n; p; s/\(.*- &\).*/\1$key_name $key/} }" $SOPS_FILE green "Updating .sops.yaml" cd - } while [[ $# -gt 0 ]]; do case "$1" in -n) shift target_hostname=$1 ;; -d) shift target_destination=$1 ;; -u) shift target_user=$1 ;; --port) shift ssh_port=$1 ;; --debug) set -x ;; -h | --help) help_and_exit ;; *) echo "Invalid option detected." help_and_exit ;; esac shift done green "~SwarselSystems~ remote installer" green "Reading system information for $target_hostname ..." DISK="$(nix eval --raw ~/.dotfiles#nixosConfigurations."$target_hostname".config.swarselsystems.rootDisk)" green "Root Disk: $DISK" CRYPTED="$(nix eval ~/.dotfiles#nixosConfigurations."$target_hostname".config.swarselsystems.isCrypted)" if [[ $CRYPTED == "true" ]]; then green "Encryption: ✓" disk_encryption=1 else red "Encryption: X" disk_encryption=0 fi IMPERMANENCE="$(nix eval ~/.dotfiles#nixosConfigurations."$target_hostname".config.swarselsystems.isImpermanence)" if [[ $IMPERMANENCE == "true" ]]; then green "Impermanence: ✓" persist_dir="/persist" else red "Impermanence: X" persist_dir="" fi SWAP="$(nix eval ~/.dotfiles#nixosConfigurations."$target_hostname".config.swarselsystems.isSwap)" if [[ $SWAP == "true" ]]; then green "Swap: ✓" else red "Swap: X" fi SECUREBOOT="$(nix eval ~/.dotfiles#nixosConfigurations."$target_hostname".config.swarselsystems.isSecureBoot)" if [[ $SECUREBOOT == "true" ]]; then green "Secure Boot: ✓" else red "Secure Boot: X" fi ssh_cmd="ssh -oport=${ssh_port} -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -t $target_user@$target_destination" # ssh_root_cmd=$(echo "$ssh_cmd" | sed "s|${target_user}@|root@|") # uses @ in the sed switch to avoid it triggering on the $ssh_key value ssh_root_cmd=${ssh_cmd/${target_user}@/root@} scp_cmd="scp -oport=${ssh_port} -o StrictHostKeyChecking=no" if [[ -z ${FLAKE} ]]; then FLAKE=/home/"$target_user"/.dotfiles fi if [ ! -d "$FLAKE" ]; then cd /home/"$target_user" yellow "Flake directory not found - cloning repository from GitHub" git clone git@github.com:Swarsel/.dotfiles.git || (yellow "Could not clone repository via SSH - defaulting to HTTPS" && git clone https://github.com/Swarsel/.dotfiles.git) FLAKE=/home/"$target_user"/.dotfiles fi cd "$FLAKE" git_root=$(git rev-parse --show-toplevel) # ------------------------ green "Wiping known_hosts of $target_destination" sed -i "/$target_hostname/d; /$target_destination/d" ~/.ssh/known_hosts # ------------------------ green "Preparing a new ssh_host_ed25519_key pair for $target_hostname." # Create the directory where sshd expects to find the host keys install -d -m755 "$temp/$persist_dir/etc/ssh" # Generate host ssh key pair without a passphrase ssh-keygen -t ed25519 -f "$temp/$persist_dir/etc/ssh/ssh_host_ed25519_key" -C root@"$target_hostname" -N "" # Set the correct permissions so sshd will accept the key chmod 600 "$temp/$persist_dir/etc/ssh/ssh_host_ed25519_key" echo "Adding ssh host fingerprint at $target_destination to ~/.ssh/known_hosts" # This will fail if we already know the host, but that's fine ssh-keyscan -p "$ssh_port" "$target_destination" >> ~/.ssh/known_hosts || true # ------------------------ # when using luks, disko expects a passphrase on /tmp/disko-password, so we set it for now and will update the passphrase later # via the config if [ "$disk_encryption" -eq 1 ]; then while true; do green "Set disk encryption passphrase:" read -rs luks_passphrase green "Please confirm passphrase:" read -rs luks_passphrase_confirm if [[ $luks_passphrase == "$luks_passphrase_confirm" ]]; then $ssh_root_cmd "/bin/sh -c 'echo $luks_passphrase > /tmp/disko-password'" break else red "Passwords do not match" fi done fi # ------------------------ green "Generating hardware-config.nix for $target_hostname and adding it to the nix-config." $ssh_root_cmd "nixos-generate-config --force --no-filesystems --root /mnt" green "Injecting initialSetup" $ssh_root_cmd "sed -i '/ boot.extraModulePackages /a \ swarselsystems.initialSetup = true;' /mnt/etc/nixos/hardware-configuration.nix" mkdir -p "$FLAKE"/hosts/nixos/"$target_hostname" $scp_cmd root@"$target_destination":/mnt/etc/nixos/hardware-configuration.nix "${git_root}"/hosts/nixos/"$target_hostname"/hardware-configuration.nix # ------------------------ green "Deploying minimal NixOS installation on $target_destination" SHELL=/bin/sh nix run github:nix-community/nixos-anywhere -- --ssh-port "$ssh_port" --extra-files "$temp" --flake .#"$target_hostname" root@"$target_destination" echo "Updating ssh host fingerprint at $target_destination to ~/.ssh/known_hosts" ssh-keyscan -p "$ssh_port" "$target_destination" >> ~/.ssh/known_hosts || true # ------------------------ while true; do read -rp "Press Enter to continue once the remote host has finished booting." if nc -z "$target_destination" "${ssh_port}" 2> /dev/null; then green "$target_destination is booted. Continuing..." break else yellow "$target_destination is not yet ready." fi done # ------------------------ if [[ $SECUREBOOT == "true" ]]; then green "Setting up secure boot keys" $ssh_root_cmd "mkdir -p /var/lib/sbctl" read -ra scp_call <<< "${scp_cmd}" sudo "${scp_call[@]}" -r /var/lib/sbctl root@"$target_destination":/var/lib/ $ssh_root_cmd "sbctl enroll-keys --ignore-immutable --microsoft || true" fi # ------------------------ green "Disabling initialSetup" sed -i '/swarselsystems\.initialSetup = true;/d' "$git_root"/hosts/nixos/"$target_hostname"/hardware-configuration.nix if [ -n "$persist_dir" ]; then $ssh_root_cmd "cp /etc/machine-id $persist_dir/etc/machine-id || true" $ssh_root_cmd "cp -R /etc/ssh/ $persist_dir/etc/ssh/ || true" fi # ------------------------ green "Generating an age key based on the new ssh_host_ed25519_key." target_key=$( ssh-keyscan -p "$ssh_port" -t ssh-ed25519 "$target_destination" 2>&1 | grep ssh-ed25519 | cut -f2- -d" " || ( red "Failed to get ssh key. Host down?" exit 1 ) ) host_age_key=$(nix shell nixpkgs#ssh-to-age.out -c sh -c "echo $target_key | ssh-to-age") if grep -qv '^age1' <<< "$host_age_key"; then red "The result from generated age key does not match the expected format." yellow "Result: $host_age_key" yellow "Expected format: age1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" exit 1 else echo "$host_age_key" fi green "Updating nix-secrets/.sops.yaml" update_sops_file "$target_hostname" "hosts" "$host_age_key" yellow ".sops.yaml has been updated. There may be superfluous entries, you might need to edit manually." if yes_or_no "Do you want to manually edit .sops.yaml now?"; then vim "${git_root}"/.sops.yaml fi green "Updating all secrets files to reflect updates .sops.yaml" sops updatekeys --yes --enable-local-keyservice "${git_root}"/secrets/*/secrets.yaml # -------------------------- green "Making ssh_host_ed25519_key available to home-manager for user $target_user" sed -i "/$target_hostname/d; /$target_destination/d" ~/.ssh/known_hosts $scp_cmd root@"$target_destination":/etc/ssh/ssh_host_ed25519_key root@"$target_destination":/home/"$target_user"/.ssh/ssh_host_ed25519_key $ssh_root_cmd "chown $target_user:users /home/swarsel/.ssh/ssh_host_ed25519_key" # __________________________ if yes_or_no "Add ssh host fingerprints for git upstream repositories? (This is needed for building the full config)"; then green "Adding ssh host fingerprints for git{lab,hub}" $ssh_cmd "mkdir -p /home/$target_user/.ssh/; ssh-keyscan -t ssh-ed25519 gitlab.com github.com swagit.swarsel.win >> /home/$target_user/.ssh/known_hosts" $ssh_root_cmd "mkdir -p /root/.ssh/; ssh-keyscan -t ssh-ed25519 gitlab.com github.com swagit.swarsel.win >> /root/.ssh/known_hosts" fi # -------------------------- if yes_or_no "Do you want to copy your full nix-config and nix-secrets to $target_hostname?"; then green "Adding ssh host fingerprint at $target_destination to ~/.ssh/known_hosts" ssh-keyscan -p "$ssh_port" "$target_destination" >> ~/.ssh/known_hosts || true green "Copying full nix-config to $target_hostname" cd "${git_root}" just sync "$target_user" "$target_destination" if [ -n "$persist_dir" ]; then $ssh_root_cmd "cp -r /home/$target_user/.dotfiles $persist_dir/.dotfiles || true" $ssh_root_cmd "cp -r /home/$target_user/.ssh $persist_dir/.ssh || true" fi if yes_or_no "Do you want to rebuild immediately?"; then green "Rebuilding nix-config on $target_hostname" yellow "Reminder: The password is 'setup'" $ssh_root_cmd "mkdir -p /root/.local/share/nix/; printf '{\"extra-substituters\":{\"https://nix-community.cachix.org\":true,\"https://nix-community.cachix.org https://cache.ngi0.nixos.org/\":true},\"extra-trusted-public-keys\":{\"nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=\":true,\"nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs= cache.ngi0.nixos.org-1:KqH5CBLNSyX184S9BKZJo1LxrxJ9ltnY2uAs5c/f1MA=\":true}}' > /root/.local/share/nix/trusted-settings.json" $ssh_cmd -oForwardAgent=yes "cd .dotfiles && sudo nixos-rebuild --show-trace --flake .#$target_hostname switch" fi else echo green "NixOS was successfully installed!" echo "Post-install config build instructions:" echo "To copy nix-config from this machine to the $target_hostname, run the following command from ~/nix-config" echo "just sync $target_user $target_destination" echo "To rebuild, sign into $target_hostname and run the following command from ~/nix-config" echo "cd nix-config" # see above FIXME:(bootstrap) echo "sudo nixos-rebuild --show-trace --flake .#$target_hostname switch" # echo "just rebuild" echo fi if yes_or_no "You can now commit and push the nix-config, which includes the hardware-configuration.nix for $target_hostname?"; then cd "${git_root}" deadnix hosts/nixos/"$target_hostname"/hardware-configuration.nix -qe nixpkgs-fmt hosts/nixos/"$target_hostname"/hardware-configuration.nix (pre-commit run --all-files 2> /dev/null || true) && git add "$git_root/hosts/nixos/$target_hostname/hardware-configuration.nix" && git add "$git_root/.sops.yaml" && git add "$git_root/secrets" && (git commit -m "feat: deployed $target_hostname" || true) && git push fi
{ self, name, writeShellApplication, openssh }: writeShellApplication { inherit name; runtimeInputs = [ openssh ]; text = builtins.readFile "${self}/scripts/${name}.sh"; }
3.2.1.19. swarsel-rebuild
This program builds a configuration locally.
set -eo pipefail target_config="chaostheatre" target_user="swarsel" function help_and_exit() { echo echo "Builds SwarselSystem configuration." echo echo "USAGE: $0 [OPTIONS]" echo echo "ARGS:" echo " -n <target_config> specify nixos config to build." echo " Default: chaostheatre" echo " -u <target_user> specify user to deploy for." echo " Default: swarsel" echo " -h | --help Print this help." exit 0 } function red() { echo -e "\x1B[31m[!] $1 \x1B[0m" if [ -n "${2-}" ]; then echo -e "\x1B[31m[!] $($2) \x1B[0m" fi } function green() { echo -e "\x1B[32m[+] $1 \x1B[0m" if [ -n "${2-}" ]; then echo -e "\x1B[32m[+] $($2) \x1B[0m" fi } function yellow() { echo -e "\x1B[33m[*] $1 \x1B[0m" if [ -n "${2-}" ]; then echo -e "\x1B[33m[*] $($2) \x1B[0m" fi } while [[ $# -gt 0 ]]; do case "$1" in -n) shift target_config=$1 ;; -u) shift target_user=$1 ;; -h | --help) help_and_exit ;; *) echo "Invalid option detected." help_and_exit ;; esac shift done cd /home/"$target_user" if [ ! -d /home/"$target_user"/.dotfiles ]; then green "Cloning repository from GitHub" git clone https://github.com/Swarsel/.dotfiles.git else red "A .dotfiles repository is in the way. Please (re-)move the repository and try again." exit 1 fi local_keys=$(ssh-add -L || true) pub_key=$(cat /home/"$target_user"/.dotfiles/secrets/keys/ssh/nbl-imba-2.pub) read -ra pub_arr <<< "$pub_key" cd .dotfiles if [[ $local_keys != *"${pub_arr[1]}"* ]]; then yellow "The ssh key for this configuration is not available." green "Adjusting flake.nix so that the configuration is buildable" sed -i '/nix-secrets = {/,/^[[:space:]]*};/d' flake.nix git add flake.nix else green "Valid SSH key found! Continuing with installation" fi sudo nixos-generate-config --dir /home/"$target_user"/.dotfiles/hosts/nixos/"$target_config"/ git add /home/"$target_user"/.dotfiles/hosts/nixos/"$target_config"/hardware-configuration.nix green "Installing flake $target_config" sudo nixos-rebuild --show-trace --flake .#"$target_config" boot yellow "Please keep in mind that this is only a demo of the configuration. Things might break unexpectedly."
{ self, name, writeShellApplication, git }: writeShellApplication { inherit name; runtimeInputs = [ git ]; text = builtins.readFile "${self}/scripts/${name}.sh"; }
3.2.1.20. swarsel-install
This program sets up a new NixOS host locally.
set -eo pipefail target_config="chaostheatre" target_hostname="chaostheatre" target_user="swarsel" persist_dir="" disk_encryption=0 function help_and_exit() { echo echo "Locally installs SwarselSystem on this machine." echo echo "USAGE: $0 -n <target_config> [OPTIONS]" echo echo "ARGS:" echo " -n <target_config> specify the nixos config to deploy." echo " Default: chaostheatre" echo " Default: chaostheatre" echo " -u <target_user> specify user to deploy for." echo " Default: swarsel" echo " -h | --help Print this help." exit 0 } function red() { echo -e "\x1B[31m[!] $1 \x1B[0m" if [ -n "${2-}" ]; then echo -e "\x1B[31m[!] $($2) \x1B[0m" fi } function green() { echo -e "\x1B[32m[+] $1 \x1B[0m" if [ -n "${2-}" ]; then echo -e "\x1B[32m[+] $($2) \x1B[0m" fi } function yellow() { echo -e "\x1B[33m[*] $1 \x1B[0m" if [ -n "${2-}" ]; then echo -e "\x1B[33m[*] $($2) \x1B[0m" fi } while [[ $# -gt 0 ]]; do case "$1" in -n) shift target_config=$1 target_hostname=$1 ;; -u) shift target_user=$1 ;; -h | --help) help_and_exit ;; *) echo "Invalid option detected." help_and_exit ;; esac shift done function cleanup() { sudo rm -rf .cache/nix sudo rm -rf /root/.cache/nix } trap cleanup exit green "~SwarselSystems~ remote installer" cd /home/"$target_user" sudo rm -rf /root/.cache/nix sudo rm -rf .cache/nix sudo rm -rf .dotfiles green "Cloning repository from GitHub" git clone https://github.com/Swarsel/.dotfiles.git green "Reading system information for $target_config ..." DISK="$(nix eval --raw ~/.dotfiles#nixosConfigurations."$target_hostname".config.swarselsystems.rootDisk)" green "Root Disk: $DISK" CRYPTED="$(nix eval ~/.dotfiles#nixosConfigurations."$target_hostname".config.swarselsystems.isCrypted)" if [[ $CRYPTED == "true" ]]; then green "Encryption: ✓" disk_encryption=1 else red "Encryption: X" disk_encryption=0 fi IMPERMANENCE="$(nix eval ~/.dotfiles#nixosConfigurations."$target_hostname".config.swarselsystems.isImpermanence)" if [[ $IMPERMANENCE == "true" ]]; then green "Impermanence: ✓" persist_dir="/persist" else red "Impermanence: X" persist_dir="" fi SWAP="$(nix eval ~/.dotfiles#nixosConfigurations."$target_hostname".config.swarselsystems.isSwap)" if [[ $SWAP == "true" ]]; then green "Swap: ✓" else red "Swap: X" fi SECUREBOOT="$(nix eval ~/.dotfiles#nixosConfigurations."$target_hostname".config.swarselsystems.isSecureBoot)" if [[ $SECUREBOOT == "true" ]]; then green "Secure Boot: ✓" else red "Secure Boot: X" fi local_keys=$(ssh-add -L || true) pub_key=$(cat /home/"$target_user"/.dotfiles/secrets/keys/ssh/nbl-imba-2.pub) read -ra pub_arr <<< "$pub_key" cd .dotfiles if [[ $local_keys != *"${pub_arr[1]}"* ]]; then yellow "The ssh key for this configuration is not available." green "Adjusting flake.nix so that the configuration is buildable" sed -i '/nix-secrets = {/,/^[[:space:]]*};/d' flake.nix git add flake.nix else green "Valid SSH key found! Continuing with installation" fi if [ "$disk_encryption" -eq 1 ]; then while true; do green "Set disk encryption passphrase:" read -rs luks_passphrase green "Please confirm passphrase:" read -rs luks_passphrase_confirm if [[ $luks_passphrase == "$luks_passphrase_confirm" ]]; then echo "$luks_passphrase" > /tmp/disko-password break else red "Passwords do not match" fi done fi green "Setting up disk" sudo nix --experimental-features "nix-command flakes" run github:nix-community/disko/latest -- --mode destroy,format,mount --flake .#"$target_config" --yes-wipe-all-disks sudo mkdir -p /mnt/"$persist_dir"/home/"$target_user"/ sudo cp -r /home/"$target_user"/.dotfiles /mnt/"$persist_dir"/home/"$target_user"/ sudo chown -R 1000:100 /mnt/"$persist_dir"/home/"$target_user" green "Generating hardware configuration" sudo nixos-generate-config --root /mnt --no-filesystems --dir /home/"$target_user"/.dotfiles/hosts/nixos/"$target_config"/ green "Injecting initialSetup" sudo sed -i '/ boot.extraModulePackages /a \ swarselsystems.initialSetup = true;' /home/"$target_user"/.dotfiles/hosts/nixos/"$target_config"/hardware-configuration.nix git add /home/"$target_user"/.dotfiles/hosts/nixos/"$target_config"/hardware-configuration.nix sudo mkdir -p /root/.local/share/nix/ printf '{\"extra-substituters\":{\"https://nix-community.cachix.org\":true,\"https://nix-community.cachix.org https://cache.ngi0.nixos.org/\":true},\"extra-trusted-public-keys\":{\"nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=\":true,\"nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs= cache.ngi0.nixos.org-1:KqH5CBLNSyX184S9BKZJo1LxrxJ9ltnY2uAs5c/f1MA=\":true}}' | sudo tee /root/.local/share/nix/trusted-settings.json > /dev/null green "Installing flake $target_config" sudo nixos-install --flake .#"$target_config" green "Installation finished! Reboot to see changes"
{ self, name, writeShellApplication, git }: writeShellApplication { inherit name; runtimeInputs = [ git ]; text = builtins.readFile "${self}/scripts/${name}.sh"; }
3.2.1.21. swarsel-postinstall
This program sets up a new NixOS host locally.
set -eo pipefail target_config="chaostheatre" target_user="swarsel" function help_and_exit() { echo echo "Locally installs SwarselSystem on this machine." echo echo "USAGE: $0 -d <disk> [OPTIONS]" echo echo "ARGS:" echo " -d <disk> specify disk to install on." echo " -n <target_config> specify the nixos config to deploy." echo " Default: chaostheatre" echo " Default: chaostheatre" echo " -u <target_user> specify user to deploy for." echo " Default: swarsel" echo " -h | --help Print this help." exit 0 } function green() { echo -e "\x1B[32m[+] $1 \x1B[0m" if [ -n "${2-}" ]; then echo -e "\x1B[32m[+] $($2) \x1B[0m" fi } while [[ $# -gt 0 ]]; do case "$1" in -n) shift target_config=$1 ;; -u) shift target_user=$1 ;; -h | --help) help_and_exit ;; *) echo "Invalid option detected." help_and_exit ;; esac shift done function cleanup() { sudo rm -rf .cache/nix sudo rm -rf /root/.cache/nix } trap cleanup exit sudo rm -rf .cache/nix sudo rm -rf /root/.cache/nix green "~SwarselSystems~ remote post-installer" cd /home/"$target_user"/.dotfiles SECUREBOOT="$(nix eval ~/.dotfiles#nixosConfigurations."$target_config".config.swarselsystems.isSecureBoot)" if [[ $SECUREBOOT == "true" ]]; then green "Setting up secure boot keys" sudo mkdir -p /var/lib/sbctl sbctl create-keys || true sbctl enroll-keys --ignore-immutable --microsoft || true fi green "Disabling initialSetup" sed -i '/swarselsystems\.initialSetup = true;/d' /home/"$target_user"/.dotfiles/hosts/nixos/"$target_config"/hardware-configuration.nix sudo nixos-rebuild --flake .#"$target_config" switch green "Post-install finished!"
{ self, name, writeShellApplication, git }: writeShellApplication { inherit name; runtimeInputs = [ git ]; text = builtins.readFile "${self}/scripts/${name}.sh"; }
3.2.1.22. t2ts
This script allows for quick git branch switching.
{ name, writeShellApplication, ... }: writeShellApplication { inherit name; runtimeInputs = [ ]; text = '' date -d"$1" +%s ''; }
3.2.1.23. ts2t
This script allows for quick git branch switching.
{ name, writeShellApplication, ... }: writeShellApplication { inherit name; runtimeInputs = [ ]; text = '' date -d @"$1" 2>/dev/null || date -r "$1" ''; }
3.2.1.24. vershell
This script allows for quick git branch switching.
{ name, writeShellApplication, ... }: writeShellApplication { inherit name; runtimeInputs = [ ]; text = '' nix shell github:nixos/nixpkgs/"$1"#"$2"; ''; }
3.2.1.25. eontimer
This script allows for quick git branch switching.
{ lib , python3 , fetchFromGitHub , makeDesktopItem , writeShellScript , ... }: let wrapper = writeShellScript "eontimer-wrapper" '' export QT_QPA_PLATFORM=xcb exec @out@/bin/EonTimer ''; in python3.pkgs.buildPythonApplication rec { pname = "eontimer"; version = "3.0.0-rc.6"; pyproject = true; src = fetchFromGitHub { owner = "DasAmpharos"; repo = "EonTimer"; rev = version; hash = "sha256-+XN/VGGlEg2gVncRZrWDOZ2bfxt8xyIu22F2wHlG6YI="; }; build-system = [ python3.pkgs.setuptools python3.pkgs.wheel ]; dependencies = with python3.pkgs; [ altgraph certifi charset-normalizer idna libsass macholib packaging pillow pipdeptree platformdirs pyinstaller pyinstaller-hooks-contrib pyside6 requests setuptools shiboken6 urllib3 ]; nativeBuildInputs = [ python3.pkgs.pyinstaller ]; buildPhase = '' runHook preBuild pyinstaller --clean --noconfirm EonTimer.spec runHook postBuild ''; installPhase = '' runHook preInstall mkdir -p $out/bin mkdir -p $out/share/applications cp dist/EonTimer $out/bin/ install -Dm755 -T ${wrapper} $out/bin/eontimer substituteInPlace $out/bin/eontimer --subst-var out runHook postInstall ''; postInstall = '' install -Dm755 -t $out/share/applications ${ makeDesktopItem { name = "eontimer"; desktopName = "EonTimer"; comment = "Start EonTimer"; exec = "eontimer"; } }/share/applications/eontimer.desktop ''; meta = { description = "Pokémon RNG Timer"; homepage = "https://github.com/DasAmpharos/EonTimer"; license = lib.licenses.mit; maintainers = with lib.maintainers; [ ]; mainProgram = "eon-timer"; }; }
3.2.1.26. project
set -euo pipefail if [ ! -d "$(pwd)/.git" ]; then git init fi nix flake init --template "$FLAKE"#"$1" direnv allow
{ self, name, writeShellApplication }: writeShellApplication { inherit name; text = builtins.readFile "${self}/scripts/${name}.sh"; }
3.2.1.27. fhs
{ name, pkgs, ... }: let base = pkgs.appimageTools.defaultFhsEnvArgs; in pkgs.buildFHSEnv (base // { name = "fhs"; targetPkgs = pkgs: (base.targetPkgs pkgs) ++ [ pkgs.pkg-config ]; profile = "export FHS=1"; runScript = "zsh"; extraOutputsToInstall = [ "dev" ]; })
3.2.1.28. swarsel-displaypower
A crude script to power on all displays that might be attached. Needed because sometimes displays do not awake from sleep.
swaymsg output eDP-1 power on > /dev/null 2>&1 || true swaymsg output eDP-2 power on > /dev/null 2>&1 || true
{ self, name, writeShellApplication, sway }: writeShellApplication { inherit name; runtimeInputs = [ sway ]; text = builtins.readFile "${self}/scripts/${name}.sh"; }
3.2.1.29. swarsel-mgba
AppImage version of mgba in which the lua scripting works.
{ appimageTools, fetchurl, ... }: let pname = "mgba"; version = "0.10.4"; src = fetchurl { url = "https://github.com/mgba-emu/mgba/releases/download/${version}/mGBA-${version}-appimage-x64.appimage"; hash = "sha256-rDihDfuA8DqxvCe6UeavCzpjeU+fSqUbFnyTNC2dc1I="; }; appimageContents = appimageTools.extractType2 { inherit pname version src; }; in appimageTools.wrapType2 { inherit pname version src; extraInstallCommands = '' install -Dm444 ${appimageContents}/io.mgba.mGBA.desktop -t $out/share/applications substituteInPlace $out/share/applications/io.mgba.mGBA.desktop \ --replace-fail 'Exec=mgba-qt %f' 'Exec=mgba' cp -r ${appimageContents}/usr/share/icons $out/share ''; }
3.2.2. Overlays (additions, overrides, nixpkgs-stable)
This file now holds all of the "nixpkgs-changes" that I am using across the configurations. Most notable here are the modifications
, where I am editing derivations according to my needs.
When adding a new entry here, do not forget to add it in the default output of this file, otherwise it will not be exposed to the rest of the system.
{ self, inputs, lib, ... }: let additions = final: _: import "${self}/pkgs" { pkgs = final; inherit lib; }; modifications = final: prev: { vesktop = prev.vesktop.override { withSystemVencord = true; }; firefox = prev.firefox.override { nativeMessagingHosts = [ prev.tridactyl-native prev.browserpass prev.plasma5Packages.plasma-browser-integration ]; }; mgba = final.swarsel-mgba; retroarch = prev.retroarch.withCores (cores: with cores; [ snes9x # snes nestopia # nes dosbox # dos scummvm # scumm vba-m # gb/a mgba # gb/a melonds # ds dolphin # gc/wii ]); # luakit = prev.river.overrideAttrs (oldAttrs: rec { # pname = "river"; # version = "git"; # src = prev.fetchFromGitHub { # owner = "luakit"; # repo = pname; # rev = "c16628c7f57c51d50f2d10a96c265fb0afaddb02"; # hash = "sha256-E3Xtv7JeCmafiNmpuS5VuLgh1TDAbibPtMo6A9Pz6EQ="; # fetchSubmodules = true; # }; # }); }; nixpkgs-stable = final: _: { stable = import inputs.nixpkgs-stable { inherit (final) system; config.allowUnfree = true; }; }; zjstatus = _: prev: { zjstatus = inputs.zjstatus.packages.${prev.system}.default; }; in { default = final: prev: (additions final prev) // (modifications final prev) // (nixpkgs-stable final prev) // (zjstatus final prev) // (inputs.nur.overlays.default final prev) // (inputs.emacs-overlay.overlay final prev) // (inputs.nix-topology.overlays.default final prev) // (inputs.nixgl.overlay final prev); }
3.2.3. Modules
In this section I define custom modules under the swarsel
attribute. These are mostly used to define settings specific to a host. I keep these settings confined to either home-manager or nixos to maintain compatibility with non-NixOS machines.
Note: The structure of generating the packages was changed in commit 2cf03a3 refactor: package and module generation
. That commit can be checked out in order to see a simpler version of achieving the same thing.
3.2.3.1. NixOS
Modules that need to be loaded on the NixOS level. Note that these will not be available on systems that are not running NixOS.
{ lib, ... }: let moduleNames = lib.swarselsystems.readNix "modules/nixos"; in lib.swarselsystems.mkModules moduleNames "nixos"
3.2.3.1.1. Hardware
This lets me set some basic flags about the hardware of the configured systems.
{ lib, ... }: { options.swarselsystems.hasBluetooth = lib.mkEnableOption "bluetooth availability"; options.swarselsystems.hasFingerprint = lib.mkEnableOption "fingerprint sensor availability"; options.swarselsystems.trackpoint.isAvailable = lib.mkEnableOption "trackpoint availability"; options.swarselsystems.trackpoint.device = lib.mkOption { type = lib.types.str; default = ""; }; }
3.2.3.1.2. Setup
I usually use mutableUsers = false
in my NixOS configuration. However, on a new system where sops-keys have not been deployed, this would immediately lock me out of the system. Hence this flag can be used until sops-keys are created.
{ lib, ... }: { options.swarselsystems.user = lib.mkOption { type = lib.types.str; default = "swarsel"; }; options.swarselsystems.withHomeManager = lib.mkOption { type = lib.types.bool; default = true; }; options.swarselsystems.isSwap = lib.mkOption { type = lib.types.bool; default = true; }; options.swarselsystems.swapSize = lib.mkOption { type = lib.types.str; default = "8G"; }; options.swarselsystems.rootDisk = lib.mkOption { type = lib.types.str; default = ""; }; options.swarselsystems.isCrypted = lib.mkEnableOption "uses full disk encryption"; options.swarselsystems.initialSetup = lib.mkEnableOption "initial setup (no sops keys available)"; options.swarselsystems.isImpermanence = lib.mkEnableOption "use impermanence on this system"; options.swarselsystems.isSecureBoot = lib.mkEnableOption "use secure boot on this system"; }
3.2.3.1.3. Server
{ lib, ... }: { options.swarselsystems.server.enable = lib.mkEnableOption "is a server machine"; options.swarselsystems.server.kavita = lib.mkEnableOption "enable kavita on server"; options.swarselsystems.server.jellyfin = lib.mkEnableOption "enable jellyfin on server"; options.swarselsystems.server.navidrome = lib.mkEnableOption "enable navidrome on server"; options.swarselsystems.server.spotifyd = lib.mkEnableOption "enable spotifyd on server"; options.swarselsystems.server.mpd = lib.mkEnableOption "enable mpd on server"; options.swarselsystems.server.matrix = lib.mkEnableOption "enable matrix on server"; options.swarselsystems.server.nextcloud = lib.mkEnableOption "enable nextcloud on server"; options.swarselsystems.server.immich = lib.mkEnableOption "enable immich on server"; options.swarselsystems.server.paperless = lib.mkEnableOption "enable paperless on server"; options.swarselsystems.server.transmission = lib.mkEnableOption "enable transmission and friends on server"; options.swarselsystems.server.syncthing = lib.mkEnableOption "enable syncthing on server"; options.swarselsystems.server.restic = lib.mkEnableOption "enable restic backups on server"; options.swarselsystems.server.monitoring = lib.mkEnableOption "enable monitoring on server"; options.swarselsystems.server.jenkins = lib.mkEnableOption "enable jenkins on server"; options.swarselsystems.server.emacs = lib.mkEnableOption "enable emacs server on server"; options.swarselsystems.server.forgejo = lib.mkEnableOption "enable forgejo on server"; options.swarselsystems.server.ankisync = lib.mkEnableOption "enable ankisync on server"; options.swarselsystems.server.freshrss = lib.mkEnableOption "enable freshrss on server"; }
3.2.3.2. home-manager
This holds modules that are to be used on most hosts. These are also the most important options to configure, as these allow me easy access to monitor, keyboard, and other setups.
{ lib, ... }: let moduleNames = lib.swarselsystems.readNix "modules/home"; in lib.swarselsystems.mkModules moduleNames "home"
3.2.3.2.1. Laptop
Laptops are not always plugged in, so they should show a battery icon in Waybar. Also, most laptops have a touchpad which usually needs to be configured:
- Tapping should be enabled.
- The touchpad should be disabled while typing (
dwt
option). - Natural scrolling should be enabled.
- Tag-and-drag lock should be disbled - it gets in my way too much.
{ lib, config, ... }: { options.swarselsystems.isLaptop = lib.mkEnableOption "laptop host"; config.swarselsystems.touchpad = lib.mkIf config.swarselsystems.isLaptop { "type:touchpad" = { dwt = "enabled"; tap = "enabled"; natural_scroll = "enabled"; middle_emulation = "enabled"; drag_lock = "disabled"; }; }; config.swarselsystems.waybarModules = lib.mkIf config.swarselsystems.isLaptop [ "custom/outer-left-arrow-dark" "mpris" "custom/left-arrow-light" "network" "custom/vpn" "custom/left-arrow-dark" "pulseaudio" "custom/left-arrow-light" "battery" "custom/left-arrow-dark" "group/hardware" "custom/left-arrow-light" "clock#2" "custom/left-arrow-dark" "clock#1" ]; }
3.2.3.2.2. Hardware
This section is mostly used to deliver the correct information to Waybar. AMD systems have changing hwmon paths that can be specifically set here. Also the cpu count can be set here for Waybars cpu module, but 8 is usually a good setting to show
{ lib, ... }: { options.swarselsystems.cpuCount = lib.mkOption { type = lib.types.int; default = 8; }; options.swarselsystems.temperatureHwmon.isAbsolutePath = lib.mkEnableOption "absolute temperature path"; options.swarselsystems.temperatureHwmon.path = lib.mkOption { type = lib.types.str; default = ""; }; options.swarselsystems.temperatureHwmon.input-filename = lib.mkOption { type = lib.types.str; default = ""; }; }
3.2.3.2.3. Waybar
These are explicit waybar options. Laptops do not need the battery module. However, this leads to a slight problem with theming: my waybar modules alternate their background-color between black and grey. The battery module is usually on grey background. If I were to simply delete that, I would now have two modules on black background. To avoid this, I define a pseudo-module custom/pseudobat
that simply shows a static image and calls wlogout
on right click. This wastes a little bit of screen space, but that is a price I am willing to pay for consistency.
The most part of this configuration is done here: Waybar
{ lib, config, ... }: let generateIcons = n: lib.concatStringsSep " " (builtins.map (x: "{icon" + toString x + "}") (lib.range 0 (n - 1))); in { options.swarselsystems.cpuString = lib.mkOption { type = lib.types.str; default = generateIcons config.swarselsystems.cpuCount; description = "The generated icons string for use by Waybar."; internal = true; }; options.swarselsystems.waybarModules = lib.mkOption { type = lib.types.listOf lib.types.str; default = [ "custom/outer-left-arrow-dark" "mpris" "custom/left-arrow-light" "network" "custom/vpn" "custom/left-arrow-dark" "pulseaudio" "custom/left-arrow-light" "custom/pseudobat" "battery" "custom/left-arrow-dark" "group/hardware" "custom/left-arrow-light" "clock#2" "custom/left-arrow-dark" "clock#1" ]; }; }
3.2.3.2.4. Monitors
This allows me to define my monitors in the machine's default.nix
.
{ lib, ... }: { options.swarselsystems.monitors = lib.mkOption { type = lib.types.attrsOf (lib.types.attrsOf lib.types.str); default = { }; }; options.swarselsystems.sharescreen = lib.mkOption { type = lib.types.str; default = ""; }; options.swarselsystems.lowResolution = lib.mkOption { type = lib.types.str; default = ""; }; options.swarselsystems.highResolution = lib.mkOption { type = lib.types.str; default = ""; }; }
3.2.3.2.5. Input
This allows me to configure input options. Here, I am globally defining my split keyboards. Then, I am joining some attribute sets so that they can be easier used in the rest of the configurations.
{ lib, config, ... }: { options.swarselsystems.inputs = lib.mkOption { type = lib.types.attrsOf (lib.types.attrsOf lib.types.str); default = { }; }; options.swarselsystems.kyria = lib.mkOption { type = lib.types.attrsOf (lib.types.attrsOf lib.types.str); default = { "36125:53060:splitkb.com_splitkb.com_Kyria_rev3" = { xkb_layout = "us"; xkb_variant = "altgr-intl"; }; "7504:24926:Kyria_Keyboard" = { xkb_layout = "us"; xkb_variant = "altgr-intl"; }; }; }; options.swarselsystems.touchpad = lib.mkOption { type = lib.types.attrsOf (lib.types.attrsOf lib.types.str); default = { }; }; options.swarselsystems.standardinputs = lib.mkOption { type = lib.types.attrsOf (lib.types.attrsOf lib.types.str); default = lib.recursiveUpdate (lib.recursiveUpdate config.swarselsystems.touchpad config.swarselsystems.kyria) config.swarselsystems.inputs; internal = true; }; options.swarselsystems.keybindings = lib.mkOption { type = lib.types.attrsOf lib.types.str; default = { }; }; options.swarselsystems.shellAliases = lib.mkOption { type = lib.types.attrsOf lib.types.str; default = { }; }; }
3.2.3.2.6. Nixos
These are some extra options that will be used if the machine also runs NixOS. For example, non-NixOS hosts need nixGL
prepended to most graphic commands, and swayfx
works less nicely on these machines.
{ lib, config, ... }: { options.swarselsystems.flakePath = lib.mkOption { type = lib.types.str; default = ""; }; options.swarselsystems.isNixos = lib.mkEnableOption "nixos host"; options.swarselsystems.isPublic = lib.mkEnableOption "is a public machine (no secrets)"; config.swarselsystems.startup = lib.mkIf (!config.swarselsystems.isNixos) [ { command = "sleep 60 && nixGL nextcloud --background"; } { command = "sleep 60 && nixGL vesktop --start-minimized -enable-features=UseOzonePlatform -ozone-platform=wayland"; } { command = "sleep 60 && nixGL syncthingtray --wait"; } { command = "sleep 60 && ANKI_WAYLAND=1 nixGL anki"; } { command = "nm-applet --indicator"; } { command = "sleep 60 && OBSIDIAN_USE_WAYLAND=1 nixGL obsidian -enable-features=UseOzonePlatform -ozone-platform=wayland"; } { command = "sleep 60 && element-desktop --hidden -enable-features=UseOzonePlatform -ozone-platform=wayland --disable-gpu-driver-bug-workarounds"; } ]; options.swarselsystems.swayfxConfig = lib.mkOption { type = lib.types.str; default = " blur enable blur_xray disable blur_passes 1 blur_radius 1 shadows enable corner_radius 2 titlebar_separator disable default_dim_inactive 0.02 "; internal = true; }; config.swarselsystems.swayfxConfig = lib.mkIf (!config.swarselsystems.isNixos) " "; }
3.2.3.2.7. setup
Provides settings related to nix-darwin systems. At the moment, I am only making use of a isDarwin
flag.
{ lib, ... }: { options.swarselsystems.isDarwin = lib.mkEnableOption "darwin host"; options.swarselsystems.isLinux = lib.mkEnableOption "whether this is a linux machine"; }
3.2.3.2.8. System startup
This defines programs I want to have starting when I start the system
Part of the startup is also defined in Sway. The distinction is as follows. As this configuration also needs to work on systems that are running only home manager, I probably need to run nixGL or something similar on those systems to get these graphic apps to display properly. In this section we only define such graphical programs, in the other location we only put shell applications and such.
These other apps currently include:
- spotifytui
- kitty
Do not that syncthingtray
is also not mentioned here. It is installed as a home manager package that automatically starts at system start.
{ lib, ... }: { options.swarselsystems.startup = lib.mkOption { type = lib.types.listOf (lib.types.attrsOf lib.types.str); default = [ { command = "nextcloud --background"; } { command = "vesktop --start-minimized --enable-speech-dispatcher --ozone-platform-hint=auto --enable-features=WaylandWindowDecorations --enable-wayland-ime"; } { command = "element-desktop --hidden --enable-features=UseOzonePlatform --ozone-platform=wayland --disable-gpu-driver-bug-workarounds"; } { command = "ANKI_WAYLAND=1 anki"; } { command = "OBSIDIAN_USE_WAYLAND=1 obsidian"; } { command = "nm-applet"; } { command = "feishin"; } ]; }; }
3.2.3.2.9. Wallpaper
Again, I set the wallpaper here for stylix
.
{ self, lib, ... }: { options.swarselsystems.wallpaper = lib.mkOption { type = lib.types.path; default = self + /wallpaper/lenovowp.png; }; }
3.2.3.2.10. Filesystem
Another duplicated option for the filesystem.
{ lib, ... }: { options.swarselsystems.isBtrfs = lib.mkEnableOption "use btrfs filesystem"; }
3.2.3.2.11. firefox
At work I am using several services that are using SSO login - however, as I am using four different accounts at work, this becomes a chore here. Hence, I have defined multiple profiles in Work that are all practically using the same configuration. To save screen space, I template that profile here.
Set in firefox about:config > toolkit.legacyUserProfileCustomizations.stylesheets
to true. This should in principle be set automatically using the below config, but it seems not to be working reliably
{ self, lib, pkgs, ... }: let lock-false = { Value = false; Status = "locked"; }; lock-true = { Value = true; Status = "locked"; }; in { options.swarselsystems.firefox = lib.mkOption { type = lib.types.attrs; default = { isDefault = false; userChrome = builtins.readFile "${self}/programs/firefox/chrome/userChrome.css"; extensions = { packages = with pkgs.nur.repos.rycee.firefox-addons; [ tridactyl tampermonkey sidebery browserpass clearurls darkreader enhancer-for-youtube istilldontcareaboutcookies translate-web-pages ublock-origin reddit-enhancement-suite sponsorblock web-archives onepassword-password-manager single-file widegithub enhanced-github unpaywall don-t-fuck-with-paste plasma-integration (buildFirefoxXpiAddon { pname = "shortkeys"; version = "4.0.2"; addonId = "Shortkeys@Shortkeys.com"; url = "https://addons.mozilla.org/firefox/downloads/file/3673761/shortkeys-4.0.2.xpi"; sha256 = "c6fe12efdd7a871787ac4526eea79ecc1acda8a99724aa2a2a55c88a9acf467c"; meta = with lib; { description = "Easily customizable custom keyboard shortcuts for Firefox. To configure this addon go to Addons (ctrl+shift+a) ->Shortkeys ->Options. Report issues here (please specify that the issue is found in Firefox): https://github.com/mikecrittenden/shortkeys"; mozPermissions = [ "tabs" "downloads" "clipboardWrite" "browsingData" "storage" "bookmarks" "sessions" "<all_urls>" ]; platforms = platforms.all; }; }) ]; }; settings = { "extensions.autoDisableScopes" = 0; "browser.bookmarks.showMobileBookmarks" = lock-true; "toolkit.legacyUserProfileCustomizations.stylesheets" = lock-true; "browser.search.suggest.enabled" = lock-false; "browser.search.suggest.enabled.private" = lock-false; "browser.urlbar.suggest.searches" = lock-false; "browser.urlbar.showSearchSuggestionsFirst" = lock-false; "browser.topsites.contile.enabled" = lock-false; "browser.newtabpage.activity-stream.feeds.section.topstories" = lock-false; "browser.newtabpage.activity-stream.feeds.snippets" = lock-false; "browser.newtabpage.activity-stream.section.highlights.includePocket" = lock-false; "browser.newtabpage.activity-stream.section.highlights.includeBookmarks" = lock-false; "browser.newtabpage.activity-stream.section.highlights.includeDownloads" = lock-false; "browser.newtabpage.activity-stream.section.highlights.includeVisited" = lock-false; "browser.newtabpage.activity-stream.showSponsored" = lock-false; "browser.newtabpage.activity-stream.system.showSponsored" = lock-false; "browser.newtabpage.activity-stream.showSponsoredTopSites" = lock-false; }; search = { default = "Kagi"; privateDefault = "Kagi"; engines = { "Kagi" = { urls = [{ template = "https://kagi.com/search"; params = [ { name = "q"; value = "{searchTerms}"; } ]; }]; iconUpdateURL = "https://kagi.com/favicon.ico"; updateInterval = 24 * 60 * 60 * 1000; # every day definedAliases = [ "@k" ]; }; "Nix Packages" = { urls = [{ template = "https://search.nixos.org/packages"; params = [ { name = "type"; value = "packages"; } { name = "query"; value = "{searchTerms}"; } ]; }]; icon = "${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg"; definedAliases = [ "@np" ]; }; "NixOS Wiki" = { urls = [{ template = "https://nixos.wiki/index.php?search={searchTerms}"; }]; iconUpdateURL = "https://nixos.wiki/favicon.png"; updateInterval = 24 * 60 * 60 * 1000; # every day definedAliases = [ "@nw" ]; }; "NixOS Options" = { urls = [{ template = "https://search.nixos.org/options"; params = [ { name = "query"; value = "{searchTerms}"; } ]; }]; icon = "${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg"; definedAliases = [ "@no" ]; }; "Home Manager Options" = { urls = [{ template = "https://home-manager-options.extranix.com/"; params = [ { name = "query"; value = "{searchTerms}"; } ]; }]; icon = "${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg"; definedAliases = [ "@hm" "@ho" "@hmo" ]; }; "Google".metaData.alias = "@g"; }; force = true; # this is required because otherwise the search.json.mozlz4 symlink gets replaced on every firefox restart }; }; }; }
3.2.3.2.12. stylix
{ self, lib, pkgs, ... }: { options.swarselsystems.stylix = lib.mkOption { type = lib.types.attrs; default = { enable = true; base16Scheme = "${self}/programs/stylix/swarsel.yaml"; polarity = "dark"; opacity.popups = 0.5; cursor = { package = pkgs.banana-cursor; # package = pkgs.capitaine-cursors; name = "Banana"; # name = "capitaine-cursors"; size = 16; }; fonts = { sizes = { terminal = 10; applications = 11; }; serif = { # package = (pkgs.nerdfonts.override { fonts = [ "FiraMono" "FiraCode"]; }); package = pkgs.cantarell-fonts; # package = pkgs.montserrat; name = "Cantarell"; # name = "FiraCode Nerd Font Propo"; # name = "Montserrat"; }; sansSerif = { # package = (pkgs.nerdfonts.override { fonts = [ "FiraMono" "FiraCode"]; }); package = pkgs.cantarell-fonts; # package = pkgs.montserrat; name = "Cantarell"; # name = "FiraCode Nerd Font Propo"; # name = "Montserrat"; }; monospace = { package = pkgs.nerd-fonts.fira-mono; # has overrides name = "FiraCode Nerd Font Mono"; }; emoji = { package = pkgs.noto-fonts-emoji; name = "Noto Color Emoji"; }; }; }; }; }
3.2.4. Library functions
This section defines all functions of my own that I add to lib
. These are used in all places over the config, with many of them being used in flake.nix
.
A breakdown of each function:
The interesting part is in the start:
- first, I define
pkgsFor
. This function reads all available systems from nixpkgs and generates pkgs for them. - next,
forEachSystem
is a function that can be called to declare an output for each such defined system. forAllSystems
is a crude function that I use for expressions that depend onsystem
, as the prior two attributes already consumed it at that stage. This is only really used to generate the checks in their own file.mkFullHostConfigs
is the function that dynamically creates all definded hosts. The hosts are defined by placing a directory inhosts/
under either thenixos/
ordarwin/
directory. These directories are being read byreadHosts
and delivered to this funtion in the later call in nixosConfigurations or darwinConfigurations.mkFullHost
: This is a function that takes a hostname as well as a boolean whether it is NixOS or not, and returns a matchingnixosSystem
ordarwinSystem
. This function is only used for systems that can use both NixOS and home-manager options (darwin still counts here as it can use some NixOS options). This is used in mkFullHostConfigs. In more detail, it dynamically creates a nixosConfiguration host, setting itsspeciaArgs
andmodules
attributes. The modules are populated based on whether this is a NixOS or darwin host. For the latter, I will only ever use machines that I get for testing from work, and for these my username is different, so I implemented an if-condition for it. This could be done more cleanly using variables, but some care needs to be taken with the home-manager imports and this approach works, so for now this is fine. Thanks to this function, the import sections of the host configs are pretty clean for most hosts.lib.optionals
evaluates to an empty list ([]
) in case that the conditional is not met.
TODO
{ self, lib, systems, inputs, outputs, ... }: { mkIfElseList = p: yes: no: lib.mkMerge [ (lib.mkIf p yes) (lib.mkIf (!p) no) ]; mkIfElse = p: yes: no: if p then yes else no; forAllSystems = lib.genAttrs [ "x86_64-linux" "aarch64-linux" "x86_64-darwin" "aarch64-darwin" ]; pkgsFor = lib.genAttrs (import systems) (system: import inputs.nixpkgs { inherit system; config.allowUnfree = true; } ); forEachSystem = f: lib.genAttrs (import systems) (system: f lib.swarselsystems.pkgsFor.${system}); mkFullHost = host: type: { ${host} = let systemFunc = if (type == "nixos") then lib.nixosSystem else inputs.nix-darwin.lib.darwinSystem; in systemFunc { specialArgs = { inherit inputs outputs lib self; }; modules = [ # put inports here that are for all hosts inputs.disko.nixosModules.disko inputs.sops-nix.nixosModules.sops inputs.impermanence.nixosModules.impermanence inputs.lanzaboote.nixosModules.lanzaboote "${self}/hosts/${type}/${host}" ] ++ (if (host == "toto" || host == "iso") then [ ] else ([ # put nixos imports here that are for all servers and normal hosts inputs.nix-topology.nixosModules.default ] ++ (if (host == "winters" || host == "sync") then [ ] else [ # put nixos imports here that are for all normal hosts "${self}/profiles/${type}/common" inputs.stylix.nixosModules.stylix inputs.nswitch-rcm-nix.nixosModules.nswitch-rcm ]) ++ (if (type == "nixos") then [ inputs.home-manager.nixosModules.home-manager { home-manager.users.swarsel.imports = ( if (host == "winters" || host == "sync") then [ ] else [ # put home-manager imports here that are for all normal hosts "${self}/profiles/home/common" ] ) ++ [ # put home-manager imports here that are for all servers and normal hosts inputs.sops-nix.homeManagerModules.sops inputs.nix-index-database.hmModules.nix-index ] ++ (builtins.attrValues outputs.homeModules); } ] else [ # put nixos imports here that are for darwin hosts "${self}/profiles/darwin/nixos/common" inputs.home-manager.darwinModules.home-manager { home-manager.users."leon.schwarzaeugl".imports = [ # put home-manager imports here that are for darwin hosts "${self}/profiles/darwin/home" ] ++ (builtins.attrValues outputs.homeModules); } ]) ++ (builtins.attrValues outputs.nixosModules) ++ (builtins.attrValues outputs.homeModules) )); }; }; mkHalfHost = host: type: pkgs: { ${host} = let systemFunc = if (type == "home") then inputs.home-manager.lib.homeManagerConfiguration else inputs.nix-on-droid.lib.nixOnDroidConfiguration; in systemFunc { inherit pkgs; extraSpecialArgs = { inherit inputs outputs lib self; }; modules = [ "${self}/hosts/${type}/${host}" ]; }; }; mkFullHostConfigs = hosts: type: lib.foldl (acc: set: acc // set) { } (lib.map (host: lib.swarselsystems.mkFullHost host type) hosts); mkHalfHostConfigs = hosts: type: pkgs: lib.foldl (acc: set: acc // set) { } (lib.map (host: lib.swarselsystems.mkHalfHost host type pkgs) hosts); readHosts = type: lib.attrNames (builtins.readDir "${self}/hosts/${type}"); readNix = type: lib.filter (name: name != "default.nix") (lib.attrNames (builtins.readDir "${self}/${type}")); mkApps = system: names: self: builtins.listToAttrs (map (name: { inherit name; value = { type = "app"; program = "${self.packages.${system}.${name}}/bin/${name}"; }; }) names); mkPackages = names: pkgs: builtins.listToAttrs (map (name: { inherit name; value = pkgs.callPackage "${self}/pkgs/${name}" { inherit self name; }; }) names); mkModules = names: type: builtins.listToAttrs (map (name: { inherit name; value = import "${self}/modules/${type}/${name}"; }) names); mkTemplates = names: builtins.listToAttrs (map (name: { inherit name; value = { path = "${self}/templates/${name}"; description = "${name} project "; }; }) names); mkImports = names: baseDir: lib.map (name: "${self}/${baseDir}/${name}") names; eachMonitor = _: monitor: { inherit (monitor) name; value = builtins.removeAttrs monitor [ "workspace" "name" "output" ]; }; eachOutput = _: monitor: { inherit (monitor) name; value = builtins.removeAttrs monitor [ "mode" "name" "scale" "transform" "position" ]; }; }
3.3. NixOS
Here we have NixOS options. All options are split into smaller files that are loaded by the general default.nix
. Common files are used by all user hosts equally, optionals need to be added to the machine's default.nix
on a case-by-case basis.
3.3.1. Common
These are system-level settings specific to NixOS machines. All settings that are required on all machines go here.
3.3.1.1. Imports, non-server settings
This section is for setting things that should be used on hosts that are using the default NixOS configuration. This means that servers should NOT import this, as much of these imported modules are user-configured.
{ lib, ... }: let importNames = lib.swarselsystems.readNix "profiles/nixos/common"; in { imports = lib.swarselsystems.mkImports importNames "profiles/nixos/common"; nixpkgs.config.permittedInsecurePackages = [ "jitsi-meet-1.0.8043" "electron-29.4.6" "SDL_ttf-2.0.11" ]; }
3.3.1.2. General NixOS settings (stateVersion)
We disable the warnings that trigger when rebuilding with a dirty flake. At this point, I am also disabling channels and pinning the flake registry - the latter lets me use the local version of nixpkgs for commands like nix shell
(without it, we will always download the newest version of nixpkgs for these commands).
Also, the system state version is set here. No need to touch it.
A breakdown of the flags being set:
nixpgks.config.allowUnfree
: allows packages with an unfree license to be built- nix.settings:
- experimental-features:
- nix-command: Enables the
nix
command from nix 2.4 - flakes: Enables flakes to be used
- ca-derivations: Enables content-addressed derivations, which stops unnecessary rebuiluds - to be used with my TODO private hydra and the binary cache
cache.ngi0.nixos.org
in flake.nix template - cgroups: allows the use of cgroups in builds
- pipe-operators: Enables 'piping' instead of the classic currying syntax -
fun arg
can be expressed asarg |> fun
. Associatively, it is weaker than functions:a |> b |> d c |> e = e ((d c) (b a))
- nix-command: Enables the
- trusted-users: these users have elevated privileges in nix (mostly used to acknowledge binary caches) - root is added per default here
- connect-timeout: normally, nix tries to reach the cache for 300 seconds for each derivation per cache. This setting lets me change that
- bash-prompt-prefix: adds a prefix to shells spawned by
nix develop
- [min,max]-free: amounts of space where intermittent GC will be run during builds
- flake registry: URI of the global flake registry (I disable it)
- auto-optimise-store: create hardlinks in the nix store to save space
- warn-dirty: I do not need to see the warning when I have uncommited changes
- max-jobs: How many build jobs should be run in parallel.
auto
sets this to the number of CPUs (which is all) - on systems with many cores this can lead to OOM situations. The default is now1
, but used to beauto
, I set this manually just to be safe in the future. - use-cgroups: Actually run builds within cgroups
- experimental-features:
- nix.channel.enable: whether to use channels
- nix.registry: Sets the registry for this flake, which I set to its inputs. This allows me to use e.g.
nixpkgs
directly innix repl
- nix.nixPath: Basically the same as
nix.registry
, but for the legacy nix commands
{ lib, config, outputs, inputs, ... }: { nixpkgs = { overlays = [ outputs.overlays.default ]; config = { allowUnfree = true; }; }; nix = let flakeInputs = lib.filterAttrs (_: lib.isType "flake") inputs; in { settings = { experimental-features = [ "nix-command" "flakes" "ca-derivations" "cgroups" "pipe-operators" ]; trusted-users = [ "@wheel" "swarsel" ]; connect-timeout = 5; bash-prompt-prefix = "[33m$SHLVL:\\w [0m"; bash-prompt = "$(if [[ $? -gt 0 ]]; then printf \"[31m\"; else printf \"[32m\"; fi)\[\e[1m\]λ\[\e[0m\] [0m"; fallback = true; min-free = 128000000; max-free = 1000000000; flake-registry = ""; auto-optimise-store = true; warn-dirty = false; max-jobs = 1; use-cgroups = lib.mkIf config.swarselsystems.isLinux true; }; channel.enable = false; registry = lib.mapAttrs (_: flake: { inherit flake; }) flakeInputs; nixPath = lib.mapAttrsToList (n: _: "${n}=flake:${n}") flakeInputs; }; system.stateVersion = lib.mkDefault "23.05"; }
3.3.1.3. System Packages
Mostly used to install some compilers and lsp's that I want to have available when not using a devShell flake. Most other packages should go in Installed packages.
{ pkgs, ... }: { environment.systemPackages = with pkgs; [ # yubikey packages gnupg yubikey-personalization yubikey-personalization-gui yubico-pam yubioath-flutter yubikey-manager yubikey-manager-qt yubikey-touch-detector yubico-piv-tool cfssl pcsctools pcscliteWithPolkit.out # ledger packages ledger-live-desktop # pinentry dbus swaylock-effects syncthingtray-minimal # secure boot sbctl libsForQt5.qt5.qtwayland # nix package database nix-index nixos-generators # commit hooks pre-commit # proc info acpi # better make for general tasks just # keyboards qmk vial via # theme related adwaita-icon-theme # kde-connect xdg-desktop-portal xdg-desktop-portal-wlr # bluetooth bluez # lsp-related ------------------------------- # nix # latex # texlab ghostscript_headless # wireguard wireguard-tools # rust # rust-analyzer # clippy # rustfmt # go # go # gopls # nix nixd # zig zig zls # cpp # clang-tools # + cuda # cudatoolkit # ansible # ansible-lint ansible-language-server # molecule #lsp-bridge / python # gcc # gdb # (python3.withPackages (ps: with ps; [ jupyter ipython pyqt5 epc orjson sexpdata six setuptools paramiko numpy pandas scipy matplotlib requests debugpy flake8 gnureadline python-lsp-server ])) # (python3.withPackages(ps: with ps; [ jupyter ipython pyqt5 numpy pandas scipy matplotlib requests debugpy flake8 gnureadline python-lsp-server])) # -------------------------------------------- # (stdenv.mkDerivation { # name = "oama"; # src = pkgs.fetchurl { # name = "oama"; # url = "https://github.com/pdobsan/oama/releases/download/0.13.1/oama-0.13.1-Linux-x86_64-static.tgz"; # sha256 = "sha256-OTdCObVfnMPhgZxVtZqehgUXtKT1iyqozdkPIV+i3Gc="; # }; # phases = [ # "unpackPhase" # ]; # unpackPhase = '' # mkdir -p $out/bin # tar xvf $src -C $out/ # mv $out/oama-0.13.1-Linux-x86_64-static/oama $out/bin/ # ''; # }) ]; }
3.3.1.4. Setup home-manager
We enable the use of home-manager
as a NixoS module. A nice trick here is the extraSpecialArgs = inputs
line, which enables the use of seflf
in most parts of the configuration. This is useful to refer to the root of the flake (which is otherwise quite hard while maintaining flake purity).
{ inputs, config, lib, ... }: { home-manager = lib.mkIf config.swarselsystems.withHomeManager { useGlobalPkgs = true; useUserPackages = true; extraSpecialArgs = inputs; # used mainly for inputs.self }; }
3.3.1.5. Setup login keymap
Next, we setup the keymap in case we are not in a graphical session. At this point, I always resort to us/altgr-intl, as it is comfortable to use and I do not write too much German anyways.
_: { services.xserver = { xkb = { layout = "us"; variant = "altgr-intl"; }; }; }
3.3.1.6. User setup, Make users non-mutable
This ensures that all user-configuration happens here in the config file. In case of using a fully setup system, this makes also sure that no further user level modifications can be made using CLI utilities (e.g. usermod etc.). Everything must be defined in the flake.
For that reason, make sure that sops-nix
is properly working before setting the initialSetup
flag, otherwise you might lose user access.
{ pkgs, config, lib, ... }: { sops.secrets.swarseluser = lib.mkIf (!config.swarselsystems.isPublic) { neededForUsers = true; }; users = { mutableUsers = lib.mkIf (!config.swarselsystems.initialSetup) false; users.swarsel = { isNormalUser = true; description = "Leon S"; password = lib.mkIf config.swarselsystems.initialSetup "setup"; hashedPasswordFile = lib.mkIf (!config.swarselsystems.initialSetup) config.sops.secrets.swarseluser.path; extraGroups = [ "networkmanager" "syncthing" "docker" "wheel" "lp" "audio" "video" "vboxusers" "libvirtd" "scanner" ]; packages = with pkgs; [ ]; }; }; }
3.3.1.7. Environment setup
Next, we will setup some environment variables that need to be set on the system-side. We apply some compatibility options for chromium apps on wayland, enable the wordlist and make metadata reading possible for my file explorer (nautilus).
{ lib, pkgs, ... }: { environment = { wordlist.enable = true; sessionVariables = { NIXOS_OZONE_WL = "1"; GST_PLUGIN_SYSTEM_PATH_1_0 = lib.makeSearchPathOutput "lib" "lib/gstreamer-1.0" (with pkgs.gst_all_1; [ gst-plugins-good gst-plugins-bad gst-plugins-ugly gst-libav ]); }; }; # gstreamer plugins for nautilus (used for file metadata) }
3.3.1.8. Security
Needed for control over system-wide privileges etc. Also I make sure that the root user has access to SSH_AUTH_SOCK
(without this, root will not be able to read my nix-secrets
repository).
_: { security.pam.services = { login.u2fAuth = true; sudo.u2fAuth = true; swaylock.u2fAuth = true; swaylock.fprintAuth = false; }; security.polkit.enable = true; security.sudo.extraConfig = '' Defaults env_keep+=SSH_AUTH_SOCK ''; }
3.3.1.9. Enable automatic garbage collection
The nix store fills up over time, until /boot/efi
is filled. This snippet cleans it automatically on a weekly basis.
_: { nix.gc = { automatic = true; randomizedDelaySec = "14m"; dates = "weekly"; options = "--delete-older-than 10d"; }; }
3.3.1.10. Enable automatic store optimisation
This enables hardlinking identical files in the nix store, to save on disk space. I have read this incurs a significant I/O overhead, I need to keep an eye on this.
_: { nix.optimise = { automatic = true; dates = [ "weekly" ]; }; }
3.3.1.11. Reduce systemd timeouts
There is a persistent bug over Linux kernels that makes the user wait 1m30s on system shutdown due to the reason a stop job is running for session 1 of user ...
. I do not want to wait that long and am confident no important data is lost by doing this.
_: { # systemd systemd.extraConfig = '' DefaultTimeoutStartSec=60s DefaultTimeoutStopSec=15s ''; }
3.3.1.12. Hardware settings
Enable OpenGL, Sound, Bluetooth and various drivers.
{ pkgs, config, lib, ... }: { hardware = { # opengl.driSupport32Bit = true is replaced with graphics.enable32Bit and hence redundant graphics = { enable = true; enable32Bit = true; }; trackpoint = lib.mkIf config.swarselsystems.trackpoint.isAvailable { enable = true; inherit (config.swarselsystems.trackpoint) device; }; keyboard.qmk.enable = true; enableAllFirmware = true; bluetooth = lib.mkIf config.swarselsystems.hasBluetooth { enable = true; package = pkgs.stable.bluez; powerOnBoot = true; settings = { General = { Enable = "Source,Sink,Media,Socket"; }; }; }; }; services.fprintd.enable = lib.mkIf config.swarselsystems.hasFingerprint true; }
3.3.1.13. Pulseaudio
This is only used on systems not running Pipewire.
{ config, pkgs, lib, ... }: { services.pulseaudio = { enable = lib.mkIf (!config.services.pipewire.enable) true; package = pkgs.pulseaudioFull; }; }
3.3.1.14. Pipewire
Pipewire handles communication on Wayland. This enables several sound tools as well as screen sharing in combinaton with xdg-desktop-portal-wlr
.
_: { security.rtkit.enable = true; # this is required for pipewire real-time access services.pipewire = { enable = true; pulse.enable = true; jack.enable = true; audio.enable = true; wireplumber.enable = true; alsa = { enable = true; support32Bit = true; }; }; }
3.3.1.15. Common network settings
Here I only enable networkmanager
and a few default networks. The rest of the network config is done separately in System specific configuration.
{ lib, config, ... }: { networking = { nftables.enable = lib.mkDefault true; enableIPv6 = lib.mkDefault true; firewall = { checkReversePath = lib.mkDefault false; enable = lib.mkDefault true; allowedUDPPorts = [ 51820 ]; # 51820: wireguard allowedTCPPortRanges = [ { from = 1714; to = 1764; } # kde-connect ]; allowedUDPPortRanges = [ { from = 1714; to = 1764; } # kde-connect ]; }; networkmanager = { enable = true; ensureProfiles = lib.mkIf (!config.swarselsystems.isPublic) { environmentFiles = [ "${config.sops.templates."network-manager.env".path}" ]; profiles = { "Ernest Routerford" = { connection = { id = "Ernest Routerford"; permissions = ""; type = "wifi"; }; ipv4 = { dns-search = ""; method = "auto"; }; ipv6 = { addr-gen-mode = "stable-privacy"; dns-search = ""; method = "auto"; }; wifi = { mac-address-blacklist = ""; mode = "infrastructure"; ssid = "Ernest Routerford"; }; wifi-security = { auth-alg = "open"; key-mgmt = "wpa-psk"; psk = "$ERNEST"; }; }; LAN-Party = { connection = { autoconnect = "false"; id = "LAN-Party"; type = "ethernet"; }; ethernet = { auto-negotiate = "true"; cloned-mac-address = "preserve"; mac-address = "90:2E:16:D0:A1:87"; }; ipv4 = { method = "shared"; }; ipv6 = { addr-gen-mode = "stable-privacy"; method = "auto"; }; proxy = { }; }; eduroam = { "802-1x" = { eap = "ttls;"; identity = "$EDUID"; password = "$EDUPASS"; phase2-auth = "mschapv2"; }; connection = { id = "eduroam"; type = "wifi"; }; ipv4 = { method = "auto"; }; ipv6 = { addr-gen-mode = "default"; method = "auto"; }; proxy = { }; wifi = { mode = "infrastructure"; ssid = "eduroam"; }; wifi-security = { auth-alg = "open"; key-mgmt = "wpa-eap"; }; }; local = { connection = { autoconnect = "false"; id = "local"; type = "ethernet"; }; ethernet = { }; ipv4 = { address1 = "10.42.1.1/24"; method = "shared"; }; ipv6 = { addr-gen-mode = "stable-privacy"; method = "auto"; }; proxy = { }; }; HH40V_39F5 = { connection = { id = "HH40V_39F5"; type = "wifi"; }; ipv4 = { method = "auto"; }; ipv6 = { addr-gen-mode = "stable-privacy"; method = "auto"; }; proxy = { }; wifi = { band = "bg"; mode = "infrastructure"; ssid = "HH40V_39F5"; }; wifi-security = { key-mgmt = "wpa-psk"; psk = "$FRAUNS"; }; }; magicant = { connection = { id = "magicant"; type = "wifi"; }; ipv4 = { method = "auto"; }; ipv6 = { addr-gen-mode = "default"; method = "auto"; }; proxy = { }; wifi = { mode = "infrastructure"; ssid = "magicant"; }; wifi-security = { auth-alg = "open"; key-mgmt = "wpa-psk"; psk = "$HANDYHOTSPOT"; }; }; wireguardvpn = { connection = { id = "HomeVPN"; type = "wireguard"; autoconnect = "false"; interface-name = "wg1"; }; wireguard = { private-key = "$WIREGUARDPRIV"; }; "wireguard-peer.$WIREGUARDPUB" = { endpoint = "$WIREGUARDENDPOINT"; allowed-ips = "0.0.0.0/0"; }; ipv4 = { method = "ignore"; address1 = "192.168.3.3/32"; }; ipv6 = { addr-gen-mode = "stable-privacy"; method = "ignore"; }; proxy = { }; }; "sweden-aes-128-cbc-udp-dns" = { connection = { autoconnect = "false"; id = "PIA Sweden"; type = "vpn"; }; ipv4 = { method = "auto"; }; ipv6 = { addr-gen-mode = "stable-privacy"; method = "auto"; }; proxy = { }; vpn = { auth = "sha1"; ca = config.sops.secrets."sweden-aes-128-cbc-udp-dns-ca.pem".path; challenge-response-flags = "2"; cipher = "aes-128-cbc"; compress = "yes"; connection-type = "password"; crl-verify-file = config.sops.secrets."sweden-aes-128-cbc-udp-dns-crl-verify.pem".path; dev = "tun"; password-flags = "0"; remote = "sweden.privacy.network:1198"; remote-cert-tls = "server"; reneg-seconds = "0"; service-type = "org.freedesktop.NetworkManager.openvpn"; username = "$VPNUSER"; }; vpn-secrets = { password = "$VPNPASS"; }; }; Hotspot = { connection = { autoconnect = "false"; id = "Hotspot"; type = "wifi"; }; ipv4 = { method = "shared"; }; ipv6 = { addr-gen-mode = "default"; method = "ignore"; }; proxy = { }; wifi = { mode = "ap"; ssid = "Hotspot-swarsel"; }; wifi-security = { group = "ccmp;"; key-mgmt = "wpa-psk"; pairwise = "ccmp;"; proto = "rsn;"; psk = "$HOTSPOT"; }; }; }; }; }; }; systemd.services.NetworkManager-ensure-profiles.after = [ "NetworkManager.service" ]; }
3.3.1.16. Time, locale settings
Setup timezone and locale. I want to use the US layout, but have the rest adapted to my country and timezone. Also, there is an issue with running Windows/Linux dualboot on the same machine where the hardware clock desyncs between the two OS'es. We fix that bug here as well.
_: { time = { timeZone = "Europe/Vienna"; # hardwareClockInLocalTime = true; }; i18n = { defaultLocale = "en_US.UTF-8"; extraLocaleSettings = { LC_ADDRESS = "de_AT.UTF-8"; LC_IDENTIFICATION = "de_AT.UTF-8"; LC_MEASUREMENT = "de_AT.UTF-8"; LC_MONETARY = "de_AT.UTF-8"; LC_NAME = "de_AT.UTF-8"; LC_NUMERIC = "de_AT.UTF-8"; LC_PAPER = "de_AT.UTF-8"; LC_TELEPHONE = "de_AT.UTF-8"; LC_TIME = "de_AT.UTF-8"; }; }; }
3.3.1.17. sops
I use sops-nix to handle secrets that I want to have available on my machines at all times. Procedure to add a new machine:
- `ssh-keygen -t ed25519 -C "NAME sops"` in .ssh directory (or wherever) - name e.g. "sops"
- cat ~/.ssh/sops.pub | ssh-to-age | wl-copy
- add the output to .sops.yaml
- cp ~/.ssh/sops.pub ~/.dotfiles/secrets/keys/NAME.pub
- update entry for sops.age.sshKeyPaths
{ self, config, lib, ... }: let certsSopsFile = self + /secrets/certs/secrets.yaml; in { sops = lib.mkIf (!config.swarselsystems.isPublic) { age.sshKeyPaths = lib.swarselsystems.mkIfElseList config.swarselsystems.isBtrfs [ "/persist/.ssh/sops" "/persist/.ssh/ssh_host_ed25519_key" ] [ "${config.users.users.swarsel.home}/.ssh/sops" "/etc/ssh/ssh_host_ed25519_key" ]; defaultSopsFile = lib.swarselsystems.mkIfElseList config.swarselsystems.isBtrfs "/persist/.dotfiles/secrets/general/secrets.yaml" "${config.users.users.swarsel.home}/.dotfiles/secrets/general/secrets.yaml"; validateSopsFiles = false; secrets = { ernest = { }; frauns = { }; hotspot = { }; eduid = { }; edupass = { }; handyhotspot = { }; vpnuser = { }; vpnpass = { }; wireguardpriv = { }; wireguardpub = { }; wireguardendpoint = { }; stashuser = { }; stashpass = { }; githubforgeuser = { }; githubforgepass = { }; gitlabforgeuser = { }; gitlabforgepass = { }; "sweden-aes-128-cbc-udp-dns-crl-verify.pem" = { sopsFile = certsSopsFile; owner = "swarsel"; }; "sweden-aes-128-cbc-udp-dns-ca.pem" = { sopsFile = certsSopsFile; owner = "swarsel"; }; }; templates = { "network-manager.env".content = '' ERNEST=${config.sops.placeholder.ernest} FRAUNS=${config.sops.placeholder.frauns} HOTSPOT=${config.sops.placeholder.hotspot} EDUID=${config.sops.placeholder.eduid} EDUPASS=${config.sops.placeholder.edupass} HANDYHOTSPOT=${config.sops.placeholder.handyhotspot} VPNUSER=${config.sops.placeholder.vpnuser} VPNPASS=${config.sops.placeholder.vpnpass} WIREGUARDPRIV=${config.sops.placeholder.wireguardpriv} WIREGUARDPUB=${config.sops.placeholder.wireguardpub} WIREGUARDENDPOINT=${config.sops.placeholder.wireguardendpoint} ''; # ".authinfo" = { # owner = "swarsel"; # path = "${config.users.users.swarsel.home}/.emacs.d/.authinfo"; # content = '' # machine stash.swarsel.win:443 port https login ${config.sops.placeholder.stashuser} password ${config.sops.placeholder.stashpass} # machine gitlab.com/api/v4 login ${config.sops.placeholder.githubforgeuser} password ${config.sops.placeholder.githubforgepass} # machine api.github.com login ${config.sops.placeholder.gitlabforgeuser} password ${config.sops.placeholder.gitlabforgepass} # ''; # }; }; }; }
3.3.1.18. Theme (stylix)
By default, stylix wants to style GRUB as well. However, I think that looks horrible.
theme
is defined in [BROKEN LINK: h:5bc1b0c9-dc59-4c81-b5b5-e60699deda78].
{ lib, config, ... }: { stylix = lib.recursiveUpdate { targets.grub.enable = false; # the styling makes grub more ugly image = config.swarselsystems.wallpaper; } config.swarselsystems.stylix; home-manager.users.swarsel = { stylix = { targets = { emacs.enable = false; waybar.enable = false; }; }; }; }
3.3.1.19. Programs (including zsh setup)
Some programs profit from being installed through dedicated NixOS settings on system-level; these go here. Notably the zsh setup goes here and cannot be deleted under any circumstances.
_: { programs = { dconf.enable = true; evince.enable = true; kdeconnect.enable = true; }; }
3.3.1.19.1. zsh
Do not touch this.
{ pkgs, ... }: { programs.zsh.enable = true; users.defaultUserShell = pkgs.zsh; environment.shells = with pkgs; [ zsh ]; environment.pathsToLink = [ "/share/zsh" ]; }
3.3.1.19.2. syncthing
{ lib, ... }: { services.syncthing = { enable = true; user = "swarsel"; dataDir = "/home/swarsel"; configDir = "/home/swarsel/.config/syncthing"; openDefaultPorts = true; settings = { devices = { "magicant" = { id = "VMWGEE2-4HDS2QO-KNQOVGN-LXLX6LA-666E4EK-ZBRYRRO-XFEX6FB-6E3XLQO"; }; "sync (@oracle)" = { id = "ETW6TST-NPK7MKZ-M4LXMHA-QUPQHDT-VTSHH5X-CR5EIN2-YU7E55F-MGT7DQB"; }; "winters" = { id = "O7RWDMD-AEAHPP7-7TAVLKZ-BSWNBTU-2VA44MS-EYGUNBB-SLHKB3C-ZSLMOAA"; }; }; folders = { "Default Folder" = lib.mkDefault { path = "/home/swarsel/Sync"; devices = [ "sync (@oracle)" "magicant" "winters" ]; id = "default"; }; "Obsidian" = { path = "/home/swarsel/Nextcloud/Obsidian"; devices = [ "sync (@oracle)" "magicant" "winters" ]; id = "yjvni-9eaa7"; }; "Org" = { path = "/home/swarsel/Nextcloud/Org"; devices = [ "sync (@oracle)" "magicant" "winters" ]; id = "a7xnl-zjj3d"; }; "Vpn" = { path = "/home/swarsel/Vpn"; devices = [ "sync (@oracle)" "magicant" "winters" ]; id = "hgp9s-fyq3p"; }; ".elfeed" = { path = "/home/swarsel/.elfeed"; devices = [ "sync (@oracle)" "magicant" "winters" ]; id = "h7xbs-fs9v1"; }; }; }; }; }
3.3.1.20. Services
Setting up some hardware services as well as keyboard related settings. Here we make sure that we can use the CAPS key as a ESC/CTRL double key, which is a lifesaver.
3.3.1.20.1. blueman
Enables the blueman service including the nice system tray icon.
_: { services.blueman.enable = true; services.hardware.bolt.enable = true; }
3.3.1.20.2. Network devices
In this section we enable compatibility with several network devices I have at home, mainly printers and scanners.
This allows me to use my big scanner/printer's scanning function over the network. This also allows me to use my big scanner/printer's printing function over the network. Most of the settings are driver related. Avahi is the service used for the network discovery.
{ pkgs, ... }: { # enable scanners over network hardware.sane = { enable = true; extraBackends = [ pkgs.sane-airscan ]; }; # enable discovery and usage of network devices (esp. printers) services.printing = { enable = true; drivers = [ pkgs.gutenprint pkgs.gutenprintBin ]; browsedConf = '' BrowseDNSSDSubTypes _cups,_print BrowseLocalProtocols all BrowseRemoteProtocols all CreateIPPPrinterQueues All BrowseProtocols all ''; }; services.avahi = { enable = true; nssmdns4 = true; openFirewall = true; }; }
3.3.1.20.3. enable GVfs
This is being set to allow myself to use all functions of nautilus in NixOS
_: { services.gvfs.enable = true; }
3.3.1.20.4. interception-tools: Make CAPS work as ESC/CTRL
This is a super-convenient package that lets my remap my CAPS
key to ESC
if pressed shortly, and CTRL
if being held.
{ pkgs, ... }: { # Make CAPS work as a dual function ESC/CTRL key services.interception-tools = { enable = true; udevmonConfig = let dualFunctionKeysConfig = builtins.toFile "dual-function-keys.yaml" '' TIMING: TAP_MILLISEC: 200 DOUBLE_TAP_MILLISEC: 0 MAPPINGS: - KEY: KEY_CAPSLOCK TAP: KEY_ESC HOLD: KEY_LEFTCTRL ''; in '' - JOB: | ${pkgs.interception-tools}/bin/intercept -g $DEVNODE \ | ${pkgs.interception-tools-plugins.dual-function-keys}/bin/dual-function-keys -c ${dualFunctionKeysConfig} \ | ${pkgs.interception-tools}/bin/uinput -d $DEVNODE DEVICE: EVENTS: EV_KEY: [KEY_CAPSLOCK] ''; }; }
3.3.1.20.5. power-profiles-daemon
This enables power profile management. The available modes are:
- power-saver
- balanced
- performance
Most of the time I am using power-saver
, however, it is good to be able to choose.
_: { services.power-profiles-daemon.enable = true; }
3.3.1.21. Hardware compatibility settings (Yubikey, Ledger, Keyboards) - udev rules
It makes sense to house these settings in their own section, since they are all needed really. Note that the starting of the gpg-agent is done in the sway settings, to also perform this step of the setup for non NixOS-machines at the same time.
pcscd
is needed to use the smartcard mode (CCID) of the Yubikey.
The exception is the system packages, since that cannot be defined twice in the same file (common.nix). The comment is left in as a remider for that.
Also, this is a good place to setup the udev rules.
{ pkgs, ... }: { programs.ssh.startAgent = false; services.pcscd.enable = true; hardware.ledger.enable = true; services.udev.packages = with pkgs; [ yubikey-personalization ledger-udev-rules qmk-udev-rules vial via ]; }
3.3.1.22. System Login
This section houses the greetd related settings. I do not really want to use a display manager, but it is useful to have setup in some ways - in my case for starting sway on system startup. Notably the default user login setting that is commented out here goes into the system specific settings, make sure to update it there
{ pkgs, ... }: { services.greetd = { enable = true; settings = { initial_session.command = "sway"; # initial_session.user ="swarsel"; default_session.command = '' ${pkgs.greetd.tuigreet}/bin/tuigreet \ --time \ --asterisks \ --user-menu \ --cmd sway ''; }; }; environment.etc."greetd/environments".text = '' sway ''; }
3.3.1.23. nix-ld
This provides libraries for binaries that are not patched for use on NixOS. This really makes the biggest gripe with NixOS go away, that being having to run a binary that is only found in a single spot. It is most of the times possible to patch such a file, but this makes such a situation take much less time to resolve.
Only some binaries that touch system settings might still not work, apart from that, the list of libraries I have curated here should be quite exhaustive.
When a program does not work, start with nix-ldd <program>
. This will tell you which library is missing. Afterwards, continue with nix-locate <program>
to find which packages provide that library. Add it to libraries below and rebuild. After a reboot, it will be visible using nix-ldd
. It can also be useful to take a look at ldd
to see which libraries are needed in general.
{ pkgs, ... }: { programs.nix-ld = { enable = true; libraries = with pkgs; [ SDL SDL2 SDL2_image SDL2_mixer SDL2_ttf SDL_image SDL_mixer SDL_ttf alsa-lib at-spi2-atk at-spi2-core atk bzip2 cairo cups curl dbus dbus-glib expat ffmpeg flac fontconfig freeglut freetype fuse3 gdk-pixbuf glew110 glib stable.gnome2.GConf pango gtk2 gtk3 icu libGL libappindicator-gtk2 libappindicator-gtk3 libcaca libcanberra libcap libdbusmenu-gtk2 libdrm libelf libgcrypt libglvnd libidn libindicator-gtk2 libjpeg libmikmod libnotify libogg libpng libpng12 libpulseaudio librsvg libsamplerate libtheora libtiff libudev0-shim libunwind libusb1 libuuid libva libvdpau libvorbis libvpx libxkbcommon libxml2 libz mesa nspr nss openssl pango pipewire pixman speex stdenv.cc.cc steam-fhsenv-without-steam systemd tbb vulkan-loader xorg.libICE xorg.libSM xorg.libX11 xorg.libXScrnSaver xorg.libXcomposite xorg.libXcursor xorg.libXdamage xorg.libXext xorg.libXfixes xorg.libXft xorg.libXi xorg.libXinerama xorg.libXmu xorg.libXrandr xorg.libXrender xorg.libXt xorg.libXtst xorg.libXxf86vm xorg.libxcb xorg.libxshmfence zlib ]; }; }
3.3.1.24. Impermanence
This is where the impermanence magic happens. When this is enabled, the root directory is rolled back to a blanket state on each reboot.
Normally, doing that also resets the lecture that happens on the first use of sudo
, so we disable that at this point. Also, here we can set files to be persisted. Do note that you should still pay attention to files that need sudo access, as these need to be copied manually.
{ config, lib, ... }: let mapperTarget = lib.swarselsystems.mkIfElse config.swarselsystems.isCrypted "/dev/mapper/cryptroot" "/dev/disk/by-label/nixos"; in { security.sudo.extraConfig = lib.mkIf config.swarselsystems.isImpermanence '' # rollback results in sudo lectures after each reboot Defaults lecture = never ''; # This script does the actual wipe of the system # So if it doesn't run, the btrfs system effectively acts like a normal system # Taken from https://github.com/NotAShelf/nyx/blob/2a8273ed3f11a4b4ca027a68405d9eb35eba567b/modules/core/common/system/impermanence/default.nix boot.initrd.systemd.enable = lib.mkIf config.swarselsystems.isImpermanence true; boot.initrd.systemd.services.rollback = lib.mkIf config.swarselsystems.isImpermanence { description = "Rollback BTRFS root subvolume to a pristine state"; wantedBy = [ "initrd.target" ]; # make sure it's done after encryption # i.e. LUKS/TPM process after = lib.swarselsystems.mkIfElseList config.swarselsystems.isCrypted [ "systemd-cryptsetup@cryptroot.service" ] [ "dev-disk-by\\x2dlabel-nixos.device" ]; requires = lib.mkIf (!config.swarselsystems.isCrypted) [ "dev-disk-by\\x2dlabel-nixos.device" ]; # mount the root fs before clearing before = [ "sysroot.mount" ]; unitConfig.DefaultDependencies = "no"; serviceConfig.Type = "oneshot"; script = '' mkdir -p /mnt # We first mount the btrfs root to /mnt # so we can manipulate btrfs subvolumes. mount -o subvolid=5 -t btrfs ${mapperTarget} /mnt btrfs subvolume list -o /mnt/root # While we're tempted to just delete /root and create # a new snapshot from /root-blank, /root is already # populated at this point with a number of subvolumes, # which makes `btrfs subvolume delete` fail. # So, we remove them first. # # /root contains subvolumes: # - /root/var/lib/portables # - /root/var/lib/machines btrfs subvolume list -o /mnt/root | cut -f9 -d' ' | while read subvolume; do echo "deleting /$subvolume subvolume..." btrfs subvolume delete "/mnt/$subvolume" done && echo "deleting /root subvolume..." && btrfs subvolume delete /mnt/root echo "restoring blank /root subvolume..." btrfs subvolume snapshot /mnt/root-blank /mnt/root # Once we're done rolling back to a blank snapshot, # we can unmount /mnt and continue on the boot process. umount /mnt ''; }; environment.persistence."/persist" = lib.mkIf config.swarselsystems.isImpermanence { hideMounts = true; directories = [ "/.cache/nix" "/srv" "/etc/nixos" "/etc/nix" "/etc/NetworkManager/system-connections" # "/etc/secureboot" "/home/swarsel/.dotfiles" "/var/db/sudo" "/var/cache" "/var/lib" ]; files = [ "/etc/ssh/ssh_host_ed25519_key" "/etc/ssh/ssh_host_ed25519_key.pub" "/etc/ssh/ssh_host_rsa_key" "/etc/ssh/ssh_host_rsa_key.pub" ]; }; }
3.3.1.25. Summary of nixos-rebuild diff
This snipped is added to the activation script that is run after every rebuild and shows what packages have been added and removed. This is actually not the optimal place to add that snipped, but the correct spot is in some perl file that I have not had the leisure to take a look at yet.
{ pkgs, ... }: { system.activationScripts.diff = { supportsDryActivation = true; text = '' ${pkgs.nvd}/bin/nvd --color=always --nix-bin-dir=${pkgs.nix}/bin diff \ /run/current-system "$systemConfig" ''; }; }
3.3.1.26. gnome-keyring
Used for storing sessions in e.g. Nextcloud. Using this on a system level keeps the login information when logging out of the session as well.
_: { services.gnome.gnome-keyring = { enable = true; }; programs.seahorse.enable = true; }
3.3.1.27. Sway
This is used to better integrate Sway into the system on NixOS hosts. On the home-manager side, the package
attribute will be null
for such an host, using the systems derivation instead.
{ pkgs, ... }: { programs.sway = { enable = true; package = pkgs.swayfx; wrapperFeatures = { base = true; gtk = true; }; extraSessionCommands = '' export XDG_SESSION_DESKTOP=sway export SDL_VIDEODRIVER=wayland export QT_QPA_PLATFORM=wayland-egl export QT_WAYLAND_DISABLE_WINDOWDECORATION=1 export QT_QPA_PLATFORM_PLUGIN_PATH="${pkgs.libsForQt5.qt5.qtbase.bin}/lib/qt-${pkgs.libsForQt5.qt5.qtbase.version}/plugins"; export MOZ_ENABLE_WAYLAND=1 export MOZ_DISABLE_RDD_SANDBOX=1 ''; }; }
3.3.1.28. xdg-portal
This allows me to use screen sharing on Wayland. The implementation is a bit crude and only the whole screen can be shared. However, most of the time that is all I need to do anyways.
{ pkgs, ... }: { xdg.portal = { enable = true; config = { common = { default = "wlr"; }; }; wlr.enable = true; wlr.settings.screencast = { output_name = "eDP-1"; chooser_type = "simple"; chooser_cmd = "${pkgs.slurp}/bin/slurp -f %o -or"; }; }; }
3.3.1.29. Podmam (distrobox)
I am using distrobox to quickly circumvent isses that I cannot immediately solve on NixOS. It is always the goal to quickly get things working on NixOS, but this prevents me from getting completely stuck.
{ pkgs, ... }: { environment.systemPackages = with pkgs; [ distrobox boxbuddy ]; virtualisation.podman = { enable = true; package = pkgs.stable.podman; }; }
3.3.1.30. Handle lid switch correctly
This turns off the display when the lid is closed.
_: { services.logind = { lidSwitch = "suspend"; lidSwitchDocked = "ignore"; }; services.acpid = { enable = true; lidEventCommands = '' export PATH=$PATH:/run/current-system/sw/bin export WAYLAND_DISPLAY=wayland-1 export XDG_RUNTIME_DIR=/run/user/1000 export SWAYSOCK=$(ls /run/user/1000/sway-ipc.* | head -n 1) LID_STATE=$(cat /proc/acpi/button/lid/*/state | grep -q closed && echo "closed" || echo "open") DOCKED=$(swaymsg -t get_outputs | grep -q 'HDMI\|DP' && echo "docked" || echo "undocked") if [ "$LID_STATE" == "closed" ] && [ "$DOCKED" == "docked" ]; then swaymsg output eDP-2 disable else swaymsg output eDP-2 enable fi ''; }; }
3.3.1.31. Low battery notification
Since I hide the waybar completely during normal operation, I run the risk of not noticing when my battery is about to run out. This module sends a notification when the battery level falls below 10%. Written by cafkafk.
{ pkgs, lib, ... }: { systemd.user.services."battery-low" = { enable = true; description = "Notify user if battery is below 10%"; partOf = [ "graphical-session.target" ]; wantedBy = [ "graphical-session.target" ]; serviceConfig = { Type = "simple"; ExecStart = pkgs.writeShellScript "battery-low-notification" '' if (( 10 >= $(${lib.getExe pkgs.acpi} -b | head -n 1 | ${lib.getExe pkgs.ripgrep} -o "\d+%" | ${lib.getExe pkgs.ripgrep} -o "\d+") && $(${lib.getExe pkgs.acpi} -b | head -n 1 | ${lib.getExe pkgs.ripgrep} -o "\d+%" | ${lib.getExe pkgs.ripgrep} -o "\d+") > 0 )); then ${lib.getExe pkgs.libnotify} --urgency=critical "low battery" "$(${lib.getExe pkgs.acpi} -b | head -n 1 | ${lib.getExe pkgs.ripgrep} -o "\d+%")"; fi; ''; }; }; systemd.user.timers."battery-low" = { wantedBy = [ "timers.target" ]; timerConfig = { # Every Minute OnCalendar = "*-*-* *:*:00"; Unit = "battery-low.service"; }; }; }
3.3.1.32. Lanzaboote
This dynamically uses systemd boot or Lanzaboote depending on `config.swarselsystems.initialSetup` and `config.swarselsystems.isSecureBoot`.
{ lib, config, ... }: { boot = { loader = { efi.canTouchEfiVariables = true; systemd-boot.enable = lib.swarselsystems.mkIfElse (config.swarselsystems.initialSetup || !config.swarselsystems.isSecureBoot) (lib.mkForce true) (lib.mkForce false); }; lanzaboote = lib.mkIf (!config.swarselsystems.initialSetup && config.swarselsystems.isSecureBoot) { enable = true; pkiBundle = "/var/lib/sbctl"; }; }; }
3.3.2. Server
3.3.2.1. Imports
First, we enable the use of home-manager
as a NixoS module.
Also, we disable the warnings that trigger when rebuilding with a dirty flake. At this point, I am also disabling channels and pinning the flake registry - the latter lets me use the local version of nixpkgs for commands like nix shell
(without it, we will always download the newest version of nixpkgs for these commands).
Also, the system state version is set here. No need to touch it.
{ self, lib, ... }: let importNames = lib.swarselsystems.readNix "profiles/nixos/server"; profilesPath = "${self}/profiles"; in { imports = lib.swarselsystems.mkImports importNames "profiles/nixos/server" ++ [ "${profilesPath}/nixos/common/settings.nix" "${profilesPath}/nixos/common/home-manager.nix" "${profilesPath}/nixos/common/xserver.nix" "${profilesPath}/nixos/common/gc.nix" "${profilesPath}/nixos/common/store.nix" "${profilesPath}/nixos/common/time.nix" "${profilesPath}/nixos/common/users.nix" "${profilesPath}/nixos/common/nix-ld.nix" ]; }
3.3.2.2. General NixOS Server settings
Here we just define some aliases for rebuilding the system, and we allow some insecure packages that are needed by some server derivations. It would be more elegant to define these in the respective module, but nixpkgs needs to be defined before we can evaluate modules within it, so this must be a top-level configuration.
{ lib, config, ... }: { environment.shellAliases = lib.recursiveUpdate { npswitch = "cd ${config.swarselsystems.flakePath}; git pull; sudo nixos-rebuild --flake .#$(hostname) switch; cd -;"; nswitch = "sudo nixos-rebuild --flake ${config.swarselsystems.flakePath}#$(hostname) switch;"; npiswitch = "cd ${config.swarselsystems.flakePath}; git pull; sudo nixos-rebuild --flake .#$(hostname) switch --impure; cd -;"; nipswitch = "cd ${config.swarselsystems.flakePath}; git pull; sudo nixos-rebuild --flake .#$(hostname) switch --impure; cd -;"; niswitch = "sudo nixos-rebuild --flake ${config.swarselsystems.flakePath}#$(hostname) switch --impure;"; } config.swarselsystems.shellAliases; nixpkgs.config.permittedInsecurePackages = [ # matrix "olm-3.2.16" # sonarr "aspnetcore-runtime-wrapped-6.0.36" "aspnetcore-runtime-6.0.36" "dotnet-sdk-wrapped-6.0.428" "dotnet-sdk-6.0.428" # "SDL_ttf-2.0.11" ]; }
3.3.2.3. System Packages
{ pkgs, ... }: { environment.systemPackages = with pkgs; [ gnupg nix-index ssh-to-age git emacs vim ]; }
3.3.2.4. sops
{ config, lib, ... }: { sops = { age.sshKeyPaths = lib.mkDefault [ "/etc/ssh/sops" ]; defaultSopsFile = lib.mkDefault "${config.swarselsystems.flakePath}/secrets/winters/secrets.yaml"; validateSopsFiles = false; }; }
3.3.2.5. nfs/samba (smb)
{ pkgs, ... }: { services = { # add a user with sudo smbpasswd -a <user> samba = { package = pkgs.samba4Full; # extraConfig = '' # workgroup = WORKGROUP # server role = standalone server # dns proxy = no # pam password change = yes # map to guest = bad user # create mask = 0664 # force create mode = 0664 # directory mask = 0775 # force directory mode = 0775 # follow symlinks = yes # ''; enable = true; openFirewall = true; settings.Eternor = { browseable = "yes"; "read only" = "no"; "guest ok" = "no"; path = "/Vault/Eternor"; writable = "true"; comment = "Eternor"; "valid users" = "Swarsel"; }; }; avahi = { publish.enable = true; publish.userServices = true; # Needed to allow samba to automatically register mDNS records without the need for an `extraServiceFile` nssmdns4 = true; enable = true; openFirewall = true; }; # This enables autodiscovery on windows since SMB1 (and thus netbios) support was discontinued samba-wsdd = { enable = true; openFirewall = true; }; }; }
3.3.2.6. NGINX
{ pkgs, config, ... }: { environment.systemPackages = with pkgs; [ lego ]; # users.users.acme = {}; sops = { # secrets.dnstokenfull = { owner = "acme"; }; secrets.dnstokenfull = { }; templates."certs.secret".content = '' CF_DNS_API_TOKEN=${config.sops.placeholder.dnstokenfull} ''; }; security.acme = { acceptTerms = true; preliminarySelfsigned = false; defaults.email = "mrswarsel@gmail.com"; defaults.dnsProvider = "cloudflare"; defaults.environmentFile = "${config.sops.templates."certs.secret".path}"; }; services.nginx = { enable = true; statusPage = true; recommendedProxySettings = true; recommendedTlsSettings = true; recommendedOptimisation = true; recommendedGzipSettings = true; # virtualHosts are defined in the respective sections }; }
3.3.2.7. ssh
{ self, ... }: { services.openssh = { enable = true; }; users.users.swarsel.openssh.authorizedKeys.keyFiles = [ (self + /secrets/keys/ssh/nbl-imba-2.pub) (self + /secrets/keys/ssh/magicant.pub) ]; users.users.root.openssh.authorizedKeys.keyFiles = [ (self + /secrets/keys/ssh/nbl-imba-2.pub) (self + /secrets/keys/ssh/magicant.pub) ]; security.sudo.extraConfig = '' Defaults env_keep+=SSH_AUTH_SOCK ''; }
3.3.2.8. kavita
{ pkgs, lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.kavita { environment.systemPackages = with pkgs; [ calibre ]; users.users.jellyfin = { extraGroups = [ "users" ]; }; sops.secrets.kavita = { owner = "kavita"; }; networking.firewall.allowedTCPPorts = [ 8080 ]; services.kavita = { enable = true; user = "kavita"; settings.Port = 8080; tokenKeyFile = config.sops.secrets.kavita.path; }; services.nginx = { virtualHosts = { "scroll.swarsel.win" = { enableACME = true; forceSSL = true; acmeRoot = null; locations = { "/" = { proxyPass = "http://localhost:8080"; extraConfig = '' client_max_body_size 0; ''; }; }; }; }; }; }; }
3.3.2.9. jellyfin
{ pkgs, lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.jellyfin { users.users.jellyfin = { extraGroups = [ "video" "render" "users" ]; }; nixpkgs.config.packageOverrides = pkgs: { vaapiIntel = pkgs.vaapiIntel.override { enableHybridCodec = true; }; }; hardware.graphics = { enable = true; extraPackages = with pkgs; [ intel-media-driver # LIBVA_DRIVER_NAME=iHD vaapiIntel # LIBVA_DRIVER_NAME=i965 (older but works better for Firefox/Chromium) vaapiVdpau libvdpau-va-gl ]; }; services.jellyfin = { enable = true; user = "jellyfin"; openFirewall = true; # this works only for the default ports }; services.nginx = { virtualHosts = { "screen.swarsel.win" = { enableACME = true; forceSSL = true; acmeRoot = null; locations = { "/" = { proxyPass = "http://localhost:8096"; extraConfig = '' client_max_body_size 0; ''; }; }; }; }; }; }; }
3.3.2.10. navidrome
{ pkgs, lib, inputs, config, ... }: let secretsDirectory = builtins.toString inputs.nix-secrets; in { config = lib.mkIf config.swarselsystems.server.navidrome { environment.systemPackages = with pkgs; [ pciutils alsa-utils mpv ]; users = { groups = { navidrome = { gid = 61593; }; }; users = { navidrome = { isSystemUser = true; uid = 61593; group = "navidrome"; extraGroups = [ "audio" "utmp" "users" "pipewire" ]; }; }; }; hardware = { # opengl.enable = true; enableAllFirmware = true; }; networking.firewall.allowedTCPPorts = [ 4040 ]; services.navidrome = { enable = true; openFirewall = true; settings = { LogLevel = "error"; Address = "127.0.0.1"; Port = 4040; MusicFolder = "/Vault/Eternor/Musik"; EnableSharing = true; EnableTranscodingConfig = true; Scanner.GroupAlbumReleases = true; ScanSchedule = "@every 24h"; MPVPath = "${pkgs.mpv}/bin/mpv"; MPVCommandTemplate = "mpv --audio-device=%d --no-audio-display --pause %f"; Jukebox = { Enabled = true; Default = "pch"; Devices = [ [ "pch" "alsa/sysdefault:CARD=PCH" ] ]; }; # Switch using --impure as these credential files are not stored within the flake # sops-nix is not supported for these which is why we need to resort to these LastFM.ApiKey = builtins.readFile "${secretsDirectory}/navidrome/lastfm-secret"; LastFM.Secret = builtins.readFile "${secretsDirectory}/navidrome/lastfm-key"; Spotify.ID = builtins.readFile "${secretsDirectory}/navidrome/spotify-id"; Spotify.Secret = builtins.readFile "${secretsDirectory}/navidrome/spotify-secret"; UILoginBackgroundUrl = "https://i.imgur.com/OMLxi7l.png"; UIWelcomeMessage = "~SwarselSound~"; }; }; services.nginx = { virtualHosts = { "sound.swarsel.win" = { enableACME = true; forceSSL = true; acmeRoot = null; locations = { "/" = { proxyPass = "http://localhost:4040"; proxyWebsockets = true; extraConfig = '' proxy_redirect http:// https://; proxy_read_timeout 600s; proxy_send_timeout 600s; proxy_buffering off; proxy_request_buffering off; client_max_body_size 0; ''; }; }; }; }; }; }; }
3.3.2.11. spotifyd
{ lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.spotifyd { users.groups.spotifyd = { gid = 65136; }; users.users.spotifyd = { isSystemUser = true; uid = 65136; group = "spotifyd"; extraGroups = [ "audio" "utmp" "pipewire" ]; }; networking.firewall.allowedTCPPorts = [ 1025 ]; services.pipewire.systemWide = true; services.spotifyd = { enable = true; settings = { global = { dbus_type = "session"; use_mpris = false; device = "sysdefault:CARD=PCH"; device_name = "SwarselSpot"; mixer = "alsa"; zeroconf_port = 1025; }; }; }; }; }
3.3.2.12. mpd
{ pkgs, lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.mpd { users = { groups = { mpd = { }; }; users = { mpd = { isSystemUser = true; group = "mpd"; extraGroups = [ "audio" "utmp" ]; }; }; }; sops = { secrets.mpdpass = { owner = "mpd"; }; }; environment.systemPackages = with pkgs; [ pciutils alsa-utils mpv ]; services.mpd = { enable = true; musicDirectory = "/media"; user = "mpd"; group = "mpd"; network = { port = 3254; listenAddress = "any"; }; credentials = [ { passwordFile = config.sops.secrets.mpdpass.path; permissions = [ "read" "add" "control" "admin" ]; } ]; }; }; }
3.3.2.13. pipewire
{ lib, config, ... }: { config = lib.mkIf (config.swarselsystems.server.mpd || config.swarselsystems.server.navidrome) { security.rtkit.enable = true; # this is required for pipewire real-time access services.pipewire = { enable = true; pulse.enable = true; jack.enable = true; audio.enable = true; wireplumber.enable = true; alsa = { enable = true; support32Bit = true; }; }; }; }
3.3.2.14. matrix
{ config, lib, pkgs, sops, ... }: let matrixDomain = "swatrix.swarsel.win"; baseUrl = "https://${matrixDomain}"; clientConfig."m.homeserver".base_url = baseUrl; serverConfig."m.server" = "${matrixDomain}:443"; mkWellKnown = data: '' default_type application/json; add_header Access-Control-Allow-Origin *; return 200 '${builtins.toJSON data}'; ''; in { config = lib.mkIf config.swarselsystems.server.matrix { environment.systemPackages = with pkgs; [ matrix-synapse lottieconverter ffmpeg ]; sops = { secrets = { matrixsharedsecret = { owner = "matrix-synapse"; }; mautrixtelegram_as = { owner = "matrix-synapse"; }; mautrixtelegram_hs = { owner = "matrix-synapse"; }; mautrixtelegram_api_id = { owner = "matrix-synapse"; }; mautrixtelegram_api_hash = { owner = "matrix-synapse"; }; }; templates = { "matrix_user_register.sh".content = '' register_new_matrix_user -k ${config.sops.placeholder.matrixsharedsecret} http://localhost:8008 ''; matrixshared = { owner = "matrix-synapse"; content = '' registration_shared_secret: ${config.sops.placeholder.matrixsharedsecret} ''; }; mautrixtelegram = { owner = "matrix-synapse"; content = '' MAUTRIX_TELEGRAM_APPSERVICE_AS_TOKEN=${config.sops.placeholder.mautrixtelegram_as} MAUTRIX_TELEGRAM_APPSERVICE_HS_TOKEN=${config.sops.placeholder.mautrixtelegram_hs} MAUTRIX_TELEGRAM_TELEGRAM_API_ID=${config.sops.placeholder.mautrixtelegram_api_id} MAUTRIX_TELEGRAM_TELEGRAM_API_HASH=${config.sops.placeholder.mautrixtelegram_api_hash} ''; }; }; }; services.postgresql = { enable = true; initialScript = pkgs.writeText "synapse-init.sql" '' CREATE ROLE "matrix-synapse" WITH LOGIN PASSWORD 'synapse'; CREATE DATABASE "matrix-synapse" WITH OWNER "matrix-synapse" TEMPLATE template0 LC_COLLATE = "C" LC_CTYPE = "C"; CREATE ROLE "mautrix-telegram" WITH LOGIN PASSWORD 'telegram'; CREATE DATABASE "mautrix-telegram" WITH OWNER "mautrix-telegram" TEMPLATE template0 LC_COLLATE = "C" LC_CTYPE = "C"; CREATE ROLE "mautrix-whatsapp" WITH LOGIN PASSWORD 'whatsapp'; CREATE DATABASE "mautrix-whatsapp" WITH OWNER "mautrix-whatsapp" TEMPLATE template0 LC_COLLATE = "C" LC_CTYPE = "C"; CREATE ROLE "mautrix-signal" WITH LOGIN PASSWORD 'signal'; CREATE DATABASE "mautrix-signal" WITH OWNER "mautrix-signal" TEMPLATE template0 LC_COLLATE = "C" LC_CTYPE = "C"; ''; }; services.matrix-synapse = { enable = true; settings = { app_service_config_files = [ "/var/lib/matrix-synapse/telegram-registration.yaml" "/var/lib/matrix-synapse/whatsapp-registration.yaml" "/var/lib/matrix-synapse/signal-registration.yaml" "/var/lib/matrix-synapse/doublepuppet.yaml" ]; server_name = matrixDomain; public_baseurl = "https://${matrixDomain}"; listeners = [ { port = 8008; bind_addresses = [ "127.0.0.1" # "::1" ]; type = "http"; tls = false; x_forwarded = true; resources = [ { names = [ "client" "federation" ]; compress = true; } ]; } ]; }; extraConfigFiles = [ config.sops.templates.matrixshared.path ]; }; services.mautrix-telegram = { enable = true; environmentFile = config.sops.templates.mautrixtelegram.path; settings = { homeserver = { address = "http://localhost:8008"; domain = matrixDomain; }; appservice = { address = "http://localhost:29317"; hostname = "localhost"; port = "29317"; provisioning.enabled = true; id = "telegram"; # ephemeral_events = true; # not needed due to double puppeting public = { enabled = false; }; database = "postgresql:///mautrix-telegram?host=/run/postgresql"; }; bridge = { relaybot.authless_portals = true; allow_avatar_remove = true; allow_contact_info = true; sync_channel_members = true; startup_sync = true; sync_create_limit = 0; sync_direct_chats = true; telegram_link_preview = true; permissions = { "*" = "relaybot"; "@swarsel:${matrixDomain}" = "admin"; }; animated_sticker = { target = "gif"; args = { width = 256; height = 256; fps = 30; # only for webm background = "020202"; # only for gif, transparency not supported }; }; }; }; }; systemd.services.mautrix-telegram.path = with pkgs; [ lottieconverter # for animated stickers conversion, unfree package ffmpeg # if converting animated stickers to webm (very slow!) ]; services.mautrix-whatsapp = { enable = true; registerToSynapse = false; settings = { homeserver = { address = "http://localhost:8008"; domain = matrixDomain; }; appservice = { address = "http://localhost:29318"; hostname = "127.0.0.1"; port = 29318; database = { type = "postgres"; uri = "postgresql:///mautrix-whatsapp?host=/run/postgresql"; }; }; bridge = { displayname_template = "{{or .FullName .PushName .JID}} (WA)"; history_sync = { backfill = true; max_initial_conversations = -1; message_count = -1; request_full_sync = true; full_sync_config = { days_limit = 900; size_mb_limit = 5000; storage_quota_mb = 5000; }; }; login_shared_secret_map = { matrixDomain = "as_token:doublepuppet"; }; sync_manual_marked_unread = true; send_presence_on_typing = true; parallel_member_sync = true; url_previews = true; caption_in_message = true; extev_polls = true; permissions = { "*" = "relay"; "@swarsel:${matrixDomain}" = "admin"; }; }; }; }; services.mautrix-signal = { enable = true; registerToSynapse = false; settings = { homeserver = { address = "http://localhost:8008"; domain = matrixDomain; }; appservice = { address = "http://localhost:29328"; hostname = "127.0.0.1"; port = 29328; database = { type = "postgres"; uri = "postgresql:///mautrix-signal?host=/run/postgresql"; }; }; bridge = { displayname_template = "{{or .ContactName .ProfileName .PhoneNumber}} (Signal)"; login_shared_secret_map = { matrixDomain = "as_token:doublepuppet"; }; caption_in_message = true; permissions = { "*" = "relay"; "@swarsel:${matrixDomain}" = "admin"; }; }; }; }; # restart the bridges daily. this is done for the signal bridge mainly which stops carrying # messages out after a while. systemd.timers."restart-bridges" = { wantedBy = [ "timers.target" ]; timerConfig = { OnBootSec = "1d"; OnUnitActiveSec = "1d"; Unit = "restart-bridges.service"; }; }; systemd.services."restart-bridges" = { script = '' systemctl restart mautrix-whatsapp.service systemctl restart mautrix-signal.service systemctl restart mautrix-telegram.service ''; serviceConfig = { Type = "oneshot"; User = "root"; }; }; services.nginx = { virtualHosts = { "swatrix.swarsel.win" = { enableACME = true; forceSSL = true; acmeRoot = null; listen = [ { addr = "0.0.0.0"; port = 8448; ssl = true; extraParameters = [ "default_server" ]; } { addr = "[::0]"; port = 8448; ssl = true; extraParameters = [ "default_server" ]; } { addr = "0.0.0.0"; port = 443; ssl = true; } { addr = "[::0]"; port = 443; ssl = true; } ]; locations = { "~ ^(/_matrix|/_synapse/client)" = { # proxyPass = "http://localhost:8008"; proxyPass = "http://localhost:8008"; extraConfig = '' client_max_body_size 0; ''; }; "= /.well-known/matrix/server".extraConfig = mkWellKnown serverConfig; "= /.well-known/matrix/client".extraConfig = mkWellKnown clientConfig; }; }; }; }; }; }
3.3.2.15. nextcloud
{ pkgs, lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.nextcloud { sops.secrets.nextcloudadminpass = { owner = "nextcloud"; group = "nextcloud"; mode = "0440"; }; services.nextcloud = { enable = true; package = pkgs.nextcloud30; hostName = "stash.swarsel.win"; home = "/Vault/apps/nextcloud"; datadir = "/Vault/data/nextcloud"; https = true; configureRedis = true; maxUploadSize = "4G"; extraApps = { inherit (pkgs.nextcloud30Packages.apps) mail calendar contacts cospend phonetrack polls tasks; }; config = { adminuser = "admin"; adminpassFile = config.sops.secrets.nextcloudadminpass.path; dbtype = "sqlite"; }; }; services.nginx = { virtualHosts = { "stash.swarsel.win" = { enableACME = true; forceSSL = true; acmeRoot = null; # config is automatically added by nixos nextcloud config. # hence, only provide certificate }; }; }; }; }
3.3.2.16. immich
{ lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.immich { users.users.immich = { extraGroups = [ "video" "render" "users" ]; }; # sops.secrets.nextcloudadminpass = { owner = "nextcloud"; }; services.immich = { enable = true; port = 3001; openFirewall = true; mediaLocation = "/Vault/Eternor/Immich"; environment.IMMICH_MACHINE_LEARNING_URL = lib.mkForce "http://localhost:3003"; }; services.nginx = { virtualHosts = { "shots.swarsel.win" = { enableACME = true; forceSSL = true; acmeRoot = null; locations = { "/" = { proxyPass = "http://localhost:3001"; extraConfig = '' client_max_body_size 0; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; proxy_redirect off; proxy_read_timeout 600s; proxy_send_timeout 600s; send_timeout 600s; ''; }; }; }; }; }; }; }
3.3.2.17. paperless
{ lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.paperless { users.users.paperless = { extraGroups = [ "users" ]; }; sops.secrets.paperless_admin = { owner = "paperless"; }; services.paperless = { enable = true; mediaDir = "/Vault/Eternor/Paperless"; dataDir = "/Vault/data/paperless"; user = "paperless"; port = 28981; passwordFile = config.sops.secrets.paperless_admin.path; address = "127.0.0.1"; settings = { PAPERLESS_OCR_LANGUAGE = "deu+eng"; PAPERLESS_URL = "https://scan.swarsel.win"; PAPERLESS_OCR_USER_ARGS = builtins.toJSON { optimize = 1; invalidate_digital_signatures = true; pdfa_image_compression = "lossless"; }; }; }; services.nginx = { virtualHosts = { "scan.swarsel.win" = { enableACME = true; forceSSL = true; acmeRoot = null; locations = { "/" = { proxyPass = "http://localhost:28981"; extraConfig = '' client_max_body_size 0; ''; }; }; }; }; }; }; }
3.3.2.18. transmission
{ pkgs, lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.transmission { # this user/group section is probably unneeded users = { groups = { dockeruser = { gid = 1155; }; radarr = { }; readarr = { }; sonarr = { }; lidarr = { }; prowlarr = { }; }; users = { dockeruser = { isSystemUser = true; uid = 1155; group = "docker"; extraGroups = [ "users" ]; }; radarr = { isSystemUser = true; group = "radarr"; extraGroups = [ "users" ]; }; readarr = { isSystemUser = true; group = "readarr"; extraGroups = [ "users" ]; }; sonarr = { isSystemUser = true; group = "sonarr"; extraGroups = [ "users" ]; }; lidarr = { isSystemUser = true; group = "lidarr"; extraGroups = [ "users" ]; }; prowlarr = { isSystemUser = true; group = "prowlarr"; extraGroups = [ "users" ]; }; }; }; virtualisation.docker.enable = true; environment.systemPackages = with pkgs; [ docker ]; services = { radarr = { enable = true; openFirewall = true; dataDir = "/Vault/apps/radarr"; }; readarr = { enable = true; openFirewall = true; dataDir = "/Vault/apps/readarr"; }; sonarr = { enable = true; openFirewall = true; dataDir = "/Vault/apps/sonarr"; }; lidarr = { enable = true; openFirewall = true; dataDir = "/Vault/apps/lidarr"; }; prowlarr = { enable = true; openFirewall = true; }; nginx = { virtualHosts = { "store.swarsel.win" = { enableACME = false; forceSSL = false; acmeRoot = null; locations = { "/" = { proxyPass = "http://localhost:9091"; extraConfig = '' client_max_body_size 0; ''; }; "/radarr" = { proxyPass = "http://localhost:7878"; extraConfig = '' client_max_body_size 0; ''; }; "/readarr" = { proxyPass = "http://localhost:8787"; extraConfig = '' client_max_body_size 0; ''; }; "/sonarr" = { proxyPass = "http://localhost:8989"; extraConfig = '' client_max_body_size 0; ''; }; "/lidarr" = { proxyPass = "http://localhost:8686"; extraConfig = '' client_max_body_size 0; ''; }; "/prowlarr" = { proxyPass = "http://localhost:9696"; extraConfig = '' client_max_body_size 0; ''; }; }; }; }; }; }; }; }
3.3.2.19. syncthing
{ lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.syncthing { users.users.syncthing = { extraGroups = [ "users" ]; group = "syncthing"; isSystemUser = true; }; users.groups.syncthing = { }; services.syncthing = { enable = true; user = "swarsel"; dataDir = "/Vault/data/syncthing"; configDir = "/Vault/apps/syncthing"; guiAddress = "0.0.0.0:8384"; openDefaultPorts = true; relay.enable = false; settings = { urAccepted = -1; devices = { "magicant" = { id = "VMWGEE2-4HDS2QO-KNQOVGN-LXLX6LA-666E4EK-ZBRYRRO-XFEX6FB-6E3XLQO"; }; "sync (@oracle)" = { id = "ETW6TST-NPK7MKZ-M4LXMHA-QUPQHDT-VTSHH5X-CR5EIN2-YU7E55F-MGT7DQB"; }; "nbl-imba-2" = { id = "YAPV4BV-I26WPTN-SIP32MV-SQP5TBZ-3CHMTCI-Z3D6EP2-MNDQGLP-53FT3AB"; }; }; folders = { "Default Folder" = lib.mkForce { path = "/Vault/data/syncthing/Sync"; type = "receiveonly"; versioning = null; devices = [ "sync (@oracle)" "magicant" "nbl-imba-2" ]; id = "default"; }; "Obsidian" = { path = "/Vault/data/syncthing/Obsidian"; type = "receiveonly"; versioning = { type = "simple"; params.keep = "5"; }; devices = [ "sync (@oracle)" "magicant" "nbl-imba-2" ]; id = "yjvni-9eaa7"; }; "Org" = { path = "/Vault/data/syncthing/Org"; type = "receiveonly"; versioning = { type = "simple"; params.keep = "5"; }; devices = [ "sync (@oracle)" "magicant" "nbl-imba-2" ]; id = "a7xnl-zjj3d"; }; "Vpn" = { path = "/Vault/data/syncthing/Vpn"; type = "receiveonly"; versioning = { type = "simple"; params.keep = "5"; }; devices = [ "sync (@oracle)" "magicant" "nbl-imba-2" ]; id = "hgp9s-fyq3p"; }; "Documents" = { path = "/Vault/data/syncthing/Documents"; type = "receiveonly"; versioning = { type = "simple"; params.keep = "5"; }; devices = [ "magicant" "nbl-imba-2" ]; id = "hgr3d-pfu3w"; }; # ".elfeed" = { # path = "/Vault/data/syncthing/.elfeed"; # devices = [ "sync (@oracle)" "magicant" "nbl-imba-2" ]; # id = "h7xbs-fs9v1"; # }; }; }; }; services.nginx = { virtualHosts = { "storync.swarsel.win" = { enableACME = true; forceSSL = true; acmeRoot = null; locations = { "/" = { proxyPass = "http://localhost:8384"; extraConfig = '' client_max_body_size 0; ''; }; }; }; }; }; }; }
3.3.2.20. restic
Once this is finished, it will house a restic client that manages automatic backups of my image library. Before I get to this however, I first need to organice my pictures in the first place.
{ lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.restic { # TODO }; }
3.3.2.21. monitoring
This section exposes several metrics that I use to check the health of my server. I need to expand on the exporters section at some point, but for now I have everything I need.
{ self, lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.monitoring { sops.secrets = { grafanaadminpass = { owner = "grafana"; }; prometheusadminpass = { owner = "grafana"; }; }; users.users.nextcloud-exporter = { extraGroups = [ "nextcloud" ]; }; users.users.grafana = { extraGroups = [ "users" ]; }; services.grafana = { enable = true; dataDir = "/Vault/data/grafana"; provision = { enable = true; datasources.settings = { datasources = [ { name = "prometheus"; type = "prometheus"; url = "https://status.swarsel.win/prometheus"; editable = false; access = "proxy"; basicAuth = true; basicAuthUser = "admin"; jsonData = { httpMethod = "POST"; manageAlerts = true; prometheusType = "Prometheus"; prometheusVersion = "> 2.50.x"; cacheLevel = "High"; disableRecordingRules = false; incrementalQueryOverlapWindow = "10m"; }; secureJsonData = { basicAuthPassword = "$__file{/run/secrets/prometheusadminpass}"; }; } ]; }; }; settings = { security.admin_password = "$__file{/run/secrets/grafanaadminpass}"; server = { http_port = 3000; http_addr = "127.0.0.1"; protocol = "http"; domain = "status.swarsel.win"; }; }; }; services.prometheus = { enable = true; webExternalUrl = "https://status.swarsel.win/prometheus"; port = 9090; listenAddress = "127.0.0.1"; globalConfig = { scrape_interval = "10s"; }; webConfigFile = self + /programs/server/prometheus/web.config; scrapeConfigs = [ { job_name = "node"; static_configs = [{ targets = [ "localhost:${toString config.services.prometheus.exporters.node.port}" ]; }]; } { job_name = "zfs"; static_configs = [{ targets = [ "localhost:${toString config.services.prometheus.exporters.zfs.port}" ]; }]; } { job_name = "nginx"; static_configs = [{ targets = [ "localhost:${toString config.services.prometheus.exporters.nginx.port}" ]; }]; } { job_name = "nextcloud"; static_configs = [{ targets = [ "localhost:${toString config.services.prometheus.exporters.nextcloud.port}" ]; }]; } ]; exporters = { node = { enable = true; port = 9000; enabledCollectors = [ "systemd" ]; extraFlags = [ "--collector.ethtool" "--collector.softirqs" "--collector.tcpstat" "--collector.wifi" ]; }; zfs = { enable = true; port = 9134; pools = [ "Vault" ]; }; restic = { enable = false; port = 9753; }; nginx = { enable = true; port = 9113; sslVerify = false; scrapeUri = "http://localhost/nginx_status"; }; nextcloud = lib.mkIf config.swarselsystems.server.nextcloud { enable = true; port = 9205; url = "https://stash.swarsel.win/ocs/v2.php/apps/serverinfo/api/v1/info"; username = "admin"; passwordFile = config.sops.secrets.nextcloudadminpass.path; }; }; }; services.nginx = { virtualHosts = { "status.swarsel.win" = { enableACME = true; forceSSL = true; acmeRoot = null; locations = { "/" = { proxyPass = "http://localhost:3000"; extraConfig = '' client_max_body_size 0; ''; }; "/prometheus" = { proxyPass = "http://localhost:9090"; extraConfig = '' client_max_body_size 0; ''; }; }; }; }; }; }; }
3.3.2.22. Jenkins
This is a WIP Jenkins instance. It is used to automatically build a new system when pushes to the main repository are detected. I have turned this service off for now however, as I actually prefer to start my builds manually.
{ pkgs, lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.jenkins { services.jenkins = { enable = true; withCLI = true; port = 8088; packages = [ pkgs.stdenv pkgs.git pkgs.jdk17 config.programs.ssh.package pkgs.nix ]; listenAddress = "127.0.0.1"; home = "/Vault/apps/jenkins"; }; services.nginx = { virtualHosts = { "servant.swarsel.win" = { enableACME = true; forceSSL = true; acmeRoot = null; locations = { "/" = { proxyPass = "http://localhost:8088"; extraConfig = '' client_max_body_size 0; ''; }; }; }; }; }; }; }
3.3.2.23. Emacs elfeed (RSS Server)
This was an approach of hosting an RSS server from within emacs. That would have been useful as it would have allowed me to allow my feeds from any device. However, it proved impossible to do bidirectional syncing, so I abandoned this configuration in favor of FreshRSS.
{ lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.emacs { networking.firewall.allowedTCPPorts = [ 9812 ]; services.emacs = { enable = true; install = true; startWithGraphical = false; }; }; }
3.3.2.24. FreshRSS
FreshRSS is a more 'classical' RSS aggregator that I can just host as a distinct service. This also has its upsides because I jave more control over the state this way.
It serves both a Greader API at https://signpost.swarsel.win/api/greader.php, as well as a Fever API at https://signpost.swarsel.win/api/fever.php.
{ lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.freshrss { users.users.freshrss = { extraGroups = [ "users" ]; group = "freshrss"; isSystemUser = true; }; users.groups.freshrss = { }; sops.secrets.fresh = { owner = "freshrss"; }; services.freshrss = { enable = true; virtualHost = "signpost.swarsel.win"; baseUrl = "https://signpost.swarsel.win"; # authType = "none"; dataDir = "/Vault/data/tt-rss"; defaultUser = "Swarsel"; passwordFile = config.sops.secrets.fresh.path; }; services.nginx = { virtualHosts = { "signpost.swarsel.win" = { enableACME = true; forceSSL = true; acmeRoot = null; }; }; }; }; }
3.3.2.25. forgejo (git server)
{ lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.forgejo { networking.firewall.allowedTCPPorts = [ 3000 ]; services.forgejo = { enable = true; settings = { DEFAULT = { APP_NAME = "~SwaGit~"; }; server = { PROTOCOL = "http"; HTTP_PORT = 3000; HTTP_ADDR = "0.0.0.0"; DOMAIN = "swagit.swarsel.win"; ROOT_URL = "https://swagit.swarsel.win"; }; service = { DISABLE_REGISTRATION = true; SHOW_REGISTRATION_BUTTON = false; }; }; }; services.nginx = { virtualHosts = { "swagit.swarsel.win" = { enableACME = true; forceSSL = true; acmeRoot = null; locations = { "/" = { proxyPass = "http://localhost:3000"; extraConfig = '' client_max_body_size 0; ''; }; }; }; }; }; }; }
3.3.2.26. Anki Sync Server
{ lib, config, ... }: { config = lib.mkIf config.swarselsystems.server.ankisync { networking.firewall.allowedTCPPorts = [ 22701 ]; sops.secrets.swarsel = { owner = "root"; }; services.anki-sync-server = { enable = true; port = 27701; address = "0.0.0.0"; openFirewall = true; users = [ { username = "Swarsel"; passwordFile = config.sops.secrets.swarsel.path; } ]; }; services.nginx = { virtualHosts = { "synki.swarsel.win" = { enableACME = true; forceSSL = true; acmeRoot = null; locations = { "/" = { proxyPass = "http://localhost:27701"; extraConfig = '' client_max_body_size 0; ''; }; }; }; }; }; }; }
3.3.3. Darwin
3.3.3.1. Imports
This section sets up all the imports that are used in the home-manager section.
_: { nix.settings.experimental-features = "nix-command flakes"; nixpkgs = { hostPlatform = "x86_64-darwin"; overlays = [ outputs.overlays.default ]; config = { allowUnfree = true; }; }; system.stateVersion = 4; }
3.3.4. Optional
These sets of configuration do not need to be deployed on every host, for a multitude of reasons.
- The gaming set is not needed on weak machines, and also not on my work machine.
- The VirtualBox package takes forever to build, and I do not need virtual machines on every host.
- There are some hosts that I do not want to autologin to.
nswitch-rcm
is a tool I wrote for easy payload flashing of a Nintendo Switch in RCM mode. However, that is not needed on every machine.- The work profile is only used on my work laptop.
3.3.4.1. gaming
This opens a few gaming ports and installs the steam configuration suite for gaming. There are more options in Gaming (home-manager side).
{ pkgs, ... }: { specialisation = { gaming.configuration = { networking = { firewall = { allowedUDPPorts = [ 4380 27036 14242 34197 ]; # 34197: factorio; 4380 27036 14242: barotrauma; allowedTCPPorts = [ ]; # 34197: factorio; 4380 27036 14242: barotrauma; 51820: wireguard allowedTCPPortRanges = [ { from = 27015; to = 27030; } # barotrauma { from = 27036; to = 27037; } # barotrauma ]; allowedUDPPortRanges = [ { from = 27000; to = 27031; } # barotrauma { from = 58962; to = 58964; } # barotrauma ]; }; }; programs.steam = { enable = true; package = pkgs.steam; extraCompatPackages = [ pkgs.proton-ge-bin ]; }; hardware.xone.enable = true; environment.systemPackages = [ pkgs.linuxKernel.packages.linux_6_12.xone ]; }; }; }
3.3.4.2. VirtualBox
This sets the VirtualBox configuration. Guest should not be enabled if not direly needed, it will make rebuilds unbearably slow. I only use this privately to run an old editor that does not run well under wine, so I put it into it's own specialisation.
{ lib, pkgs, ... }: { specialisation = { VBox.configuration = { virtualisation.virtualbox = { host = { enable = true; enableExtensionPack = true; }; # leaving this here for future notice. setting guest.enable = true will make 'restarting sysinit-reactivation.target' take till timeout on nixos-rebuild switch guest = { enable = false; }; }; # run an older kernel to provide compatibility with windows vm boot.kernelPackages = lib.mkForce pkgs.linuxPackages; }; }; }
3.3.4.3. VmWare
This sets the VirtualBox configuration. Guest should not be enabled if not direly needed, it will make rebuilds unbearably slow.
_: { virtualisation.vmware.host.enable = true; virtualisation.vmware.guest.enable = true; }
3.3.4.4. Auto-login
Auto login for the initial session.
_: { services = { getty.autologinUser = "swarsel"; greetd.settings.initial_session.user = "swarsel"; }; }
3.3.4.5. nswitch-rcm
This smashes Atmosphere 1.3.2 on the switch, which is what I am currenty using.
{ pkgs, ... }: { services.nswitch-rcm = { enable = true; package = pkgs.fetchurl { url = "https://github.com/Atmosphere-NX/Atmosphere/releases/download/1.3.2/fusee.bin"; hash = "sha256-5AXzNsny45SPLIrvWJA9/JlOCal5l6Y++Cm+RtlJppI="; }; }; }
3.3.4.6. work
Options that I need specifically at work. There are more options at Work (home-manager side).
{ self, pkgs, config, ... }: let owner = "swarsel"; sopsFile = self + /secrets/work/secrets.yaml; in { sops = { secrets = { clad = { inherit owner sopsFile; }; dcad = { inherit owner sopsFile; }; wsad = { inherit owner sopsFile; }; imbad = { inherit owner sopsFile; }; }; }; # boot.initrd.luks.yubikeySupport = true; programs = { zsh.shellInit = '' export CLAD="$(cat ${config.sops.secrets.clad.path})" export DCAD="$(cat ${config.sops.secrets.dcad.path})" export GOVC_PASSWORD="$(cat ${config.sops.secrets.dcad.path})" export WSAD="$(cat ${config.sops.secrets.wsad.path})" export IMBAD="$(cat ${config.sops.secrets.imbad.path})" export DCUSER="dc_adm_schwarzaeugl@IMP.UNIVIE.AC.AT" export GOVC_USERNAME="dc_adm_schwarzaeugl@IMP.UNIVIE.AC.AT" export PACKER_SSH_EXTRA_ARGS='"--scp-extra-args","'-O'"' ''; browserpass.enable = true; _1password.enable = true; _1password-gui = { enable = true; polkitPolicyOwners = [ "swarsel" ]; }; }; networking = { firewall.trustedInterfaces = [ "virbr0" ]; search = [ "vbc.ac.at" "clip.vbc.ac.at" "imp.univie.ac.at" ]; }; virtualisation = { docker.enable = true; spiceUSBRedirection.enable = true; libvirtd = { enable = true; qemu = { package = pkgs.qemu_kvm; runAsRoot = true; swtpm.enable = true; vhostUserPackages = with pkgs; [ virtiofsd ]; ovmf = { enable = true; packages = [ (pkgs.OVMFFull.override { secureBoot = true; tpmSupport = true; }).fd ]; }; }; }; }; environment.systemPackages = with pkgs; [ # (python39.withPackages (ps: with ps; [ # cryptography # ])) # docker python39 qemu packer gnumake libisoburn govc terraform graphviz # vm virt-manager virt-viewer virtiofsd spice spice-gtk spice-protocol win-virtio win-spice ]; services = { spice-vdagentd.enable = true; openssh = { enable = true; extraConfig = '' ''; }; syncthing = { settings = { "winters" = { id = "O7RWDMD-AEAHPP7-7TAVLKZ-BSWNBTU-2VA44MS-EYGUNBB-SLHKB3C-ZSLMOAA"; }; folders = { "Documents" = { path = "/home/swarsel/Documents"; devices = [ "magicant" "winters" ]; id = "hgr3d-pfu3w"; }; }; }; }; }; # cgroups v1 is required for centos7 dockers specialisation = { cgroup_v1.configuration = { boot.kernelParams = [ "SYSTEMD_CGROUP_ENABLE_LEGACY_FORCE=1" "systemd.unified_cgroup_hierarchy=0" ]; }; }; }
3.3.4.7. Minimal Install
These options are really only to be used on the iso image in order to run nixos-anywhere.
{ lib, pkgs, ... }: { nix.settings = { experimental-features = [ "nix-command" "flakes" ]; warn-dirty = false; }; boot = { # initrd.systemd.enable = true; kernelPackages = pkgs.linuxPackages_latest; supportedFilesystems = lib.mkForce [ "brtfs" "vfat" ]; loader = { efi.canTouchEfiVariables = true; systemd-boot = { enable = true; configurationLimit = lib.mkDefault 5; consoleMode = lib.mkDefault "max"; }; }; }; services = { qemuGuest.enable = true; openssh = { enable = true; ports = lib.mkDefault [ 22 ]; settings.PermitRootLogin = "yes"; authorizedKeysFiles = lib.mkForce [ "/etc/ssh/authorized_keys.d/%u" ]; }; }; security.sudo.extraConfig = '' Defaults env_keep+=SSH_AUTH_SOCK Defaults lecture = never ''; security.pam = { sshAgentAuth.enable = true; services = { sudo.u2fAuth = true; }; }; environment.systemPackages = with pkgs; [ curl git gnupg rsync ssh-to-age sops vim just sbctl ]; programs = { git.enable = true; }; fileSystems."/boot".options = [ "umask=0077" ]; networking.networkmanager.enable = true; }
3.4. Home-manager
The general structure is the same as in the NixOS section.
3.4.1. Common
3.4.1.1. Imports
This section sets up all the imports that are used in the home-manager section.
{ lib, ... }: let importNames = lib.swarselsystems.readNix "profiles/home/common"; in { imports = lib.swarselsystems.mkImports importNames "profiles/home/common"; }
3.4.1.2. General home-manager-settings
Again, we adapt nix
to our needs, enable the home-manager command for non-NixOS machines (NixOS machines are using it as a module) and setting user information that I always keep the same.
{ lib, config, ... }: { nix = lib.mkIf (!config.swarselsystems.isNixos) { settings = { experimental-features = [ "nix-command" "flakes" "ca-derivations" "cgroups" "pipe-operators" ]; trusted-users = [ "@wheel" "swarsel" ]; connect-timeout = 5; bash-prompt-prefix = "[33m$SHLVL:\\w [0m"; bash-prompt = "$(if [[ $? -gt 0 ]]; then printf \"[31m\"; else printf \"[32m\"; fi)\[\e[1m\]λ\[\e[0m\] [0m"; fallback = true; min-free = 128000000; max-free = 1000000000; auto-optimise-store = true; warn-dirty = false; max-jobs = 1; use-cgroups = lib.mkIf config.swarselsystems.isLinux true; }; }; nixpkgs.overlays = lib.mkIf config.swarselsystems.isNixos (lib.mkForce null); programs.home-manager.enable = lib.mkIf (!config.swarselsystems.isNixos) true; home = { username = lib.mkDefault "swarsel"; homeDirectory = lib.mkDefault "/home/${config.home.username}"; stateVersion = lib.mkDefault "23.05"; keyboard.layout = "us"; sessionVariables = { FLAKE = "${config.home.homeDirectory}/.dotfiles"; }; }; }
3.4.1.3. Installed packages
Here are defined some packages that I would like to use across all my machines. Most of these should not require further setup. Notably the cura package is severely outdated on nixpkgs, so I just fetch a more recent AppImage and run that instead.
Also, I define some useful shell scripts here.
Programming languages and default lsp's are defined here: System Packages
3.4.1.3.1. Packaged
This holds packages that I can use as provided, or with small modifications (as in the texlive
package that needs special configuration).
{ pkgs, ... }: { home.packages = with pkgs; [ # audio stuff spek # spectrum analyzer losslessaudiochecker ffmpeg_7-full flac mediainfo picard-tools audacity sox stable.feishin calibre # printing cups simple-scan # dict (aspellWithDicts (dicts: with dicts; [ de en en-computers en-science ])) # browser vieb mgba # utilities util-linux nmap lsof nvd nix-output-monitor hyprpicker # color picker findutils units vim # nix alejandra nixpkgs-fmt deadnix statix nix-tree nix-diff nix-visualize nix-init nix-inspect manix comma # shellscripts shfmt # local file sharing wormhole-rs # b2 backup @backblaze restic # "big" programs gimp inkscape zoom-us # nomacs libreoffice-qt xournalpp obsidian spotify vesktop # discord client nextcloud-client spotify-player element-desktop nicotine-plus stable.transmission_3 mktorrent hexchat hugo # kyria qmk qmk-udev-rules # firefox related tridactyl-native # mako related mako libnotify # general utilities unrar samba cifs-utils zbar # qr codes readline autotiling brightnessctl libappindicator-gtk3 sqlite speechd networkmanagerapplet psmisc # kill etc lm_sensors # jq # used for searching the i3 tree in check<xxx>.sh files # specifically needed for anki # mpv anki-bin # dirvish file previews fd imagemagick poppler ffmpegthumbnailer mediainfo gnutar unzip #nautilus stable.nautilus xfce.tumbler libgsf # wayland stuff wtype wl-clipboard wl-mirror wf-recorder # screenshotting tools grim slurp # the following packages are used (in some way) by waybar playerctl pavucontrol stable.pamixer # gnome.gnome-clocks # wlogout # jdiskreport # monitor #keychain qalculate-gtk gcr # needed for gnome-secrets to work seahorse # sops-related sops ssh-to-age # mail related packages mu # latex and related packages (texlive.combine { inherit (pkgs.texlive) scheme-full dvisvgm dvipng# for preview and export as html wrapfig amsmath ulem hyperref capt-of; }) # font stuff nerd-fonts.fira-mono nerd-fonts.fira-code nerd-fonts.symbols-only noto-fonts-emoji font-awesome_5 noto-fonts noto-fonts-cjk-sans ]; }
3.4.1.3.2. Self-defined
This is just a separate container for derivations defined in Packages. This is a good idea so that I do not lose track of package names I have defined myself, as this was once a problem in the past already.
{ pkgs, ... }: { home.packages = with pkgs; [ pass-fuzzel cura5 cdw cdb bak timer e swarselcheck waybarupdate opacitytoggle fs-diff update-checker github-notifications screenshare hm-specialisation t2ts ts2t vershell eontimer project fhs swarsel-bootstrap swarsel-displaypower swarselzellij ]; }
3.4.1.4. sops
I use sops-nix to handle secrets that I want to have available on my machines at all times. Procedure to add a new machine:
- `ssh-keygen -t ed25519 -C "NAME sops"` in .ssh directory (or wherever) - name e.g. "sops"
- cat ~/.ssh/sops.pub | ssh-to-age | wl-copy
- add the output to .sops.yaml
- cp ~/.ssh/sops.pub ~/.dotfiles/secrets/keys/NAME.pub
update entry for sops.age.sshKeyPaths
Since we are using the home-manager implementation here, we need to specify the runtime path.
{ config, lib, ... }: { sops = lib.mkIf (!config.swarselsystems.isPublic) { age.sshKeyPaths = [ "${config.home.homeDirectory}/.ssh/sops" "${config.home.homeDirectory}/.ssh/ssh_host_ed25519_key" ]; defaultSopsFile = lib.swarselsystems.mkIfElseList config.swarselsystems.isBtrfs "/persist/.dotfiles/secrets/general/secrets.yaml" "${config.home.homeDirectory}/.dotfiles/secrets/general/secrets.yaml"; validateSopsFiles = false; secrets = { mrswarsel = { path = "/run/user/1000/secrets/mrswarsel"; }; nautilus = { path = "/run/user/1000/secrets/nautilus"; }; leon = { path = "/run/user/1000/secrets/leon"; }; swarselmail = { path = "/run/user/1000/secrets/swarselmail"; }; github_notif = { path = "/run/user/1000/secrets/github_notif"; }; u2f_keys = { path = "${config.home.homeDirectory}/.config/Yubico/u2f_keys"; }; }; }; }
3.4.1.5. SSH Machines
It is very convenient to have SSH aliases in place for machines that I use. This is mainly used for some server machines and some university clusters. We also enable agent forwarding to have our Yubikey SSH key accessible on the remote host.
_: { programs.ssh = { enable = true; forwardAgent = true; extraConfig = '' SetEnv TERM=xterm-256color ServerAliveInterval 20 ''; matchBlocks = { # Local machines "pfsense" = { hostname = "192.168.1.1"; user = "root"; }; "winters" = { hostname = "192.168.1.2"; user = "swarsel"; }; "minecraft" = { hostname = "130.61.119.129"; user = "opc"; }; "sync" = { hostname = "193.122.53.173"; user = "root"; #this is a oracle vm server but needs root due to nixos-infect }; "songdiver" = { hostname = "89.168.100.65"; user = "ubuntu"; }; "pkv" = { hostname = "46.232.248.161"; user = "root"; }; "efficient" = { hostname = "g0.complang.tuwien.ac.at"; user = "ep01427399"; }; }; }; }
3.4.1.6. Theme (stylix)
These section allows home-manager to allow theme settings, and handles some other appearance-related settings like cursor styles. Interestingly, system icons (adwaita) still need to be setup on system-level, and will break if defined here.
This section has been notably empty ever since switching to stylix. Only Emacs is not allowed to be styled by it, because it becomes more ugly compared to my handcrafted setup.
theme
is defined in [BROKEN LINK: h:5bc1b0c9-dc59-4c81-b5b5-e60699deda78].
{ lib, config, ... }: { stylix = lib.mkIf (!config.swarselsystems.isNixos) (lib.recursiveUpdate { image = config.swarselsystems.wallpaper; targets = { emacs.enable = false; waybar.enable = false; }; } config.swarselsystems.stylix); }
3.4.1.7. Desktop Entries, MIME types (xdg)
Some programs lack a dmenu launcher - I define them myself here.
TODO: Non-NixOS machines (=sp3) should not use these by default, but instead the programs prefixed with "nixGL". I need to figure out how to automate this process, as it is not feasible to write desktop entries for all programs installed on that machine.
_: { xdg.desktopEntries = { cura = { name = "Ultimaker Cura"; genericName = "Cura"; exec = "cura"; terminal = false; categories = [ "Application" ]; }; anki = { name = "Anki Flashcards"; genericName = "Anki"; exec = "anki"; terminal = false; categories = [ "Application" ]; }; element = { name = "Element Matrix Client"; genericName = "Element"; exec = "element-desktop -enable-features=UseOzonePlatform -ozone-platform=wayland --disable-gpu-driver-bug-workarounds"; terminal = false; categories = [ "Application" ]; }; emacsclient-newframe = { name = "Emacs (Client, New Frame)"; genericName = "Emacs (Client, New Frame)"; exec = "emacsclient -r %u"; icon = "emacs"; terminal = false; categories = [ "Development" "TextEditor" ]; }; }; xdg.mimeApps = { enable = true; defaultApplications = { "x-scheme-handler/http" = [ "firefox.desktop" ]; "x-scheme-handler/https" = [ "firefox.desktop" ]; "x-scheme-handler/chrome" = [ "firefox.desktop" ]; "text/plain" = [ "emacsclient.desktop" ]; "text/csv" = [ "emacsclient.desktop" ]; "text/html" = [ "firefox.desktop" ]; "application/x-extension-htm" = [ "firefox.desktop" ]; "application/x-extension-html" = [ "firefox.desktop" ]; "application/x-extension-shtml" = [ "firefox.desktop" ]; "application/xhtml+xml" = [ "firefox.desktop" ]; "application/x-extension-xhtml" = [ "firefox.desktop" ]; "application/x-extension-xht" = [ "firefox.desktop" ]; "image/png" = [ "imv.desktop" ]; "image/jpeg" = [ "imv.desktop" ]; "image/gif" = [ "imv.desktop" ]; "image/svg" = [ "imv.desktop" ]; "image/webp" = [ "firefox.desktop" ]; "image/vnd.adobe.photoshop" = [ "gimp.desktop" ]; "image/vnd.dxf" = [ "org.inkscape.Inkscape.desktop" ]; "audio/flac" = [ "mpv.desktop" ]; "audio/mp3" = [ "mpv.desktop" ]; "audio/ogg" = [ "mpv.desktop" ]; "audio/wav" = [ "mpv.desktop" ]; "video/mp4" = [ "umpv.desktop" ]; "video/mkv" = [ "umpv.desktop" ]; "video/flv" = [ "umpv.desktop" ]; "video/3gp" = [ "umpv.desktop" ]; "application/pdf" = [ "org.gnome.Evince.desktop" ]; "application/metalink+xml" = [ "emacsclient.desktop" ]; "application/sql" = [ "emacsclient.desktop" ]; "application/vnd.ms-powerpoint" = [ "impress.desktop" ]; "application/msword" = [ "writer.desktop" ]; "application/vnd.ms-excel" = [ "calc.desktop" ]; }; associations = { added = { "application/x-zerosize" = [ "emacsclient.desktop" ]; }; }; }; }
3.4.1.8. Linking dotfiles (Symlinks home.file)
This section should be used in order to symlink already existing configuration files using `home.file` and setting session variables using `home.sessionVariables`.
As for the `home.sessionVariables`, it should be noted that environment variables that are needed at system start should NOT be loaded here, but instead in `programs.zsh.config.extraSessionCommands` (in the home-manager programs section). This is also where all the wayland related variables are stored.
Also, we link some files to the users XDG configuration home: Also in firefox `about:config > toolkit.legacyUserProfileCustomizations.stylesheets` to true.
{ self, lib, ... }: { home.file = { "init.el" = lib.mkDefault { source = self + /programs/emacs/init.el; target = ".emacs.d/init.el"; }; "early-init.el" = { source = self + /programs/emacs/early-init.el; target = ".emacs.d/early-init.el"; }; # on NixOS, Emacs does not find the aspell dicts easily. Write the configuration manually ".aspell.conf" = { source = self + /programs/config/.aspell.conf; target = ".aspell.conf"; }; ".gitmessage" = { source = self + /programs/git/.gitmessage; target = ".gitmessage"; }; }; xdg.configFile = { "tridactyl/tridactylrc".source = self + /programs/firefox/tridactyl/tridactylrc; "tridactyl/themes/base16-codeschool.css".source = self + /programs/firefox/tridactyl/themes/base16-codeschool.css; "swayidle/config".source = self + /programs/swayidle/config; }; }
3.4.1.9. Sourcing environment variables
Sets environment variables. Here I am only setting the EDITOR variable, most variables are set in the Sway section.
{ config, ... }: { home.sessionVariables = { EDITOR = "e -w"; DISPLAY = ":0"; SWARSEL_LO_RES = config.swarselsystems.lowResolution; SWARSEL_HI_RES = config.swarselsystems.highResolution; }; }
3.4.1.10. General Programs: bottom, imv, sioyek, bat, carapace, wlogout, swayr, yt-dlp, mpv, jq, nix-index, ripgrep, pandoc, fzf
This section is for programs that require no further configuration. zsh Integration is enabled by default for these.
{ pkgs, ... }: { programs = { bottom.enable = true; imv.enable = true; sioyek.enable = true; bat = { enable = true; extraPackages = with pkgs.bat-extras; [ batdiff batman batgrep batwatch ]; }; carapace.enable = true; wlogout.enable = true; swayr.enable = true; yt-dlp.enable = true; mpv.enable = true; jq.enable = true; ripgrep.enable = true; pandoc.enable = true; fzf.enable = true; zoxide.enable = true; }; }
3.4.1.11. nix-index
nix-index provides a way to find out which packages are provided by which derivations. By default it also comes with a replacement for command-not-found.sh
, however, the implementation is based on a channel based setup. I like consistency, so I replace the command with one that provides a flakes-based output.
{ self, pkgs, ... }: { programs.nix-index = let commandNotFound = pkgs.runCommandLocal "command-not-found.sh" { } '' mkdir -p $out/etc/profile.d substitute ${self + /scripts/command-not-found.sh} \ $out/etc/profile.d/command-not-found.sh \ --replace-fail @nix-locate@ ${pkgs.nix-index}/bin/nix-locate \ --replace-fail @tput@ ${pkgs.ncurses}/bin/tput ''; in { enable = true; package = pkgs.symlinkJoin { name = "nix-index"; paths = [ commandNotFound ]; }; }; }
3.4.1.12. password-store
Enables password store with the pass-otp
extension which allows me to store and generate one-time-passwords.
{ pkgs, ... }: { programs.password-store = { enable = true; settings = { PASSWORD_STORE_DIR = "$HOME/.local/share/password-store"; }; package = pkgs.pass.withExtensions (exts: [ exts.pass-otp ]); }; }
3.4.1.13. direnv
Enables direnv, which I use for nearly all of my nix dev flakes.
_: { programs.direnv = { enable = true; silent = true; nix-direnv.enable = true; }; }
3.4.1.14. eza
Eza provides me with a better ls
command and some other useful aliases.
_: { programs.eza = { enable = true; icons = "auto"; git = true; extraOptions = [ "-l" "--group-directories-first" ]; }; }
3.4.1.15. git
Here I set up my git config, automatic signing of commits, useful aliases for my ost used commands (for when I am not using Magit) as well as a git template defined in Linking dotfiles.
{ lib, ... }: { programs.git = { enable = true; aliases = { a = "add"; c = "commit"; cl = "clone"; co = "checkout"; b = "branch"; i = "init"; m = "merge"; s = "status"; r = "restore"; p = "pull"; pp = "push"; }; signing = { key = "0x76FD3810215AE097"; signByDefault = true; }; userEmail = lib.mkDefault "leon.schwarzaeugl@gmail.com"; userName = "Leon Schwarzäugl"; difftastic.enable = true; lfs.enable = true; includes = [ { contents = { github = { user = "Swarsel"; }; commit = { template = "~/.gitmessage"; }; }; } ]; }; }
3.4.1.16. Fuzzel
Here I only need to set basic layout options - the rest is being managed by stylix.
_: { programs.fuzzel = { enable = true; settings = { main = { layer = "overlay"; lines = "10"; width = "40"; }; border.radius = "0"; }; }; }
3.4.1.17. Starship
Starship makes my zsh
look cooler! I have symbols for most programming languages and toolchains, also I build my own powerline.
_: { programs.starship = { enable = true; enableZshIntegration = true; settings = { add_newline = false; format = "$shlvl$character"; right_format = "$all"; command_timeout = 3000; directory.substitutions = { "Documents" = " "; "Downloads" = " "; "Music" = " "; "Pictures" = " "; }; git_status = { style = "bg:#394260"; format = "[[($all_status$ahead_behind)](fg:#769ff0 bg:#394260)]($style) "; }; character = { success_symbol = "[λ](bold green)"; error_symbol = "[λ](bold red)"; }; shlvl = { disabled = false; symbol = "↳"; format = "[$symbol]($style) "; repeat = true; repeat_offset = 1; style = "blue"; }; nix_shell = { disabled = false; heuristic = true; format = "[$symbol$name]($style)"; symbol = " "; }; aws.symbol = " "; buf.symbol = " "; c.symbol = " "; conda.symbol = " "; dart.symbol = " "; directory.read_only = " "; docker_context.symbol = " "; elixir.symbol = " "; elm.symbol = " "; fossil_branch.symbol = " "; git_branch.symbol = " "; golang.symbol = " "; guix_shell.symbol = " "; haskell.symbol = " "; haxe.symbol = " "; hg_branch.symbol = " "; hostname.ssh_symbol = " "; java.symbol = " "; julia.symbol = " "; lua.symbol = " "; memory_usage.symbol = " "; meson.symbol = " "; nim.symbol = " "; nodejs.symbol = " "; os.symbols = { Alpaquita = " "; Alpine = " "; Amazon = " "; Android = " "; Arch = " "; Artix = " "; CentOS = " "; Debian = " "; DragonFly = " "; Emscripten = " "; EndeavourOS = " "; Fedora = " "; FreeBSD = " "; Garuda = " "; Gentoo = " "; HardenedBSD = " "; Illumos = " "; Linux = " "; Mabox = " "; Macos = " "; Manjaro = " "; Mariner = " "; MidnightBSD = " "; Mint = " "; NetBSD = " "; NixOS = " "; OpenBSD = " "; openSUSE = " "; OracleLinux = " "; Pop = " "; Raspbian = " "; Redhat = " "; RedHatEnterprise = " "; Redox = " "; Solus = " "; SUSE = " "; Ubuntu = " "; Unknown = " "; Windows = " "; }; package.symbol = " "; pijul_channel.symbol = " "; python.symbol = " "; rlang.symbol = " "; ruby.symbol = " "; rust.symbol = " "; scala.symbol = " "; }; }; }
3.4.1.18. Kitty
Kitty is the terminal emulator of choice for me, it is nice to configure using nix, fast, and has a nice style.
The theme is handled by stylix.
_: { programs.kitty = { enable = true; keybindings = { }; settings = { scrollback_lines = 10000; enable_audio_bell = false; notify_on_cmd_finish = "always 20"; }; }; }
3.4.1.19. zsh
zsh is the most convenient shell for me and it happens to be super neat to configure within home manager.
Here we set some aliases (some of them should be shellApplications instead) as well as some zsh plugins like fzf-tab
.
{ config, pkgs, lib, ... }: { programs.zsh = { enable = true; shellAliases = lib.recursiveUpdate { hg = "history | grep"; hmswitch = "home-manager --flake ${config.swarselsystems.flakePath}#$(whoami)@$(hostname) switch |& nom"; nswitch = "sudo nixos-rebuild --flake ${config.swarselsystems.flakePath}#$(hostname) --show-trace --log-format internal-json -v switch |& nom --json"; nboot = "sudo nixos-rebuild --flake ${config.swarselsystems.flakePath}#$(hostname) --show-trace --log-format internal-json -v boot |& nom --json"; magit = "emacsclient -nc -e \"(magit-status)\""; config = "git --git-dir=$HOME/.cfg/ --work-tree=$HOME"; g = "git"; c = "git --git-dir=$FLAKE/.git --work-tree=$FLAKE/"; passpush = "cd ~/.local/share/password-store; git add .; git commit -m 'pass file changes'; git push; cd -;"; passpull = "cd ~/.local/share/password-store; git pull; cd -;"; hotspot = "nmcli connection up local; nmcli device wifi hotspot;"; cd = "z"; cd-orig = "cd"; cat-orig = "cat"; cdr = "cd \"$( (find $DOCUMENT_DIR_WORK $DOCUMENT_DIR_PRIV -maxdepth 1 && echo $FLAKE) | fzf )\""; nix-ldd-ldd = "LD_LIBRARY_PATH=$NIX_LD_LIBRARY_PATH ldd"; nix-ldd = "LD_LIBRARY_PATH=$NIX_LD_LIBRARY_PATH ldd"; nix-ldd-locate = "nix-locate --minimal --top-level -w "; nix-store-search = "ls /nix/store | grep"; fs-diff = "sudo mount -o subvol=/ /dev/mapper/cryptroot /mnt ; fs-diff"; lt = "eza -las modified --total-size"; boot-diff = "nix store diff-closures /run/*-system"; gen-diff = "nix profile diff-closures --profile /nix/var/nix/profiles/system"; cc = "wl-copy"; } config.swarselsystems.shellAliases; autosuggestion.enable = true; enableCompletion = true; syntaxHighlighting.enable = true; autocd = false; cdpath = [ "~/.dotfiles" # "~/Documents/GitHub" ]; defaultKeymap = "emacs"; dirHashes = { dl = "$HOME/Downloads"; gh = "$HOME/Documents/GitHub"; }; history = { expireDuplicatesFirst = true; path = "$HOME/.histfile"; save = 10000; size = 10000; }; historySubstringSearch = { enable = true; searchDownKey = "^[OB"; searchUpKey = "^[OA"; }; plugins = [ { name = "fzf-tab"; src = pkgs.zsh-fzf-tab; } ]; initExtra = '' bindkey "^[[1;5D" backward-word bindkey "^[[1;5C" forward-word my-backward-delete-word() { # Copy the global WORDCHARS variable to a local variable. That way any # modifications are scoped to this function only local WORDCHARS=$WORDCHARS # Use bash string manipulation to remove `:` so our delete will stop at it WORDCHARS="''${WORDCHARS//:}" # Use bash string manipulation to remove `/` so our delete will stop at it WORDCHARS="''${WORDCHARS//\/}" # Use bash string manipulation to remove `.` so our delete will stop at it WORDCHARS="''${WORDCHARS//.}" # zle <widget-name> will run an existing widget. zle backward-delete-word } zle -N my-backward-delete-word bindkey '^H' my-backward-delete-word # This will be our `ctrl+alt+w` command my-backward-delete-whole-word() { # Copy the global WORDCHARS variable to a local variable. That way any # modifications are scoped to this function only local WORDCHARS=$WORDCHARS # Use bash string manipulation to add `:` to WORDCHARS if it's not present # already. [[ ! $WORDCHARS == *":"* ]] && WORDCHARS="$WORDCHARS"":" # zle <widget-name> will run that widget. zle backward-delete-word } # `zle -N` will create a new widget that we can use on the command line zle -N my-backward-delete-whole-word # bind this new widget to `ctrl+alt+w` bindkey '^W' my-backward-delete-whole-word ''; }; }
3.4.1.20. zellij
{ self, config, pkgs, ... }: { programs.zellij = { enable = true; }; home.packages = with pkgs; [ zjstatus ]; xdg.configFile = { "zellij/config.kdl".text = import "${self}/programs/zellij/config.kdl.nix" { inherit config; }; "zellij/layouts/default.kdl".text = import "${self}/programs/zellij/layouts/default.kdl.nix" { inherit config pkgs; }; }; }
3.4.1.21. tmux
{ pkgs, ... }: let tmux-super-fingers = pkgs.tmuxPlugins.mkTmuxPlugin { pluginName = "tmux-super-fingers"; version = "unstable-2023-01-06"; src = pkgs.fetchFromGitHub { owner = "artemave"; repo = "tmux_super_fingers"; rev = "2c12044984124e74e21a5a87d00f844083e4bdf7"; sha256 = "sha256-cPZCV8xk9QpU49/7H8iGhQYK6JwWjviL29eWabuqruc="; }; }; in { home.packages = with pkgs; [ lsof sesh ]; programs.tmux = { enable = true; shell = "${pkgs.zsh}/bin/zsh"; terminal = "tmux-256color"; historyLimit = 100000; plugins = with pkgs; [ tmuxPlugins.tmux-thumbs { plugin = tmux-super-fingers; extraConfig = "set -g @super-fingers-key f"; } tmuxPlugins.sensible # must be before continuum edits right status bar { plugin = tmuxPlugins.catppuccin; extraConfig = '' set -g @catppuccin_flavour 'frappe' set -g @catppuccin_window_tabs_enabled on set -g @catppuccin_date_time "%H:%M" ''; } { plugin = tmuxPlugins.resurrect; extraConfig = '' set -g @resurrect-strategy-vim 'session' set -g @resurrect-strategy-nvim 'session' set -g @resurrect-capture-pane-contents 'on' ''; } { plugin = tmuxPlugins.continuum; extraConfig = '' set -g @continuum-restore 'on' set -g @continuum-boot 'on' set -g @continuum-save-interval '10' ''; } tmuxPlugins.better-mouse-mode tmuxPlugins.yank ]; extraConfig = '' set -g default-terminal "tmux-256color" set -ag terminal-overrides ",xterm-256color:RGB" set-option -g prefix C-a unbind-key C-b bind-key C-a send-prefix set -g mouse on # Open new split at cwd of current split bind | split-window -h -c "#{pane_current_path}" bind - split-window -v -c "#{pane_current_path}" # Use vim keybindings in copy mode set-window-option -g mode-keys vi # v in copy mode starts making selection bind-key -T copy-mode-vi v send-keys -X begin-selection bind-key -T copy-mode-vi C-v send-keys -X rectangle-toggle bind-key -T copy-mode-vi y send-keys -X copy-selection-and-cancel # Escape turns on copy mode bind Escape copy-mode set-option -g status-position top # make Prefix p paste the buffer. unbind p bind p paste-buffer ''; }; }
3.4.1.22. Mail
Normally I use 4 mail accounts - here I set them all up. Three of them are Google accounts (sadly), which are a chore to setup. The last is just a sender account that I setup SMTP for here.
{ lib, config, ... }: { programs.mbsync = lib.mkIf (!config.swarselsystems.isPublic) { enable = true; }; services.mbsync = lib.mkIf (!config.swarselsystems.isPublic) { enable = true; }; # this is needed so that mbsync can use the passwords from sops systemd.user.services.mbsync.Unit.After = lib.mkIf (!config.swarselsystems.isPublic) [ "sops-nix.service" ]; programs.msmtp = lib.mkIf (!config.swarselsystems.isPublic) { enable = true; }; programs.mu = lib.mkIf (!config.swarselsystems.isPublic) { enable = true; }; accounts.email = lib.mkIf (!config.swarselsystems.isPublic) { maildirBasePath = "Mail"; accounts.leon = { primary = true; address = "leon.schwarzaeugl@gmail.com"; userName = "leon.schwarzaeugl@gmail.com"; realName = "Leon Schwarzäugl"; passwordCommand = "cat ${config.sops.secrets.leon.path}"; gpg = { key = "0x76FD3810215AE097"; signByDefault = true; }; imap.host = "imap.gmail.com"; smtp.host = "smtp.gmail.com"; mu.enable = true; msmtp = { enable = true; }; mbsync = { enable = true; create = "maildir"; expunge = "both"; patterns = [ "*" "![Gmail]*" "[Gmail]/Sent Mail" "[Gmail]/Starred" "[Gmail]/All Mail" ]; extraConfig = { channel = { Sync = "All"; }; account = { Timeout = 120; PipelineDepth = 1; }; }; }; }; accounts.swarsel = lib.mkIf (!config.swarselsystems.isPublic) { address = "leon@swarsel.win"; userName = "8227dc594dd515ce232eda1471cb9a19"; realName = "Leon Schwarzäugl"; passwordCommand = "cat ${config.sops.secrets.swarselmail.path}"; smtp = { host = "in-v3.mailjet.com"; port = 587; tls = { enable = true; useStartTls = true; }; }; mu.enable = false; msmtp = { enable = true; }; mbsync = { enable = false; }; }; accounts.nautilus = lib.mkIf (!config.swarselsystems.isPublic) { primary = false; address = "nautilus.dw@gmail.com"; userName = "nautilus.dw@gmail.com"; realName = "Nautilus"; passwordCommand = "cat ${config.sops.secrets.nautilus.path}"; imap.host = "imap.gmail.com"; smtp.host = "smtp.gmail.com"; msmtp.enable = true; mu.enable = true; mbsync = { enable = true; create = "maildir"; expunge = "both"; patterns = [ "*" "![Gmail]*" "[Gmail]/Sent Mail" "[Gmail]/Starred" "[Gmail]/All Mail" ]; extraConfig = { channel = { Sync = "All"; }; account = { Timeout = 120; PipelineDepth = 1; }; }; }; }; accounts.mrswarsel = lib.mkIf (!config.swarselsystems.isPublic) { primary = false; address = "mrswarsel@gmail.com"; userName = "mrswarsel@gmail.com"; realName = "Swarsel"; passwordCommand = "cat ${config.sops.secrets.mrswarsel.path}"; imap.host = "imap.gmail.com"; smtp.host = "smtp.gmail.com"; msmtp.enable = true; mu.enable = true; mbsync = { enable = true; create = "maildir"; expunge = "both"; patterns = [ "*" "![Gmail]*" "[Gmail]/Sent Mail" "[Gmail]/Starred" "[Gmail]/All Mail" ]; extraConfig = { channel = { Sync = "All"; }; account = { Timeout = 120; PipelineDepth = 1; }; }; }; }; }; }
3.4.1.23. Home-manager: Emacs
By using the emacs-overlay NixOS module, I can install all Emacs packages that I want to use right through NixOS. This is done by passing my init.el
file to the configuration which will then be parsed upon system rebuild, looking for use-package
sections in the Elisp code. Also I define here the style of Emacs that I want to run - I am going with native Wayland Emacs here (emacs-pgtk
). All of the nice options such as tree-sitter
support are enabled by default, so I do not need to adjust the build process.
Lastly, I am defining some more packages here that the parser has problems finding. Also there are some packages that are not in ELPA or MELPA that I still want to use, like calfw
and fast-scroll
, so I build them here.
{ self, lib, config, pkgs, ... }: { # needed for elfeed sops.secrets.fever = lib.mkIf (!config.swarselsystems.isPublic) { path = "${config.home.homeDirectory}/.emacs.d/.fever"; }; # enable emacs overlay for bleeding edge features # also read init.el file and install use-package packages programs.emacs = { enable = true; package = pkgs.emacsWithPackagesFromUsePackage { config = self + /programs/emacs/init.el; package = pkgs.emacs-pgtk; alwaysEnsure = true; alwaysTangle = true; extraEmacsPackages = epkgs: [ epkgs.mu4e epkgs.use-package epkgs.lsp-bridge epkgs.doom-themes epkgs.vterm epkgs.treesit-grammars.with-all-grammars # build the rest of the packages myself # org-calfw is severely outdated on MELPA and throws many warnings on emacs startup # build the package from the haji-ali fork, which is well-maintained (epkgs.trivialBuild rec { pname = "eglot-booster"; version = "main-29-10-2024"; src = pkgs.fetchFromGitHub { owner = "jdtsmith"; repo = "eglot-booster"; rev = "e6daa6bcaf4aceee29c8a5a949b43eb1b89900ed"; hash = "sha256-PLfaXELkdX5NZcSmR1s/kgmU16ODF8bn56nfTh9g6bs="; }; packageRequires = [ epkgs.jsonrpc epkgs.eglot ]; }) (epkgs.trivialBuild rec { pname = "calfw"; version = "1.0.0-20231002"; src = pkgs.fetchFromGitHub { owner = "haji-ali"; repo = "emacs-calfw"; rev = "bc99afee611690f85f0cd0bd33300f3385ddd3d3"; hash = "sha256-0xMII1KJhTBgQ57tXJks0ZFYMXIanrOl9XyqVmu7a7Y="; }; packageRequires = [ epkgs.howm ]; }) (epkgs.trivialBuild rec { pname = "fast-scroll"; version = "1.0.0-20191016"; src = pkgs.fetchFromGitHub { owner = "ahungry"; repo = "fast-scroll"; rev = "3f6ca0d5556fe9795b74714304564f2295dcfa24"; hash = "sha256-w1wmJW7YwXyjvXJOWdN2+k+QmhXr4IflES/c2bCX3CI="; }; packageRequires = [ ]; }) ]; }; }; services.emacs = { enable = true; # socketActivation.enable = false; # startWithUserSession = "graphical"; }; }
3.4.1.24. Waybar
Again I am just using the first bar option here that I was able to find good understandable documentation for. Of note is that the `cpu` section's `format` is not defined here, but in section 1 (since not every machine has the same number of cores)
The rest of the related configuration is found here:
{ self, config, lib, ... }: { programs.waybar = { enable = true; systemd = { enable = true; target = "sway-sessions.target"; }; settings = { mainBar = { ipc = true; id = "bar-0"; layer = "top"; position = "top"; modules-left = [ "sway/workspaces" "custom/outer-right-arrow-dark" "sway/window" ]; modules-center = [ "sway/mode" "privacy" "custom/github" "custom/configwarn" "custom/nix-updates" ]; "sway/mode" = { format = "<span style=\"italic\" font-weight=\"bold\">{}</span>"; }; modules-right = config.swarselsystems.waybarModules; "custom/pseudobat" = lib.mkIf (!config.swarselsystems.isLaptop) { format = ""; on-click-right = "wlogout -p layer-shell"; }; "custom/configwarn" = { exec = "waybarupdate"; interval = 60; }; "custom/scratchpad-indicator" = { interval = 3; exec = "swaymsg -t get_tree | jq 'recurse(.nodes[]) | first(select(.name==\"__i3_scratch\")) | .floating_nodes | length | select(. >= 1)'"; format = "{} "; on-click = "swaymsg 'scratchpad show'"; on-click-right = "swaymsg 'move scratchpad'"; }; "custom/github" = { format = "{} "; return-type = "json"; interval = 60; exec = "github-notifications"; on-click = "xdg-open https://github.com/notifications"; }; # "custom/nix-updates" = { # exec = "update-checker"; # on-click = "update-checker && notify-send 'The system has been updated'"; # interval = "once"; # tooltip = true; # return-type = "json"; # format = "{} {icon}"; # format-icon = { # "has-updates" = ""; # "updated" = " "; # }; # }; idle_inhibitor = { format = "{icon}"; format-icons = { activated = ""; deactivated = ""; }; }; "group/hardware" = { orientation = "inherit"; drawer = { "transition-left-to-right" = false; }; modules = [ "tray" "temperature" "power-profiles-daemon" "custom/left-arrow-light" "custom/left-arrow-dark" "custom/scratchpad-indicator" "custom/left-arrow-light" "disk" "custom/left-arrow-dark" "memory" "custom/left-arrow-light" "cpu" "custom/left-arrow-dark" "backlight/slider" "idle_inhibitor" ]; }; "backlight/slider" = { min = 0; max = 100; orientation = "horizontal"; device = "intel_backlight"; }; power-profiles-daemon = { format = "{icon}"; tooltip-format = "Power profile: {profile}\nDriver: {driver}"; tooltip = true; format-icons = { "default" = ""; "performance" = ""; "balanced" = ""; "power-saver" = ""; }; }; temperature = { hwmon-path = lib.mkIf (!config.swarselsystems.temperatureHwmon.isAbsolutePath) config.swarselsystems.temperatureHwmon.path; hwmon-path-abs = lib.mkIf config.swarselsystems.temperatureHwmon.isAbsolutePath config.swarselsystems.temperatureHwmon.path; input-filename = lib.mkIf config.swarselsystems.temperatureHwmon.isAbsolutePath config.swarselsystems.temperatureHwmon.input-filename; critical-threshold = 80; format-critical = " {temperatureC}°C"; format = " {temperatureC}°C"; }; mpris = { format = "{player_icon} {title} <small>[{position}/{length}]</small>"; format-paused = "{player_icon} <i>{title} <small>[{position}/{length}]</small></i>"; player-icons = { "default" = "▶ "; "mpv" = "🎵 "; "spotify" = " "; }; status-icons = { "paused" = " "; }; interval = 1; title-len = 20; artist-len = 20; album-len = 10; }; "custom/left-arrow-dark" = { format = ""; tooltip = false; }; "custom/outer-left-arrow-dark" = { format = ""; tooltip = false; }; "custom/left-arrow-light" = { format = ""; tooltip = false; }; "custom/right-arrow-dark" = { format = ""; tooltip = false; }; "custom/outer-right-arrow-dark" = { format = ""; tooltip = false; }; "custom/right-arrow-light" = { format = ""; tooltip = false; }; "sway/workspaces" = { disable-scroll = true; format = "{name}"; }; "clock#1" = { min-length = 8; interval = 1; format = "{:%H:%M:%S}"; # on-click-right= "gnome-clocks"; tooltip-format = "<big>{:%Y %B}</big>\n<tt><small>{calendar}</small></tt>"; }; "clock#2" = { format = "{:%d. %B %Y}"; # on-click-right= "gnome-clocks"; tooltip-format = "<big>{:%Y %B}</big>\n<tt><small>{calendar}</small></tt>"; }; pulseaudio = { format = "{icon} {volume:2}%"; format-bluetooth = "{icon} {volume}%"; format-muted = "MUTE"; format-icons = { headphones = ""; default = [ "" "" ]; }; scroll-step = 1; on-click = "pamixer -t"; on-click-right = "pavucontrol"; }; memory = { interval = 5; format = " {}%"; tooltip-format = "Memory: {used:0.1f}G/{total:0.1f}G\nSwap: {swapUsed}G/{swapTotal}G"; }; cpu = { format = config.swarselsystems.cpuString; min-length = 6; interval = 5; format-icons = [ "▁" "▂" "▃" "▄" "▅" "▆" "▇" "█" ]; # on-click-right= "com.github.stsdc.monitor"; on-click-right = "kitty -o confirm_os_window_close=0 btm"; }; "custom/vpn" = { format = "()"; exec = "echo '{\"class\": \"connected\"}'"; exec-if = "test -d /proc/sys/net/ipv4/conf/tun0"; return-type = "json"; interval = 5; }; battery = { states = { "warning" = 60; "error" = 30; "critical" = 15; }; interval = 5; format = "{icon} {capacity}%"; format-charging = "{capacity}% "; format-plugged = "{capacity}% "; format-icons = [ "" "" "" "" "" ]; on-click-right = "wlogout -p layer-shell"; }; disk = { interval = 30; format = "Disk {percentage_used:2}%"; path = "/"; states = { "warning" = 80; "critical" = 90; }; tooltip-format = "{used} used out of {total} on {path} ({percentage_used}%)\n{free} free on {path} ({percentage_free}%)"; }; tray = { icon-size = 20; }; network = { interval = 5; format-wifi = "{signalStrength}% "; format-ethernet = ""; format-linked = "{ifname} (No IP) "; format-disconnected = "Disconnected ⚠"; format-alt = "{ifname}: {ipaddr}/{cidr}"; tooltip-format-ethernet = "{ifname} via {gwaddr}: {essid} {ipaddr}/{cidr}\n\n⇡{bandwidthUpBytes} ⇣{bandwidthDownBytes}"; tooltip-format-wifi = "{ifname} via {gwaddr}: {essid} {ipaddr}/{cidr} \n{signaldBm}dBm @ {frequency}MHz\n\n⇡{bandwidthUpBytes} ⇣{bandwidthDownBytes}"; }; }; }; style = builtins.readFile (self + /programs/waybar/style.css); }; }
3.4.1.25. Firefox
Setting up firefox along with some policies that are important to me (mostly disabling telemetry related stuff as well as Pocket). I also enable some integrations that enable super useful packages, namely tridactyl
and browserpass
.
Also, using NUR with rycee's firefox addons, it is very convenient for me to add firefox addons here that will be automatically installed.
Also, I setup some search aliases for functions I often use, such as NixOS options search (@no
)
I used to build the firefox addon bypass-paywalls-clean
myself here, but the maintainer always deletes old packages, and it became a chore for me to maintain here, so I no longer do that.
{ self, pkgs, lib, ... }: let lock-false = { Value = false; Status = "locked"; }; lock-true = { Value = true; Status = "locked"; }; in { programs.firefox = { enable = true; package = pkgs.firefox; # uses overrides policies = { # CaptivePortal = false; AppAutoUpdate = false; BackgroundAppUpdate = false; DisableBuiltinPDFViewer = true; DisableFirefoxStudies = true; DisablePocket = true; DisableFirefoxScreenshots = true; DisableTelemetry = true; DisableFirefoxAccounts = false; DisableProfileImport = true; DisableProfileRefresh = true; DisplayBookmarksToolbar = "always"; DontCheckDefaultBrowser = true; NoDefaultBookmarks = true; OfferToSaveLogins = false; OfferToSaveLoginsDefault = false; PasswordManagerEnabled = false; DisableMasterPasswordCreation = true; ExtensionUpdate = false; EnableTrackingProtection = { Value = true; Locked = true; Cryptomining = true; Fingerprinting = true; EmailTracking = true; # Exceptions = ["https://example.com"] }; PDFjs = { Enabled = false; EnablePermissions = false; }; Handlers = { mimeTypes."application/pdf".action = "saveToDisk"; }; extensions = { pdf = { action = "useHelperApp"; ask = true; handlers = [ { name = "GNOME Document Viewer"; path = "${pkgs.evince}/bin/evince"; } ]; }; }; FirefoxHome = { Search = true; TopSites = true; SponsoredTopSites = false; Highlights = true; Pocket = false; SponsoredPocket = false; Snippets = false; Locked = true; }; FirefoxSuggest = { WebSuggestions = false; SponsoredSuggestions = false; ImproveSuggest = false; Locked = true; }; SanitizeOnShutdown = { Cache = true; Cookies = false; Downloads = true; FormData = true; History = false; Sessions = false; SiteSettings = false; OfflineApps = true; Locked = true; }; SearchEngines = { PreventInstalls = true; Remove = [ "Bing" # Fuck you ]; }; UserMessaging = { ExtensionRecommendations = false; # Don’t recommend extensions while the user is visiting web pages FeatureRecommendations = false; # Don’t recommend browser features Locked = true; # Prevent the user from changing user messaging preferences MoreFromMozilla = false; # Don’t show the “More from Mozilla” section in Preferences SkipOnboarding = true; # Don’t show onboarding messages on the new tab page UrlbarInterventions = false; # Don’t offer suggestions in the URL bar WhatsNew = false; # Remove the “What’s New” icon and menuitem }; ExtensionSettings = { "3rdparty".Extensions = { # https://github.com/gorhill/uBlock/blob/master/platform/common/managed_storage.json "uBlock0@raymondhill.net".adminSettings = { userSettings = rec { uiTheme = "dark"; uiAccentCustom = true; uiAccentCustom0 = "#0C8084"; cloudStorageEnabled = lib.mkForce false; importedLists = [ "https://filters.adtidy.org/extension/ublock/filters/3.txt" "https://github.com/DandelionSprout/adfilt/raw/master/LegitimateURLShortener.txt" ]; externalLists = lib.concatStringsSep "\n" importedLists; }; selectedFilterLists = [ "CZE-0" "adguard-generic" "adguard-annoyance" "adguard-social" "adguard-spyware-url" "easylist" "easyprivacy" "https://github.com/DandelionSprout/adfilt/raw/master/LegitimateURLShortener.txt" "plowe-0" "ublock-abuse" "ublock-badware" "ublock-filters" "ublock-privacy" "ublock-quick-fixes" "ublock-unbreak" "urlhaus-1" ]; }; }; }; }; profiles.default = { id = 0; isDefault = true; userChrome = builtins.readFile (self + /programs/firefox/chrome/userChrome.css); extensions = { packages = with pkgs.nur.repos.rycee.firefox-addons; [ tridactyl tampermonkey sidebery browserpass clearurls darkreader enhancer-for-youtube istilldontcareaboutcookies translate-web-pages ublock-origin reddit-enhancement-suite sponsorblock web-archives single-file widegithub enhanced-github unpaywall don-t-fuck-with-paste plasma-integration # configure the default the same as trusted in order not to be annoyed noscript # configure a shortcut 'ctrl+shift+c' with behaviour 'do nothing' in order to disable the dev console shortcut (buildFirefoxXpiAddon { pname = "shortkeys"; version = "4.0.2"; addonId = "Shortkeys@Shortkeys.com"; url = "https://addons.mozilla.org/firefox/downloads/file/3673761/shortkeys-4.0.2.xpi"; sha256 = "c6fe12efdd7a871787ac4526eea79ecc1acda8a99724aa2a2a55c88a9acf467c"; meta = with lib; { description = "Easily customizable custom keyboard shortcuts for Firefox. To configure this addon go to Addons (ctrl+shift+a) ->Shortkeys ->Options. Report issues here (please specify that the issue is found in Firefox): https://github.com/mikecrittenden/shortkeys"; mozPermissions = [ "tabs" "downloads" "clipboardWrite" "browsingData" "storage" "bookmarks" "sessions" "<all_urls>" ]; platforms = platforms.all; }; }) ]; }; settings = { "extensions.autoDisableScopes" = 0; "browser.startup.homepage" = "https://outlook.office.com|https://satellite.vbc.ac.at|https://bitbucket.vbc.ac.at|https://github.com"; "browser.bookmarks.showMobileBookmarks" = lock-true; "toolkit.legacyUserProfileCustomizations.stylesheets" = lock-true; "browser.search.suggest.enabled" = lock-false; "browser.search.suggest.enabled.private" = lock-false; "browser.urlbar.suggest.searches" = lock-false; "browser.urlbar.showSearchSuggestionsFirst" = lock-false; "browser.topsites.contile.enabled" = lock-false; "browser.newtabpage.activity-stream.feeds.section.topstories" = lock-false; "browser.newtabpage.activity-stream.feeds.snippets" = lock-false; "browser.newtabpage.activity-stream.section.highlights.includePocket" = lock-false; "browser.newtabpage.activity-stream.section.highlights.includeBookmarks" = lock-false; "browser.newtabpage.activity-stream.section.highlights.includeDownloads" = lock-false; "browser.newtabpage.activity-stream.section.highlights.includeVisited" = lock-false; "browser.newtabpage.activity-stream.showSponsored" = lock-false; "browser.newtabpage.activity-stream.system.showSponsored" = lock-false; "browser.newtabpage.activity-stream.showSponsoredTopSites" = lock-false; }; search = { default = "Kagi"; privateDefault = "Kagi"; engines = { "Kagi" = { urls = [{ template = "https://kagi.com/search"; params = [ { name = "q"; value = "{searchTerms}"; } ]; }]; iconUpdateURL = "https://kagi.com/favicon.ico"; updateInterval = 24 * 60 * 60 * 1000; # every day definedAliases = [ "@k" ]; }; "Nix Packages" = { urls = [{ template = "https://search.nixos.org/packages"; params = [ { name = "type"; value = "packages"; } { name = "query"; value = "{searchTerms}"; } ]; }]; icon = "${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg"; definedAliases = [ "@np" ]; }; "NixOS Wiki" = { urls = [{ template = "https://nixos.wiki/index.php?search={searchTerms}"; }]; iconUpdateURL = "https://nixos.wiki/favicon.png"; updateInterval = 24 * 60 * 60 * 1000; # every day definedAliases = [ "@nw" ]; }; "NixOS Options" = { urls = [{ template = "https://search.nixos.org/options"; params = [ { name = "query"; value = "{searchTerms}"; } ]; }]; icon = "${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg"; definedAliases = [ "@no" ]; }; "Home Manager Options" = { urls = [{ template = "https://home-manager-options.extranix.com/"; params = [ { name = "query"; value = "{searchTerms}"; } ]; }]; icon = "${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg"; definedAliases = [ "@hm" "@ho" "@hmo" ]; }; "Google".metaData.alias = "@g"; }; force = true; # this is required because otherwise the search.json.mozlz4 symlink gets replaced on every firefox restart }; }; }; }
3.4.1.26. Services
Services that can be defined through home-manager should be defined here.
3.4.1.26.1. gnome-keyring
Used for storing sessions in e.g. Nextcloud
{ lib, config, ... }: { services.gnome-keyring = lib.mkIf (!config.swarselsystems.isNixos) { enable = true; }; }
3.4.1.26.2. KDE Connect
This enables phone/computer communication, including sending clipboard, files etc. Sadly on Wayland many of the features are broken (like remote control).
_: { services.kdeconnect = { enable = true; indicator = true; }; }
3.4.1.26.3. Mako
Desktop notifications!
The `extraConfig` section here CANNOT be reindented. This has something to do with how nix handles multiline strings, when indented Mako will fail to start. This might be a mako bug as well.
_: { services.mako = { enable = true; # backgroundColor = "#2e3440"; # borderColor = "#88c0d0"; borderRadius = 15; borderSize = 1; defaultTimeout = 5000; height = 150; icons = true; ignoreTimeout = true; layer = "overlay"; maxIconSize = 64; sort = "-time"; width = 300; # font = "monospace 10"; extraConfig = '' [urgency=low] border-color=#cccccc [urgency=normal] border-color=#d08770 [urgency=high] border-color=#bf616a default-timeout=3000 [category=mpd] default-timeout=2000 group-by=category ''; }; }
3.4.1.26.4. yubikey-touch-detector
{ pkgs, ... }: { systemd.user.services.yubikey-touch-detector = { Unit = { Description = "Detects when your YubiKey is waiting for a touch"; Requires = [ "yubikey-touch-detector.socket" ]; }; Service = { ExecStart = "${pkgs.yubikey-touch-detector}/bin/yubikey-touch-detector --libnotify"; EnvironmentFile = "-%E/yubikey-touch-detector/service.conf"; }; Install = { Also = [ "yubikey-touch-detector.socket" ]; WantedBy = [ "default.target" ]; }; }; systemd.user.sockets.yubikey-touch-detector = { Unit = { Description = "Unix socket activation for YubiKey touch detector service"; }; Socket = { ListenStream = "%t/yubikey-touch-detector.socket"; RemoveOnStop = true; }; Install = { WantedBy = [ "sockets.target" ]; }; }; }
3.4.1.27. Sway
I am currently using SwayFX, which adds some nice effects to sway, like rounded corners and hiding the separator between title and content of a window.
Currently, I am too lazy to explain every option here, but most of it is very self-explaining in any case.
{ config, lib, ... }: let inherit (config.swarselsystems) monitors; workplaceSets = lib.mapAttrs' lib.swarselsystems.eachOutput monitors; workplaceOutputs = map (key: lib.getAttr key workplaceSets) (lib.attrNames workplaceSets); in { wayland.windowManager.sway = { enable = true; checkConfig = false; # delete this line once SwayFX is fixed upstream package = lib.mkIf config.swarselsystems.isNixos null; systemd = { enable = true; xdgAutostart = true; }; wrapperFeatures.gtk = true; config = rec { modifier = "Mod4"; # terminal = "kitty"; menu = "fuzzel"; bars = [{ command = "waybar"; mode = "hide"; hiddenState = "hide"; position = "top"; extraConfig = "modifier Mod4"; }]; keybindings = let inherit (config.wayland.windowManager.sway.config) modifier; in lib.recursiveUpdate { "${modifier}+q" = "kill"; "${modifier}+f" = "exec firefox"; "${modifier}+Shift+f" = "exec swaymsg fullscreen"; "${modifier}+Space" = "exec fuzzel"; "${modifier}+Shift+Space" = "floating toggle"; "${modifier}+e" = "exec emacsclient -nquc -a emacs -e \"(dashboard-open)\""; "${modifier}+Shift+m" = "exec emacsclient -nquc -a emacs -e \"(mu4e)\""; "${modifier}+Shift+c" = "exec emacsclient -nquc -a emacs -e \"(swarsel/open-calendar)\""; "${modifier}+m" = "exec swaymsg workspace back_and_forth"; "${modifier}+a" = "exec swarselcheck -s"; "${modifier}+x" = "exec swarselcheck -k"; "${modifier}+d" = "exec swarselcheck -d"; "${modifier}+w" = "exec swarselcheck -e"; "${modifier}+Shift+t" = "exec opacitytoggle"; "${modifier}+Shift+F12" = "move scratchpad"; "${modifier}+F12" = "scratchpad show"; "${modifier}+c" = "exec qalculate-gtk"; "${modifier}+p" = "exec pass-fuzzel"; "${modifier}+o" = "exec pass-fuzzel --otp"; "${modifier}+Shift+p" = "exec pass-fuzzel --type"; "${modifier}+Shift+o" = "exec pass-fuzzel --otp --type"; "${modifier}+Ctrl+p" = "exec 1password --quick-acces"; "${modifier}+Escape" = "mode $exit"; "${modifier}+Shift+Escape" = "exec kitty -o confirm_os_window_close=0 btm"; "${modifier}+h" = "exec hyprpicker | wl-copy"; "${modifier}+s" = "exec grim -g \"$(slurp)\" -t png - | wl-copy -t image/png"; "${modifier}+Shift+s" = "exec slurp | grim -g - Pictures/Screenshots/$(date +'screenshot_%Y-%m-%d-%H%M%S.png')"; "${modifier}+Shift+v" = "exec wf-recorder -g '$(slurp -f %o -or)' -f ~/Videos/screenrecord_$(date +%Y-%m-%d-%H%M%S).mkv"; "${modifier}+1" = "workspace 1:一"; "${modifier}+Shift+1" = "move container to workspace 1:一"; "${modifier}+2" = "workspace 2:二"; "${modifier}+Shift+2" = "move container to workspace 2:二"; "${modifier}+3" = "workspace 3:三"; "${modifier}+Shift+3" = "move container to workspace 3:三"; "${modifier}+4" = "workspace 4:四"; "${modifier}+Shift+4" = "move container to workspace 4:四"; "${modifier}+5" = "workspace 5:五"; "${modifier}+Shift+5" = "move container to workspace 5:五"; "${modifier}+6" = "workspace 6:六"; "${modifier}+Shift+6" = "move container to workspace 6:六"; "${modifier}+7" = "workspace 7:七"; "${modifier}+Shift+7" = "move container to workspace 7:七"; "${modifier}+8" = "workspace 8:八"; "${modifier}+Shift+8" = "move container to workspace 8:八"; "${modifier}+9" = "workspace 9:九"; "${modifier}+Shift+9" = "move container to workspace 9:九"; "${modifier}+0" = "workspace 10:十"; "${modifier}+Shift+0" = "move container to workspace 10:十"; "${modifier}+Ctrl+m" = "workspace 11:M"; "${modifier}+Ctrl+Shift+m" = "move container to workspace 11:M"; "${modifier}+Ctrl+s" = "workspace 12:S"; "${modifier}+Ctrl+Shift+s" = "move container to workspace 12:S"; "${modifier}+Ctrl+e" = "workspace 13:E"; "${modifier}+Ctrl+Shift+e" = "move container to workspace 13:E"; "${modifier}+Ctrl+t" = "workspace 14:T"; "${modifier}+Ctrl+Shift+t" = "move container to workspace 14:T"; "${modifier}+Ctrl+l" = "workspace 15:L"; "${modifier}+Ctrl+Shift+l" = "move container to workspace 15:L"; "${modifier}+Ctrl+f" = "workspace 16:F"; "${modifier}+Ctrl+Shift+f" = "move container to workspace 16:F"; "${modifier}+Left" = "focus left"; "${modifier}+Right" = "focus right"; "${modifier}+Down" = "focus down"; "${modifier}+Up" = "focus up"; "${modifier}+Shift+Left" = "move left 40px"; "${modifier}+Shift+Right" = "move right 40px"; "${modifier}+Shift+Down" = "move down 40px"; "${modifier}+Shift+Up" = "move up 40px"; "${modifier}+Ctrl+Shift+c" = "reload"; "${modifier}+Ctrl+Shift+r" = "exec swarsel-displaypower"; "${modifier}+Shift+e" = "exec swaynag -t warning -m 'You pressed the exit shortcut. Do you really want to exit sway? This will end your Wayland session.' -b 'Yes, exit sway' 'swaymsg exit'"; "${modifier}+r" = "mode resize"; "${modifier}+Return" = "exec swarselzellij"; "${modifier}+Print" = "exec screenshare"; # "XF86AudioRaiseVolume" = "exec pa 5%"; "XF86AudioRaiseVolume" = "exec pamixer -i 5"; # "XF86AudioLowerVolume" = "exec pactl set-sink-volume @DEFAULT_SINK@ -5%"; "XF86AudioLowerVolume" = "exec pamixer -d 5"; # "XF86AudioMute" = "exec pactl set-sink-mute @DEFAULT_SINK@ toggle"; "XF86AudioMute" = "exec pamixer -t"; "XF86MonBrightnessUp" = "exec brightnessctl set +5%"; "XF86MonBrightnessDown" = "exec brightnessctl set 5%-"; "XF86Display" = "exec wl-mirror eDP-1"; } config.swarselsystems.keybindings; modes = { resize = { Down = "resize grow height 10 px or 10 ppt"; Escape = "mode default"; Left = "resize shrink width 10 px or 10 ppt"; Return = "mode default"; Right = "resize grow width 10 px or 10 ppt"; Up = "resize shrink height 10 px or 10 ppt"; Tab = "move position center, resize set width 50 ppt height 50 ppt"; }; }; defaultWorkspace = "workspace 1:一"; output = lib.mapAttrs' lib.swarselsystems.eachMonitor monitors; input = config.swarselsystems.standardinputs; workspaceOutputAssign = workplaceOutputs; startup = config.swarselsystems.startup ++ [ { command = "kitty -T kittyterm -o confirm_os_window_close=0 zellij attach --create kittyterm"; } { command = "sleep 60; kitty -T spotifytui -o confirm_os_window_close=0 spotify_player"; } ]; seat = { "*" = { hide_cursor = "when-typing enable"; }; }; window = { border = 1; titlebar = false; }; assigns = { "15:L" = [{ app_id = "teams-for-linux"; }]; }; floating = { border = 1; criteria = [ { app_id = "qalculate-gtk"; } { app_id = "blueman"; } { app_id = "pavucontrol"; } { app_id = "syncthingtray"; } { app_id = "Element"; } { class = "1Password"; } { app_id = "com.nextcloud.desktopclient.nextcloud"; } { title = "(?:Open|Save) (?:File|Folder|As)"; } { title = "^Add$"; } { title = "^Picture-in-Picture$"; } { title = "Syncthing Tray"; } { app_id = "vesktop"; } { window_role = "pop-up"; } { window_role = "bubble"; } { window_role = "dialog"; } { window_role = "task_dialog"; } { window_role = "menu"; } { window_role = "Preferences"; } ]; titlebar = false; }; window = { commands = [ { command = "opacity 0.95"; criteria = { class = ".*"; }; } { command = "opacity 1"; criteria = { app_id = "Gimp-2.10"; }; } { command = "opacity 0.99"; criteria = { app_id = "firefox"; }; } { command = "opacity 0.99"; criteria = { app_id = "chromium-browser"; }; } { command = "sticky enable, shadows enable"; criteria = { title = "^Picture-in-Picture$"; }; } { command = "resize set width 60 ppt height 60 ppt, opacity 0.8, sticky enable, border normal, move container to scratchpad"; criteria = { title = "^kittyterm$"; }; } { command = "resize set width 60 ppt height 60 ppt, opacity 0.95, sticky enable, border normal, move container to scratchpad"; criteria = { title = "^spotifytui$"; }; } { command = "resize set width 60 ppt height 60 ppt, sticky enable, move container to scratchpad"; criteria = { class = "Spotify"; }; } { command = "resize set width 60 ppt height 60 ppt, sticky enable"; criteria = { app_id = "vesktop"; }; } { command = "resize set width 60 ppt height 60 ppt, sticky enable"; criteria = { class = "Element"; }; } # { # command = "resize set width 60 ppt height 60 ppt, sticky enable, move container to scratchpad"; # criteria = { # app_id="^$"; # class="^$"; # }; # } ]; }; gaps = { inner = 5; }; }; extraSessionCommands = '' export SDL_VIDEODRIVER=wayland export QT_QPA_PLATFORM=wayland export QT_WAYLAND_DISABLE_WINDOWDECORATION="1" export _JAVA_AWT_WM_NONREPARENTING=1 export XDG_CURRENT_DESKTOP=sway export XDG_SESSION_DESKTOP=sway export QTWEBENGINE_CHROMIUM_FLAGS="--no-sandbox"; export ANKI_WAYLAND=1; export OBSIDIAN_USE_WAYLAND=1; ''; # extraConfigEarly = " # exec systemctl --user import-environment DISPLAY WAYLAND_DISPLAY SWAYSOCK # exec hash dbus-update-activation-environment 2>/dev/null && dbus-update-activation-environment --systemd DISPLAY WAYLAND_DISPLAY SWAYSOCK # "; extraConfig = let inherit (config.wayland.windowManager.sway.config) modifier; swayfxSettings = config.swarselsystems.swayfxConfig; in " exec_always autotiling set $exit \"exit: [s]leep, [l]ock, [p]oweroff, [r]eboot, [u]ser logout\" mode $exit { bindsym --to-code { s exec \"systemctl suspend\", mode \"default\" l exec \"swaylock --screenshots --clock --effect-blur 7x5 --effect-vignette 0.5:0.5 --fade-in 0.2 --daemonize\" p exec \"systemctl poweroff\" r exec \"systemctl reboot\" u exec \"swaymsg exit\" Return mode \"default\" Escape mode \"default\" ${modifier}+Escape mode \"default\" } } exec systemctl --user import-environment exec swayidle -w seat * hide_cursor 2000 ${swayfxSettings} "; }; }
3.4.1.28. gpg-agent
Settinfs that are needed for the gpg-agent. Also we are enabling emacs support for unlocking my Yubikey here.
{ self, pkgs, ... }: { services.gpg-agent = { enable = true; enableSshSupport = true; enableExtraSocket = true; pinentryPackage = pkgs.pinentry.gtk2; defaultCacheTtl = 600; maxCacheTtl = 7200; extraConfig = '' allow-loopback-pinentry allow-emacs-pinentry ''; sshKeys = [ "4BE7925262289B476DBBC17B76FD3810215AE097" ]; }; programs.gpg = { enable = true; publicKeys = [ { source = "${self}/secrets/keys/gpg/gpg-public-key-0x76FD3810215AE097.asc"; trust = 5; } ]; }; # assure correct permissions systemd.user.tmpfiles.rules = [ "d /home/swarsel/.gnupg 700 swarsel users" ]; }
3.4.1.29. gammastep
This service changes the screen hue at night. I am not sure if that really does something, but I like the color anyways.
_: { services.gammastep = { enable = true; provider = "manual"; latitude = 48.210033; longitude = 16.363449; }; }
3.4.2. Server
3.4.2.1. Imports
This section sets up all the imports that are used in the home-manager section.
{ self, lib, ... }: let importNames = lib.swarselsystems.readNix "profiles/home/server"; profilesPath = "${self}/profiles"; in { imports = lib.swarselsystems.mkImports importNames "profiles/home/server" ++ [ "${profilesPath}/home/common/settings.nix" ]; }
3.4.2.2. Symlinking dotfiles
This section should be used in order to symlink already existing configuration files using `home.file` and setting session variables using `home.sessionVariables`.
As for the `home.sessionVariables`, it should be noted that environment variables that are needed at system start should NOT be loaded here, but instead in `programs.zsh.config.extraSessionCommands` (in the home-manager programs section). This is also where all the wayland related variables are stored.
{ self, lib, ... }: { home.file = { "init.el" = lib.mkForce { source = self + /programs/emacs/server.el; target = ".emacs.d/init.el"; }; }; }
3.4.3. Darwin
3.4.3.1. Imports
This section sets up all the imports that are used in the home-manager section.
{ self, ... }: let profilesPath = "${self}/profiles"; in { imports = [ "${profilesPath}/home/common/settings.nix" ]; }
3.4.4. Optional
Akin to the optional NixOS modules.
3.4.4.1. Gaming
The rest of the settings is at gaming.
{ pkgs, ... }: { # specialisation = { # gaming.configuration = { home.packages = with pkgs; [ lutris wine winetricks libudev-zero dwarfs fuse-overlayfs # steam steam-run patchelf gamescope vulkan-tools moonlight-qt ns-usbloader quark-goldleaf # gog games installing heroic # minecraft prismlauncher # has overrides temurin-bin-17 pokefinder retroarch flips ]; # }; # }; }
3.4.4.2. Work
The rest of the settings is at work. Here, I am setting up the different firefox profiles that I need for the SSO sites that I need to access at work as well as a few ssh shorthands.
{ config, pkgs, lib, ... }: { home.packages = with pkgs; [ stable.teams-for-linux shellcheck dig docker postman rclone awscli2 libguestfs-with-appliance stable.prometheus.cli tigervnc ]; home.sessionVariables = { DOCUMENT_DIR_PRIV = lib.mkForce "${config.home.homeDirectory}/Documents/Private"; DOCUMENT_DIR_WORK = lib.mkForce "${config.home.homeDirectory}/Documents/Work"; }; programs = { git.userEmail = "leon.schwarzaeugl@imba.oeaw.ac.at"; zsh = { shellAliases = { dssh = "ssh -l dc_adm_schwarzaeugl"; cssh = "ssh -l cl_adm_schwarzaeugl"; wssh = "ssh -l ws_adm_schwarzaeugl"; }; cdpath = [ "~/Documents/Work" ]; dirHashes = { d = "$HOME/.dotfiles"; w = "$HOME/Documents/Work"; s = "$HOME/.dotfiles/secrets"; pr = "$HOME/Documents/Private"; ac = "$HOME/.ansible/collections/ansible_collections/vbc/linux/roles"; }; }; ssh = { matchBlocks = { "uc" = { hostname = "uc.clip.vbc.ac.at"; user = "stack"; }; "uc.stg" = { hostname = "uc.staging.clip.vbc.ac.at"; user = "stack"; }; "uc.staging" = { hostname = "uc.staging.clip.vbc.ac.at"; user = "stack"; }; "uc.dev" = { hostname = "uc.dev.clip.vbc.ac.at"; user = "stack"; }; "cbe" = { hostname = "cbe.vbc.ac.at"; user = "dc_adm_schwarzaeugl"; }; "cbe.stg" = { hostname = "cbe.staging.clip.vbc.ac.at"; user = "dc_adm_schwarzaeugl"; }; "cbe.staging" = { hostname = "cbe.staging.clip.vbc.ac.at"; user = "dc_adm_schwarzaeugl"; }; "*.vbc.ac.at" = { user = "dc_adm_schwarzaeugl"; }; }; }; firefox = { profiles = { dc_adm = lib.recursiveUpdate { id = 1; settings = { "browser.startup.homepage" = "https://tower.vbc.ac.at|https://artifactory.vbc.ac.at"; }; } config.swarselsystems.firefox; cl_adm = lib.recursiveUpdate { id = 2; settings = { "browser.startup.homepage" = "https://portal.azure.com"; }; } config.swarselsystems.firefox; ws_adm = lib.recursiveUpdate { id = 3; } config.swarselsystems.firefox; }; }; chromium = { enable = true; package = pkgs.chromium; extensions = [ # 1password "gejiddohjgogedgjnonbofjigllpkmbf" # dark reader "eimadpbcbfnmbkopoojfekhnkhdbieeh" # ublock origin "cjpalhdlnbpafiamejdnhcphjbkeiagm" # i still dont care about cookies "edibdbjcniadpccecjdfdjjppcpchdlm" # browserpass "naepdomgkenhinolocfifgehidddafch" ]; }; }; xdg = { mimeApps = { defaultApplications = { "x-scheme-handler/msteams" = [ "teams-for-linux.desktop" ]; }; }; desktopEntries = let terminal = false; categories = [ "Application" ]; icon = "firefox"; in { firefox_dc = { name = "Firefox (dc_adm)"; genericName = "Firefox dc"; exec = "firefox -p dc_adm"; inherit terminal categories icon; }; firefox_ws = { name = "Firefox (ws_adm)"; genericName = "Firefox ws"; exec = "firefox -p ws_adm"; inherit terminal categories icon; }; firefox_cl = { name = "Firefox (cl_adm)"; genericName = "Firefox cl"; exec = "firefox -p cl_adm"; inherit terminal categories icon; }; }; }; }
4. Emacs
4.1. Initialization (early-init.el)
In this section I handle my early init file; it takes care of frame-setup for emacsclient buffers.
4.1.1. Increase startup performance
First, I use some advice from doomemacs regarding garbace collection; here I make sure that during startup, the garbace collectur will not run, which will improve startup times. Now, that might not really be needed since I will usually only start the emacs server once during startup and then not touch it again, however, since I am building my emacs configuration using NixOS, there is some merit to this since I will usually need to restart the server once I rebuild my configuration.
Also, inspired by a setting I have seen in protesilaos' configuration, I apply the same idea to the file-name-handler-alist
and vc-handled-backends
.
In the end, we need to restore those values to values that will work during normal operation. For that, I add a hook to the startup function that will revert the values once Emacs has finished initialization.
Also packed into the hook function is the line (fset 'epg-wait-for-status 'ignore)
. This line is needed at the end of the configuration in order to allow for my Yubikey to be used to encrypt and decrypt .gpg
files. Without it, Emacs will just hang forever and basically crash.
(defvar swarsel-file-name-handler-alist file-name-handler-alist) (defvar swarsel-vc-handled-backends vc-handled-backends) (setq gc-cons-threshold most-positive-fixnum gc-cons-percentage 0.6 file-name-handler-alist nil vc-handled-backends nil) (add-hook 'emacs-startup-hook (lambda () (progn (setq gc-cons-threshold (* 32 1024 1024) gc-cons-percentage 0.1 jit-lock-defer-time 0.05 read-process-output-max (* 1024 1024) file-name-handler-alist swarsel-file-name-handler-alist vc-handled-backends swarsel-vc-handled-backends) (fset 'epg-wait-for-status 'ignore) )))
4.1.2. Setup frames
Next, I will setup the basic frame for my emacs buffers. Note that I use a tiling window manager, so I do not need to hold myself up with sizing the windows myself. I also disable some GUI tools that I (like many others) do not find to be particularly useful. Also I inhibit many startup functions here, even though it does not affect me greatly since I use another solution for that.
We also make require immediate compilation of native code.
For the default-frame-alist
, I used to also set '(right-divider-width . 4)
and '(bottom-divider-width . 4)
, but I did not like the look of the divider bar and usually know my splits anyways, so this is no longer set.
(tool-bar-mode 0) (menu-bar-mode 0) (scroll-bar-mode 0) (setq frame-inhibit-implied-resize t ring-bell-function 'ignore use-dialog-box nil use-file-dialog nil use-short-answers t inhibit-startup-message t inhibit-splash-screen t inhibit-startup-screen t inhibit-x-resources t inhibit-startup-buffer-menu t inhibit-startup-echo-area-message user-login-name ; this needs to be set to the username or it will not have an effect comp-deferred-compilation nil ; compile all Elisp to native code immediately ) (setq-default left-margin-width 1 right-margin-width 1) (setq-default default-frame-alist (append (list '(undecorated . t) ; no title bar, borders etc. '(background-color . "#1D252C") ; load doom-citylight colors to avoid white flash '(foreground-color . "#A0B3C5") ; load doom-citylight colors to avoid white flash '(vertical-scroll-bars . nil) '(horizontal-scroll-bars . nil) '(internal-border-width . 5) '(tool-bar-lines . 0) '(menu-bar-lines . 0))))
4.1.3. Make C-i, C-m, C-[ available in graphic sessions
By default, emacs binds
C-i
to theTAB
keyC-m
to theRET
keyC-[
to theECS
key
These keybinds exist to make Emacs work well in terminal mode. However, most of the time I am using Emacs in a graphic session, and I would hence like to have these keybinds available for personal use.
NOTE: To use these keybinds, you need to enclose the binding in angled brackets (<>
). Then they can be used normally
(add-hook 'after-make-frame-functions (lambda (frame) (with-selected-frame frame (when (display-graphic-p) (define-key input-decode-map (kbd "C-i") [DUMMY-i]) (define-key input-decode-map (kbd "C-[") [DUMMY-lsb]) (define-key input-decode-map (kbd "C-m") [DUMMY-m]) ))))
4.2. Personal settings
This section is used to define my own functions, own variables, and own keybindings.
4.2.1. Custom functions
In this section I define extra functions that I need. Some of these functions I wrote myself, some I found after internet reseach. For functions I found on the internet, I will link the original source I found it in.
4.2.1.1. Emacs/Evil state toggle
Since I am rebinding the C-z
hotkey for emacs-evil-state toggling, I want to have a function that still lets me perform this action quickly.
(defun swarsel/toggle-evil-state () (interactive) (if (or (evil-emacs-state-p) (evil-insert-state-p)) (evil-normal-state) (evil-emacs-state)))
4.2.1.2. Switching to last used buffer
I often find myself bouncing between two buffers when I do not want to use a window split. This funnction simply jumps to the last used buffer.
(defun swarsel/last-buffer () (interactive) (switch-to-buffer nil))
4.2.1.3. mu4e functions
I use these functions to let me switch between my main email accounts, as mu4e by itself has trouble doing so. mu4e-switch-account
allows for manual choosing of the sender account, while mu4e-rfs--matching-address
and mu4e-send-from-correct-address
are used when replying to a mail; they switch the sender account to the one that received the mail.
By default, the sender email will not be changed after sending a mail; however, I want Emacs to always use my main address when not replying to another email. For that I use mu4e-restore-default
.
Used here: mu4e
(defun swarsel/mu4e-switch-account () (interactive) (let ((account (completing-read "Select account: " mu4e-user-mail-address-list))) (setq user-mail-address account))) (defun swarsel/mu4e-rfs--matching-address () (cl-loop for to-data in (mu4e-message-field mu4e-compose-parent-message :to) for to-email = (pcase to-data (`(_ . email) email) (x (mu4e-contact-email x))) for to-name = (pcase to-data (`(_ . name) name) (x (mu4e-contact-name x))) when (mu4e-user-mail-address-p to-email) return (list to-name to-email))) (defun swarsel/mu4e-send-from-correct-address () (when mu4e-compose-parent-message (save-excursion (when-let ((dest (swarsel/mu4e-rfs--matching-address))) (cl-destructuring-bind (from-user from-addr) dest (setq user-mail-address from-addr) (message-position-on-field "From") (message-beginning-of-line) (delete-region (point) (line-end-position)) (insert (format "%s <%s>" (or from-user user-full-name) from-addr))))))) (defun swarsel/mu4e-restore-default () (setq user-mail-address "leon@swarsel.win" user-full-name "Leon Schwarzäugl"))
4.2.1.4. Create non-existant directories when finding file
This function will check if a directory for which a file we want to open exists; if not, it will offer to create the directories for me.
(defun swarsel/with-buffer-name-prompt-and-make-subdirs () (let ((parent-directory (file-name-directory buffer-file-name))) (when (and (not (file-exists-p parent-directory)) (y-or-n-p (format "Directory `%s' does not exist! Create it? " parent-directory))) (make-directory parent-directory t)))) (add-to-list 'find-file-not-found-functions #'swarsel/with-buffer-name-prompt-and-make-subdirs)
4.2.1.5. [crux] Duplicate Lines
When programming, I like to be able to duplicate a line. There are easier functions than the one below, but they either
- screw with undo/redo
- move the cursor wildly
The below function avoids these problems. Originally I used the function duplicate-line
found here: https://stackoverflow.com/questions/88399/how-do-i-duplicate-a-whole-line-in-emacs
However, this function does not work on regions. Later, I found a solution implemented by crux. I do not need the whole package, so I just extracted the three functions I needed from it.
(defun crux-get-positions-of-line-or-region () "Return positions (beg . end) of the current line or region." (let (beg end) (if (and mark-active (> (point) (mark))) (exchange-point-and-mark)) (setq beg (line-beginning-position)) (if mark-active (exchange-point-and-mark)) (setq end (line-end-position)) (cons beg end))) (defun crux-duplicate-current-line-or-region (arg) "Duplicates the current line or region ARG times. If there's no region, the current line will be duplicated. However, if there's a region, all lines that region covers will be duplicated." (interactive "p") (pcase-let* ((origin (point)) (`(,beg . ,end) (crux-get-positions-of-line-or-region)) (region (buffer-substring-no-properties beg end))) (dotimes (_i arg) (goto-char end) (newline) (insert region) (setq end (point))) (goto-char (+ origin (* (length region) arg) arg)))) (defun crux-duplicate-and-comment-current-line-or-region (arg) "Duplicates and comments the current line or region ARG times. If there's no region, the current line will be duplicated. However, if there's a region, all lines that region covers will be duplicated." (interactive "p") (pcase-let* ((origin (point)) (`(,beg . ,end) (crux-get-positions-of-line-or-region)) (region (buffer-substring-no-properties beg end))) (comment-or-uncomment-region beg end) (setq end (line-end-position)) (dotimes (_ arg) (goto-char end) (newline) (insert region) (setq end (point))) (goto-char (+ origin (* (length region) arg) arg))))
4.2.1.6. [prot] org-id-headings
These functions by protesilaos generate heading links in an org-file similar to the normal org-store-link
approach when not using properties. This approach has a weakness however - if the heading name is changed, the link breaks. These functions generate a unique identifier for each heading which will not break and also works when exporting the file to html, for example.
(defun prot-org--id-get () "Get the CUSTOM_ID of the current entry. If the entry already has a CUSTOM_ID, return it as-is, else create a new one." (let* ((pos (point)) (id (org-entry-get pos "CUSTOM_ID"))) (if (and id (stringp id) (string-match-p "\\S-" id)) id (setq id (org-id-new "h")) (org-entry-put pos "CUSTOM_ID" id) id))) (declare-function org-map-entries "org") (defun prot-org-id-headlines () "Add missing CUSTOM_ID to all headlines in current file." (interactive) (org-map-entries (lambda () (prot-org--id-get)))) (defun prot-org-id-headline () "Add missing CUSTOM_ID to headline at point." (interactive) (prot-org--id-get))
4.2.1.7. Inhibit Messages in Echo Area
Emacs likes to send messages to the echo area; this is generally a good thing. However, it bothers me a lot when I am currently working in minibuffer where I receive an echo area message that is actually important and it is then overwritten by e.g. the mu4e update message. This section makes it possible to find the root function calling the message function and disabling it here.
Usage: Enable the (advice-add 'message :around #'who-called-me?)
by running this code block, which will show a full trace of all messages being sent to the echo area:
(advice-add 'message :around #'who-called-me?)
Once the root function has been found, it can be disabled via advice=add
as in the last block in this section. To disable the stack tracing, run (advice-remove 'message #'who-called-me?)
or the following code block:
(advice-remove 'message #'who-called-me?)
Lastly, individual messages can be reenabled using the (advice-remove '<FUNCTION-NAME> #'suppress-messages)
approach. Use this when you accidentally disabled a helpful message.
(defun suppress-messages (old-fun &rest args) (cl-flet ((silence (&rest args1) (ignore))) (advice-add 'message :around #'silence) (unwind-protect (apply old-fun args) (advice-remove 'message #'silence)))) (advice-add 'pixel-scroll-precision :around #'suppress-messages) (advice-add 'mu4e--server-filter :around #'suppress-messages) (advice-add 'org-unlogged-message :around #'suppress-messages) (advice-add 'magit-auto-revert-mode--init-kludge :around #'suppress-messages) (advice-add 'push-mark :around #'suppress-messages) (advice-add 'evil-insert :around #'suppress-messages) (advice-add 'evil-visual-char :around #'suppress-messages) ;; to reenable ;; (advice-remove 'timer-event-handler #'suppress-messages) (defun who-called-me? (old-fun format &rest args) (let ((trace nil) (n 1) (frame nil)) (while (setf frame (backtrace-frame n)) (setf n (1+ n) trace (cons (cadr frame) trace)) ) (apply old-fun (concat "<<%S>>\n" format) (cons trace args)))) ;; enable to get message backtrace, the first function shown in backtrace calls the other functions ;; (advice-add 'message :around #'who-called-me?) ;; disable to stop receiving backtrace (advice-remove 'message #'who-called-me?)
4.2.1.8. Move up one directory for find-file
I find it very annoying that the standard behavior for M-DEL only deletes one word when using find-file. This function makes it so that we always go up by one directory level instead.
This function was found here: https://www.reddit.com/r/emacs/comments/re31i6/how_to_go_up_one_directory_when_using_findfile_cx/
(defun up-directory (path) "Move up a directory in PATH without affecting the kill buffer." (interactive "p") (if (string-match-p "/." (minibuffer-contents)) (let ((end (point))) (re-search-backward "/.") (forward-char) (delete-region (point) end)))) (define-key minibuffer-local-filename-completion-map [C-backspace] #'up-directory)
4.2.1.9. org-mode: General setup
Sets up the basic settings that I want to have active in org-mode buffers.
Used here: General org-mode
(defun swarsel/org-mode-setup () (variable-pitch-mode 1) (add-hook 'org-tab-first-hook 'org-end-of-line) (visual-line-mode 1))
4.2.1.10. org-mode: Visual-fill column
This function sets the width of buffers in org-mode.
Used in: Centered org-mode Buffers
(defun swarsel/org-mode-visual-fill () (setq visual-fill-column-width 150 visual-fill-column-center-text t) (visual-fill-column-mode 1))
4.2.1.11. org-mode: Upon-save actions (Auto-tangle, export to html, formatting)
This section handles everything that shoudld happen when I save SwarselSystems.org
. It:
- automatically tangles all configuration blocks in this file
- exports the configuration file as html for an easier reading experience with working links and index
- formats the generated
.nix
files in accordance to theAlejandra
-style.
We set a hook that runs everytime we save the file. It would be a bit more efficient to only export and format when we enter a magit window for instance (since especially the html export takes times), however, since I cannot be sure to only ever commit from magit (I do indeed sometimes use git from the command line), I prefer this approach.
(defun swarsel/run-formatting () (interactive) (let ((default-directory (expand-file-name "~/.dotfiles"))) (shell-command "nixpkgs-fmt . > /dev/null"))) (defun swarsel/org-babel-tangle-config () (interactive) (when (string-equal (buffer-file-name) swarsel-swarsel-org-filepath) ;; Dynamic scoping to the rescue (let ((org-confirm-babel-evaluate nil)) ;; (org-html-export-to-html) (org-babel-tangle) (swarsel/run-formatting) ))) (setq org-html-htmlize-output-type nil) ;; (add-hook 'org-mode-hook (lambda () (add-hook 'after-save-hook #'swarsel/org-babel-tangle-config)))
4.2.1.12. org-mode: Fold current heading
Normally emacs cycles between three states:
- fully folded
- One heading expanded
- All headings expanded
However, I want to be able to fold a single heading consistently.
(defun org-fold-outer () (interactive) (org-beginning-of-line) (if (string-match "^*+" (thing-at-point 'line t)) (outline-up-heading 1)) (outline-hide-subtree) )
4.2.1.13. corfu: Do not interrupt navigation
These three functions allow me to keep using the normal navigation keys even when a corfu completion pops up.
These functions are used here: Corfu
(defun swarsel/corfu-normal-return (&optional arg) (interactive) (corfu-quit) (newline) ) (defun swarsel/corfu-quit-and-up (&optional arg) (interactive) (corfu-quit) (evil-previous-visual-line)) (defun swarsel/corfu-quit-and-down (&optional arg) (interactive) (corfu-quit) (evil-next-visual-line))
4.2.1.14. Disable garbace collection while minibuffer is active
(defun swarsel/minibuffer-setup-hook () (setq gc-cons-threshold most-positive-fixnum)) (defun swarsel/minibuffer-exit-hook () (setq gc-cons-threshold (* 32 1024 1024))) (add-hook 'minibuffer-setup-hook #'swarsel/minibuffer-setup-hook) (add-hook 'minibuffer-exit-hook #'swarsel/minibuffer-exit-hook)
4.2.2. Custom Keybindings
This defines a set of keybinds that I want to have available globally. I have one set of keys that is globally available through the C-SPC
prefix. This set is used mostly for functions that I have trouble remembering the original keybind for, or that I just want to have gathered in a common space.
I also define some keybinds to some combinations directly. Those are used mostly for custom functions that I call often enough to warrant this.
;; Make ESC quit prompts (global-set-key (kbd "<escape>") 'keyboard-escape-quit) ;; Set up general keybindings (use-package general :config (general-create-definer swarsel/leader-keys :keymaps '(normal insert visual emacs) :prefix "SPC" :global-prefix "C-SPC") (swarsel/leader-keys "e" '(:ignore e :which-key "evil") "eo" '(evil-jump-backward :which-key "cursor jump backwards") "eO" '(evil-jump-forward :which-key "cursor jump forwards") "t" '(:ignore t :which-key "toggles") "ts" '(hydra-text-scale/body :which-key "scale text") "te" '(swarsel/toggle-evil-state :which-key "emacs/evil") "tl" '(display-line-numbers-mode :which-key "line numbers") "tp" '(evil-cleverparens-mode :wk "cleverparens") "to" '(olivetti-mode :wk "olivetti") "td" '(darkroom-tentative-mode :wk "darkroom") "tw" '((lambda () (interactive) (toggle-truncate-lines)) :which-key "line wrapping") "m" '(:ignore m :which-key "modes/programs") "mm" '((lambda () (interactive) (mu4e)) :which-key "mu4e") "mg" '((lambda () (interactive) (magit-list-repositories)) :which-key "magit-list-repos") "mc" '((lambda () (interactive) (swarsel/open-calendar)) :which-key "calendar") "mp" '(popper-toggle :which-key "popper") "md" '(dirvish :which-key "dirvish") "mr" '(bjm/elfeed-load-db-and-open :which-key "elfeed") "o" '(:ignore o :which-key "org") "op" '((lambda () (interactive) (org-present)) :which-key "org-present") "oa" '((lambda () (interactive) (org-agenda)) :which-key "org-agenda") "oa" '((lambda () (interactive) (org-refile)) :which-key "org-refile") "ob" '((lambda () (interactive) (org-babel-mark-block)) :which-key "Mark whole src-block") "ol" '((lambda () (interactive) (org-insert-link)) :which-key "insert link") "oc" '((lambda () (interactive) (org-store-link)) :which-key "copy (=store) link") "os" '(shfmt-region :which-key "format sh-block") "od" '((lambda () (interactive) (org-babel-demarcate-block)) :which-key "demarcate (split) src-block") "on" '(nixpkgs-fmt-region :which-key "format nix-block") "ot" '(swarsel/org-babel-tangle-config :which-key "tangle file") "oe" '(org-html-export-to-html :which-key "export to html") "c" '(:ignore c :which-key "capture") "ct" '((lambda () (interactive) (org-capture nil "tt")) :which-key "task") "l" '(:ignore l :which-key "links") "lc" '((lambda () (interactive) (progn (find-file swarsel-swarsel-org-filepath) (org-overview) )) :which-key "SwarselSystems.org") "le" '((lambda () (interactive) (progn (find-file swarsel-swarsel-org-filepath) (goto-char (org-find-exact-headline-in-buffer "Emacs") ) (org-overview) (org-cycle) )) :which-key "Emacs.org") "ln" '((lambda () (interactive) (progn (find-file swarsel-swarsel-org-filepath) (goto-char (org-find-exact-headline-in-buffer "System") ) (org-overview) (org-cycle))) :which-key "Nixos.org") "lp" '((lambda () (interactive) (projectile-switch-project)) :which-key "switch project") "lg" '((lambda () (interactive) (magit-list-repositories)) :which-key "list git repos") "h" '(:ignore h :which-key "help") "hy" '(yas-describe-tables :which-key "yas tables") "hb" '(embark-bindings :which-key "current key bindings") "h" '(:ignore t :which-key "describe") "he" 'view-echo-area-messages "hf" 'describe-function "hF" 'describe-face "hl" '(view-lossage :which-key "show command keypresses") "hL" 'find-library "hm" 'describe-mode "ho" 'describe-symbol "hk" 'describe-key "hK" 'describe-keymap "hp" 'describe-package "hv" 'describe-variable "hd" 'devdocs-lookup "w" '(:ignore t :which-key "window") "wl" 'windmove-right "w <right>" 'windmove-right "wh" 'windmove-left "w <left>" 'windmove-left "wk" 'windmove-up "w <up>" 'windmove-up "wj" 'windmove-down "w <down>" 'windmove-down "wr" 'winner-redo "wd" 'delete-window "w=" 'balance-windows-area "wD" 'kill-buffer-and-window "wu" 'winner-undo "wr" 'winner-redo "w/" 'evil-window-vsplit "w\\" 'evil-window-vsplit "w-" 'evil-window-split "wm" '(delete-other-windows :wk "maximize") "<right>" 'up-list "<left>" 'down-list )) ;; General often used hotkeys (general-define-key "C-M-a" (lambda () (interactive) (org-capture nil "a")) ; make new anki card "C-c d" 'crux-duplicate-current-line-or-region "C-c D" 'crux-duplicate-and-comment-current-line-or-region "<DUMMY-m>" 'swarsel/last-buffer "M-\\" 'indent-region "<Paste>" 'yank "<Cut>" 'kill-region "<Copy>" 'kill-ring-save "<undo>" 'evil-undo "<redo>" 'evil-redo "C-S-c C-S-c" 'mc/edit-lines "C->" 'mc/mark-next-like-this "C-<" 'mc/mark-previous-like-this "C-c C-<" 'mc/mark-all-like-this )
4.2.3. Directory setup / File structure
In this section I setup some aliases that I use for various directories on my system. Some of these are actually used for magit repository finding etc., but many of them serve no real use and I need to clean this up someday.
;; set Nextcloud directory for journals etc. (setq swarsel-emacs-directory "~/.emacs.d" swarsel-dotfiles-directory "~/.dotfiles" swarsel-swarsel-org-filepath (expand-file-name "SwarselSystems.org" swarsel-dotfiles-directory) swarsel-tasks-org-file "Tasks.org" swarsel-archive-org-file "Archive.org" swarsel-work-projects-directory "~/Documents/Work" swarsel-private-projects-directory "~/Documents/Private" )
4.2.4. Unclutter .emacs.d
In this section I move the custom.el
out of it's standard location in .emacs.d
. Firstly, I dislike using this file at all since I would rather have fully stateful configuration as commanded by this file. Secondly, this file is too easily permanently changed. Recently I figured out the last bits that I needed to remove from custom.el to no longer be reliant on it, so I now just write it to a temporary file (through make-temp=file
) which will be cleaned on shutdown. However, I like to retain the custom framework because it is nice for testing out theme customizations, hence why I still load the file.
This section also sets the emacs directory to the ~/.cache/
directory which is useful for files that I do not want to have lying around in my .emacs.d
.
;; Change the user-emacs-directory to keep unwanted things out of ~/.emacs.d (setq user-emacs-directory (expand-file-name "~/.cache/emacs/") url-history-file (expand-file-name "url/history" user-emacs-directory)) ;; Use no-littering to automatically set common paths to the new user-emacs-directory (use-package no-littering) (setq custom-file (make-temp-file "emacs-custom-")) (load custom-file t)
4.2.5. Move backup files to another location
Many people dislike the Emacs backup files; I do enjoy them, but have to admit that they clutter the filesystem a little too much. Also, I rarely need to access these over different sessions. Hence I move them to /tmp
- if Emacs unexpectedly crashes, the files can be recovered, but the backup files will not gather everywhere and will be deleted upon shutdown.
(let ((backup-dir "~/tmp/emacs/backups") (auto-saves-dir "~/tmp/emacs/auto-saves/")) (dolist (dir (list backup-dir auto-saves-dir)) (when (not (file-directory-p dir)) (make-directory dir t))) (setq backup-directory-alist `(("." . ,backup-dir)) auto-save-file-name-transforms `((".*" ,auto-saves-dir t)) auto-save-list-file-prefix (concat auto-saves-dir ".saves-") tramp-backup-directory-alist `((".*" . ,backup-dir)) tramp-auto-save-directory auto-saves-dir)) (setq backup-by-copying t ; Don't delink hardlinks delete-old-versions t ; Clean up the backups version-control t ; Use version numbers on backups, kept-new-versions 5 ; keep some new versions kept-old-versions 2) ; and some old ones, too
4.3. General init.el setup + UI
In this general section I have settings that I either consider to be integral to my experience when using Emacs or have no other section that I feel they belong to.
4.3.1. General setup
Here I set up some things that are too minor to put under other categories.
- Firstly we disable to having to type `yes` and `no` and switch it to `y` and `n`.
- We also enable the marking of trailing whitespaces.
- Also, make emacs highlight the current line globally
- Emacs defaults to pausing all display redrawing on any input. This may have been useful previously, but is not necessary nowadays.
- I also disable the suspend-frame function, as I never use it and it is quite confusing when accidentally hitting the keys for it.
;; use UTF-8 everywhere (set-language-environment "UTF-8") (profiler-start 'cpu) ;; set default font size (defvar swarsel/default-font-size 130) (setq swarsel-standard-font "FiraCode Nerd Font Mono" swarsel-alt-font "FiraCode Nerd Font Mono") ;; (defalias 'yes-or-no-p 'y-or-n-p) ;;(setq-default show-trailing-whitespace t) (add-hook 'before-save-hook 'delete-trailing-whitespace) (global-hl-line-mode 1) ;; (setq redisplay-dont-pause t) ;; obsolete (setq blink-cursor-mode nil) ;; blink-cursor is an unexpected source of slowdown (global-subword-mode 1) ; Iterate through CamelCase words (setq blink-matching-paren nil) ;; this makes the cursor jump around annoyingly (delete-selection-mode 1) (setq vc-follow-symlinks t) (setq require-final-newline t) (winner-mode 1) (setq load-prefer-newer t) (setq-default bidi-paragraph-direction 'left-to-right bidi-display-reordering 'left-to-right bidi-inhibit-bpa t) (global-so-long-mode) (setq process-adaptive-read-buffering nil) ;; not sure if this is a good idea (setq fast-but-imprecise-scrolling t redisplay-skip-fontification-on-input t inhibit-compacting-font-caches t) (setq idle-update-delay 1.0 which-func-update-delay 1.0) (setq undo-limit 80000000 evil-want-fine-undo t auto-save-default t password-cache-expiry nil ) (setq browse-url-browser-function 'browse-url-firefox) (setenv "DISPLAY" ":0") ;; disable a keybind that does more harm than good (global-set-key [remap suspend-frame] (lambda () (interactive) (message "This keybinding is disabled (was 'suspend-frame')"))) (setq visible-bell nil) (setq initial-major-mode 'fundamental-mode initial-scratch-message nil) (add-hook 'prog-mode-hook 'display-line-numbers-mode) ;; (add-hook 'text-mode-hook 'display-line-numbers-mode) ;; (global-visual-line-mode 1)
4.3.2. Mark all themes as safe
Normally when switching themes in emacs, the user will be warned that themes can run malicious code. I only run one theme really and deem it safe. It is however annoying to be asked this on every new system and it also creates lines in custom.el to answer that query, so here I declare all themes as safe.
(setq custom-safe-themes t)
4.3.3. Show less compilation warnings
When Emacs compiles stuff, it often shows a bunch of warnings that I do not need to deal with. Here we silence those. Some will be disabled completely, and some only when we have native compilation available (which should be most of the time, however).
This is really not needed anymore ever since I started managing my emacs packages with nix, but I still keep this around in case I ever move away from it.
(setq byte-compile-warnings '(not free-vars unresolved noruntime lexical make-local)) ;; Make native compilation silent and prune its cache. (when (native-comp-available-p) (setq native-comp-async-report-warnings-errors 'silent) ; Emacs 28 with native compilation (setq native-compile-prune-cache t)) ; Emacs 29
4.3.4. Better garbage collection
This sets up automatic garbage collection when the frame is unused. There is a lot of discussion on whether it is smart to tamper with garbage collection - in my eyes it is worth running this, because I often times switch away from Emacs for a while when researching. That times can be then used to run GC.
(setq garbage-collection-messages nil) (defmacro k-time (&rest body) "Measure and return the time it takes evaluating BODY." `(let ((time (current-time))) ,@body (float-time (time-since time)))) ;; When idle for 15sec run the GC no matter what. (defvar k-gc-timer (run-with-idle-timer 15 t (lambda () ;; (message "Garbage Collector has run for %.06fsec" (k-time (garbage-collect))))) ;; )
4.3.5. Indentation
Here I define several options related to indentation; I first make it so that only whitespace will be used instead of tab characters for indentation, and I also set a small standard indent.
We set tab-always-indent
to 'complete
in order to indent first and then do completion if there are any. Also we make it so that python will not complain about missing indentation info.
Lastly, I load the highlight-indent-guides
package. This adds a neat visual indicator of the indentation level, which is useful for languages like python.
(setq-default indent-tabs-mode nil tab-width 2) (setq tab-always-indent 'complete) (setq python-indent-guess-indent-offset-verbose nil) (use-package highlight-indent-guides :hook (prog-mode . highlight-indent-guides-mode) :init (setq highlight-indent-guides-method 'column) (setq highlight-indent-guides-responsive 'top) ) (with-eval-after-load 'highlight-indent-guides (set-face-attribute 'highlight-indent-guides-even-face nil :background "gray10") (set-face-attribute 'highlight-indent-guides-odd-face nil :background "gray20") (set-face-attribute 'highlight-indent-guides-stack-even-face nil :background "gray40") (set-face-attribute 'highlight-indent-guides-stack-odd-face nil :background "gray50")) ;; (use-package aggressive-indent) ;; (global-aggressive-indent-mode 1)
4.3.6. Scrolling
By default, emacs scrolls half a page when reaching the bottom of the buffer. This is extremely annoying. This sets up more granular scrolling that allows scrolling with a mouse wheel or the two-finger touchscreen gesture. This now also works in buffers with a very small frame.
(setq mouse-wheel-scroll-amount '(1 ((shift) . 5) ((meta) . 0.5) ((control) . text-scale)) mouse-drag-copy-region nil make-pointer-invisible t mouse-wheel-progressive-speed t mouse-wheel-follow-mouse t) (setq-default scroll-preserve-screen-position t scroll-conservatively 1 scroll-margin 0 next-screen-context-lines 0) (pixel-scroll-precision-mode 1)
4.3.7. Evil
4.3.7.1. General evil
This setups up evil, which brings vim-like keybindings to emacs. In the same location, I also unbind the C-z
key (I am very unhappy with this implementation, but it is the only thing that works consistently so far) to make it available for cape later.
Also, I setup initial modes for several major-modes depending on what I deem fit.
;; Emulate vim in emacs (use-package evil :init (setq evil-want-integration t) ; loads evil (setq evil-want-keybinding nil) ; loads "helpful bindings" for other modes (setq evil-want-C-u-scroll t) ; scrolling using C-u (setq evil-want-C-i-jump nil) ; jumping with C-i (setq evil-want-Y-yank-to-eol t) ; give Y some utility (setq evil-shift-width 2) ; uniform indent (setq evil-respect-visual-line-mode nil) ; i am torn on this one (setq evil-split-window-below t) (setq evil-vsplit-window-right t) :config (evil-mode 1) ;; make normal mode respect wrapped lines (define-key evil-normal-state-map (kbd "j") 'evil-next-visual-line) (define-key evil-normal-state-map (kbd "<down>") 'evil-next-visual-line) (define-key evil-normal-state-map (kbd "k") 'evil-previous-visual-line) (define-key evil-normal-state-map (kbd "<up>") 'evil-previous-visual-line) (define-key evil-normal-state-map (kbd "C-z") nil) (define-key evil-insert-state-map (kbd "C-z") nil) (define-key evil-visual-state-map (kbd "C-z") nil) (define-key evil-motion-state-map (kbd "C-z") nil) (define-key evil-operator-state-map (kbd "C-z") nil) (define-key evil-replace-state-map (kbd "C-z") nil) (define-key global-map (kbd "C-z") nil) (evil-set-undo-system 'undo-tree) ;; Don't use evil-mode in these contexts, or use it in a specific mode (evil-set-initial-state 'messages-buffer-mode 'emacs) (evil-set-initial-state 'dashboard-mode 'emacs) (evil-set-initial-state 'dired-mode 'emacs) (evil-set-initial-state 'cfw:details-mode 'emacs) (evil-set-initial-state 'Custom-mode 'emacs) ; god knows why this mode is in uppercase (evil-set-initial-state 'mu4e-headers-mode 'normal) (evil-set-initial-state 'python-inferior-mode 'normal) (add-hook 'org-capture-mode-hook 'evil-insert-state) (add-to-list 'evil-buffer-regexps '("COMMIT_EDITMSG" . insert)))
4.3.7.2. evil-collection
This gives support for many different modes, and works beautifully out of the box.
(use-package evil-collection :after evil :config (evil-collection-init) (setq forge-add-default-bindings nil))
4.3.7.3. evil-snipe
This package changes the char-search commands like f
by showing the results in a more visual manner. It also gives a 2-character search using s
and S
.
;; enables 2-char inline search (use-package evil-snipe :after evil :demand :config (evil-snipe-mode +1) ;; replace 1-char searches (f&t) with this better UI (evil-snipe-override-mode +1))
4.3.7.4. evil-cleverparens
This helps keeping parentheses balanced which is useful when writing in languages like Elisp. I do not activate this by default, as most languages do not profit from this enough in my eyes.
;; for parentheses-heavy languades modify evil commands to keep balance of parantheses (use-package evil-cleverparens)
4.3.7.5. evil-surround
This minor-mode adds functionality for doing better surround-commands; for example ci[
will let you change the word within square brackets.
;; enables surrounding text with S (use-package evil-surround :config (global-evil-surround-mode 1))
4.3.7.6. evil-visual-mark-mode
(use-package evil-visual-mark-mode :config (evil-visual-mark-mode))
4.3.7.7. evil-textobj-tree-sitter
This adds support for tree-sitter objects. This allows for the following chords:
- "…af" around function
- "…if" inside function
(use-package evil-textobj-tree-sitter) ;; bind `function.outer`(entire function block) to `f` for use in things like `vaf`, `yaf` (define-key evil-outer-text-objects-map "f" (evil-textobj-tree-sitter-get-textobj "function.outer")) ;; bind `function.inner`(function block without name and args) to `f` for use in things like `vif`, `yif` (define-key evil-inner-text-objects-map "f" (evil-textobj-tree-sitter-get-textobj "function.inner")) ;; You can also bind multiple items and we will match the first one we can find (define-key evil-outer-text-objects-map "a" (evil-textobj-tree-sitter-get-textobj ("if_statement.outer" "conditional.outer" "loop.outer") '((python-mode . ((if_statement.outer) @if_statement.outer)) (python-ts-mode . ((if_statement.outer) @if_statement.outer)))))
4.3.7.8. evil-textobj-tree-sitter
(use-package evil-numbers)
4.3.8. ispell
This should setup a wordlist that can be used as a dictionary. However, for some reason this does not work, and I will need to further investigate this issue.
;; set the NixOS wordlist by hand (setq ispell-alternate-dictionary (getenv "WORDLIST"))
4.3.9. Font Configuration
Here I define my fonts to be used. Honestly I do not understand the face-attributes and pitches of emacs all too well. It seems this configuration works fine, but I might have to revisit this at some point in the future.
(dolist (face '(default fixed-pitch)) (set-face-attribute face nil :font "FiraCode Nerd Font Mono")) (add-to-list 'default-frame-alist '(font . "FiraCode Nerd Font Mono")) (set-face-attribute 'default nil :height 100) (set-face-attribute 'fixed-pitch nil :height 1.0) (set-face-attribute 'variable-pitch nil :family "IBM Plex Sans" :weight 'regular :height 1.06)
4.3.10. Theme
I have grown to love the doom-citylights
theme and have modeled my whole system after it. Also solaire-mode is a nice mode that inverts the alt-faces with the normal faces for specific 'minor' buffers (like Help-buffers).
(use-package solaire-mode :custom (solaire-global-mode +1)) (use-package doom-themes :hook (server-after-make-frame . (lambda () (load-theme 'doom-city-lights t))) :config (load-theme 'doom-city-lights t) (doom-themes-treemacs-config) (doom-themes-org-config))
4.3.11. Icons
This section loads the base icons used in my configuration. I am using nerd-icons
over all-the-icons
since the former seems to have more integrations with different packages than the latter.
Used in:
(use-package nerd-icons)
4.3.12. Variable Pitch Mode
This minor mode allows mixing fixed and variable pitch fonts within the same buffer.
(use-package mixed-pitch :custom (mixed-pitch-set-height nil) (mixed-pitch-variable-pitch-cursor nil) :hook (text-mode . mixed-pitch-mode))
4.3.13. Modeline
Here I set up the modeline with some information that I find useful. Specficially I am using the doom modeline. Most informations I disable for it, except for the cursor information (row + column) as well as a widget for mu4e
and git information.
I have currently disabled this in favor of mini-modeline.
(use-package doom-modeline :init ;; (doom-modeline-mode) ;; (column-number-mode) :custom ((doom-modeline-height 22) (doom-modeline-indent-info nil) (doom-modeline-buffer-encoding nil)))
4.3.14. mini-modeline
I have found that the doom-modeline, while very useful, consumes too much screen space for my liking. This modeline takes a more minimalistic approach.
(use-package mini-modeline :after smart-mode-line :config (mini-modeline-mode t) (setq mini-modeline-display-gui-line nil) (setq mini-modeline-enhance-visual nil) (setq mini-modeline-truncate-p nil) (setq mini-modeline-l-format nil) (setq mini-modeline-right-padding 5) (setq window-divider-mode t) (setq window-divider-default-places t) (setq window-divider-default-bottom-width 1) (setq window-divider-default-right-width 1) (setq mini-modeline-r-format '("%e" mode-line-front-space mode-line-mule-info mode-line-client mode-line-modified mode-line-remote mode-line-frame-identification mode-line-buffer-identification " " mode-line-position " " mode-name evil-mode-line-tag )) ) (use-package smart-mode-line :config (sml/setup) (add-to-list 'sml/replacer-regexp-list '("^~/Documents/Work/" ":WK:")) (add-to-list 'sml/replacer-regexp-list '("^~/Documents/Private/" ":PR:")) (add-to-list 'sml/replacer-regexp-list '("^~/.dotfiles/" ":D:") t) )
4.3.15. Helper Modes
4.3.15.1. Vertico, Orderless, Marginalia, Consult, Embark
This set of packages uses the default emacs completion framework and works together to provide a very nice user experience:
- Vertico simply provides a vertically stacking completion
- Marginalia adds more information to completion results
- Orderless allows for fuzzy matching
- Consult provides better implementations for several user functions, e.g.
consult-line
orconsult-outline
- Embark allows acting on the results in the minibuffer while the completion is still ongoing - this is extremely useful since it allows to, for example, read the documentation for several functions without closing the help search. It can also collect the results of a grep operation into a seperate buffer that edits the result in their original location.
Nerd icons is originally enabled here: Icons
4.3.15.1.1. vertico
(setq read-buffer-completion-ignore-case t read-file-name-completion-ignore-case t completion-ignore-case t) (use-package vertico :custom (vertico-scroll-margin 0) (vertico-count 10) (vertico-resize t) (vertico-cycle t) :init (vertico-mode) (vertico-mouse-mode))
4.3.15.1.2. vertico-directory
This package allows for Ido
-like directory navigation.
(use-package vertico-directory :ensure nil :after vertico :bind (:map vertico-map ("RET" . vertico-directory-enter) ("C-DEL" . vertico-directory-delete-word) ("DEL" . vertico-directory-delete-char)) ;; Tidy shadowed file names :hook (rfn-eshadow-update-overlay . vertico-directory-tidy))
4.3.15.1.3. orderless
When first installing orderless, I often times faced the problem, that when editing long files and calling consult-line
, Emacs would hang when changing a search term in the middle (e.g. from servicse.xserver
to servic.xserver
in order to fix the typo). The below orderless rules have a more strict matching that has a positive impact on performance.
(use-package orderless :config (orderless-define-completion-style orderless+initialism (orderless-matching-styles '(orderless-initialism orderless-literal orderless-regexp))) (setq completion-styles '(orderless) completion-category-defaults nil completion-category-overrides '((file (styles partial-completion orderless+initialism)) (buffer (styles orderless+initialism)) (consult-multi (styles orderless+initialism)) (command (styles orderless+initialism)) (eglot (styles orderless+initialism)) (variable (styles orderless+initialism)) (symbol (styles orderless+initialism))) orderless-matching-styles '(orderless-literal orderless-regexp)))
4.3.15.1.4. consult
The big winner here are the convenient keybinds being setup here for general use. Also, I setup vim-navigation for minibuffer completions. consult-buffer
is set twice because I am still used to that weird C-M-j
command that I chose for ivy-switch-buffer
when I first started using Emacs. I want to move to the other command but for now it is not feasible to delete the other one.
(use-package consult :config (setq consult-fontify-max-size 1024) :bind (("C-x b" . consult-buffer) ("C-c <C-m>" . consult-global-mark) ("C-c C-a" . consult-org-agenda) ("C-x O" . consult-org-heading) ("C-M-j" . consult-buffer) ("C-s" . consult-line) ("M-g M-g" . consult-goto-line) ("M-g i" . consult-imenu) ("M-s M-s" . consult-line-multi) :map minibuffer-local-map ("C-j" . next-line) ("C-k" . previous-line)))
4.3.15.1.5. embark
I have stripped down the embark keybinds heavily. It is very useful to me even in it's current state, but it quickly becomes overwhelming. embark-dwim
acts on a candidate without closing the minibuffer, which is very useful. embark-act
lets the user choose from all actions, but has an overwhelming interface.
(use-package embark :bind (("C-." . embark-act) ("M-." . embark-dwim) ("C-h B" . embark-bindings) ("C-c c" . embark-collect)) :custom (prefix-help-command #'embark-prefix-help-command) (embark-quit-after-action '((t . nil))) :config (add-to-list 'display-buffer-alist '("\\`\\*Embark Collect \\(Live\\|Completions\\)\\*" nil (window-parameters (mode-line-format . none)))))
4.3.15.1.6. embark-consult
Provides previews for embark.
(use-package embark-consult :after (embark consult) :demand t ; only necessary if you have the hook below ;; if you want to have consult previews as you move around an ;; auto-updating embark collect buffer :hook (embark-collect-mode . consult-preview-at-point-mode))
4.3.15.1.7. marginalia
I set the annotation-mode of marginalia to heavy
. This gives even more information on the stuff that you are looking at. One thing I am missing from ivy is the highlighting on mode
-commands based on the current state of the mode. Also, I do not understand all the shorthands used by marginalia yet.
(use-package marginalia :after vertico :init (marginalia-mode) (setq marginalia-annotators '(marginalia-annotators-heavy marginalia-annotators-light nil)))
4.3.15.1.8. nerd-icons-completion
As stated above, this simply provides nerd-icons to the completion framework.
(use-package nerd-icons-completion :after (marginalia nerd-icons) :hook (marginalia-mode . nerd-icons-completion-marginalia-setup) :init (nerd-icons-completion-mode))
4.3.15.2. Helpful + which-key: Better help defaults
This pair of packages provides information on keybinds in addition to function names, which makes it easier to remember keybinds (which-key
). The helpful
package provides a better Help
framework for Emacs. For some reason, the Help windows are always being focused by the cursor even though I have set help-window-select
to nil. I do not understand why.
(use-package which-key :init (which-key-mode) :diminish which-key-mode :config (setq which-key-idle-delay 0.3)) (use-package helpful :bind (("C-h f" . helpful-callable) ("C-h v" . helpful-variable) ("C-h k" . helpful-key) ("C-h C-." . helpful-at-point)) :config (setq help-window-select nil))
4.3.16. Ligatures
Personally, I think ligatures are fancy. With this mode, they stay 'cursorable'. However, I do not need them in all modes, so I only use them in programming modes.
(use-package ligature :init (global-ligature-mode t) :config (ligature-set-ligatures 'prog-mode '("|||>" "<|||" "<==>" "<!--" "####" "~~>" "***" "||=" "||>" ":::" "::=" "=:=" "===" "==>" "=!=" "=>>" "=<<" "=/=" "!==" "!!." ">=>" ">>=" ">>>" ">>-" ">->" "->>" "-->" "---" "-<<" "<~~" "<~>" "<*>" "<||" "<|>" "<$>" "<==" "<=>" "<=<" "<->" "<--" "<-<" "<<=" "<<-" "<<<" "<+>" "</>" "###" "#_(" "..<" "..." "+++" "/==" "///" "_|_" "www" "&&" "^=" "~~" "~@" "~=" "~>" "~-" "**" "*>" "*/" "||" "|}" "|]" "|=" "|>" "|-" "{|" "[|" "]#" "::" ":=" ":>" ":<" "$>" "==" "=>" "!=" "!!" ">:" ">=" ">>" ">-" "-~" "-|" "->" "--" "-<" "<~" "<*" "<|" "<:" "<$" "<=" "<>" "<-" "<<" "<+" "</" "#{" "#[" "#:" "#=" "#!" "##" "#(" "#?" "#_" "%%" ".=" ".." ".?" "+>" "++" "?:" "?=" "?." "??" "/*" "/=" "/>" "//" "__" "~~" "(*" "*)" "\\\\" "://" ";;")))
4.3.17. Popup (popper) + Shackle Buffers
The popper package allows to declare different buffers as 'popup-type', which sort of acts like a scratchpad. It can be toggled at any time using popper-toggle
and the resulting frame can be freely customized (with shackle
) to a certain size. It is also possible to prevent a buffer from appearing - I do this for example to the *Warnings*
buffer, since usually I am not interested in it's output.
popper-echo-mode
shows all buffers that are currently stored as a popup in the echo area when a popup is opened - this is useful since you can cycle between all popup buffers.
(use-package popper :bind (("M-[" . popper-toggle)) :init (setq popper-reference-buffers '("\\*Messages\\*" ("\\*Warnings\\*" . hide) "Output\\*$" "\\*Async Shell Command\\*" "\\*Async-native-compile-log\\*" help-mode helpful-mode "*Occur*" "*scratch*" "*julia*" "*Python*" "*rustic-compilation*" "*cargo-run*" ;; ("*tex-shell*" . hide) (compilation-mode . hide))) (popper-mode +1) (popper-echo-mode +1)) (use-package shackle :config (setq shackle-rules '(("*Messages*" :select t :popup t :align right :size 0.3) ("*Warnings*" :ignore t :popup t :align right :size 0.3) ("*Occur*" :select t :popup t :align below :size 0.2) ("*scratch*" :select t :popup t :align below :size 0.2) ("*Python*" :select t :popup t :align below :size 0.2) ("*rustic-compilation*" :select t :popup t :align below :size 0.4) ("*cargo-run*" :select t :popup t :align below :size 0.2) ("*tex-shell*" :ignore t :popup t :align below :size 0.2) (helpful-mode :select t :popup t :align right :size 0.35) (help-mode :select t :popup t :align right :size 0.4))) (shackle-mode 1))
4.3.18. Indicate first and last line of buffer
This places little angled indicators on the fringe of a window which indicate buffer boundaries. This is not super useful, but makes use of a space that I want to keep for aesthetic reasons anyways and makes it a bit more useful in the process.
(setq-default indicate-buffer-boundaries t)
4.3.19. Authentication
4.4. Modules
This section houses all configuration bits that are related to a specific package that is not fundamental to my Emacs experience.
At some point this will receive further sorting, but for now this is good enough.
4.4.1. Org Mode
org-mode is probably my most-used mode in Emcas. It acts as my organizer, config management tool and calender even.
Note that nearly all headings within the Org-mode
heading are coded within the use-package
setup, so be very careful about moving stuff about here.
4.4.1.1. General org-mode
This sets up the basic org-mode. I wrote a function to handle some of the initial org-mode behaviour in org-mode setup. This part of the configuration mostly makes some aesthetic changes, enables neat LaTeX and points Emacs to some files that it needs for org-mode
(use-package org ;;:diminish (org-indent-mode) :hook (org-mode . swarsel/org-mode-setup) :bind (("C-<tab>" . org-fold-outer) ("C-c s" . org-store-link)) :config (setq org-ellipsis " ⤵" org-link-descriptive t org-hide-emphasis-markers t) (setq org-startup-folded t) (setq org-support-shift-select t) (setq org-agenda-start-with-log-mode t) (setq org-log-done 'time) (setq org-log-into-drawer t) (setq org-startup-with-inline-images t) (setq org-export-headline-levels 6) (setq org-image-actual-width nil) (setq org-format-latex-options '(:foreground "White" :background default :scale 2.0 :html-foreground "Black" :html-background "Transparent" :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))) (setq org-agenda-files '("/home/swarsel/Nextcloud/Org/Tasks.org" "/home/swarsel/Nextcloud/Org/Archive.org" )) (setq org-refile-targets '((swarsel-archive-org-file :maxlevel . 1) (swarsel-tasks-org-file :maxlevel . 1))) )
4.4.1.2. org-appear
This package makes emphasis-markers appear when the cursor moves over them. Very useful as I enjoy the clean look of not always seeing them, but it is annoying not to be able to edit them properly.
(use-package org-appear :hook (org-mode . org-appear-mode) :init (setq org-appear-autolinks t) (setq org-appear-autokeywords t) (setq org-appear-autoentities t) (setq org-appear-autosubmarkers t))
4.4.1.3. Centered org-mode Buffers
I like org-mode buffers to be centered, as I do not find that enormous lines are of big use.
Function definition in: Visual-fill column
(use-package visual-fill-column :hook (org-mode . swarsel/org-mode-visual-fill))
4.4.1.4. Fix headings not folding sometimes
There is a weird bug in org-mode that makes it so that headings were not folding correctly sometimes. This setting seems to fix it.
(setq org-fold-core-style 'overlays)
4.4.1.5. Babel
org-babel allows to run blocks in other programming languages within an org-mode buffer, similar to what e.g. jupyterhub offers for python.
It also offers a very useful utility of exporting org-mode buffers to different formats; the feature I enjoy most is what makes this file useful: the tangling functionality.
4.4.1.5.1. Language Configuration
- This configures the languages that babel recognizes.
(setq org-src-preserve-indentation nil) (org-babel-do-load-languages 'org-babel-load-languages '((emacs-lisp . t) (python . t) (js . t) (shell . t) )) (push '("conf-unix" . conf-unix) org-src-lang-modes) (setq org-export-with-broken-links 'mark) (setq org-confirm-babel-evaluate nil) ;; tangle is too slow, try to speed it up (defadvice org-babel-tangle-single-block (around inhibit-redisplay activate protect compile) "inhibit-redisplay and inhibit-message to avoid flicker." (let ((inhibit-redisplay t) (inhibit-message t)) ad-do-it)) (defadvice org-babel-tangle (around time-it activate compile) "Display the execution time" (let ((tim (current-time))) ad-do-it (message "org-tangle took %f sec" (float-time (time-subtract (current-time) tim)))))
4.4.1.5.2. old easy structure templates
org 9.2 changed the way structure templates work. This brings back the old way it worked.
Usage: Type
<
, followed by one of the below keywords and pressRET
. The corresponding source block should appear.(require 'org-tempo) (add-to-list 'org-structure-template-alist '("sh" . "src shell")) (add-to-list 'org-structure-template-alist '("el" . "src emacs-lisp")) (add-to-list 'org-structure-template-alist '("py" . "src python :results output")) (add-to-list 'org-structure-template-alist '("nix" . "src nix :tangle"))
4.4.1.6. aucTex
This provides several utilities for LaTeX in Emacs, including many completions and convenience functions for math-mode.
(use-package auctex) (setq TeX-auto-save t) (setq TeX-save-query nil) (setq TeX-parse-self t) (setq-default TeX-engine 'luatex) (setq-default TeX-master nil) (add-hook 'LaTeX-mode-hook 'visual-line-mode) (add-hook 'LaTeX-mode-hook 'flyspell-mode) (add-hook 'LaTeX-mode-hook 'LaTeX-math-mode) (add-hook 'LaTeX-mode-hook 'reftex-mode) (setq LaTeX-electric-left-right-brace t) (setq font-latex-fontify-script nil) (setq TeX-electric-sub-and-superscript t) ;; (setq reftex-plug-into-AUCTeX t)
4.4.1.7. org-download
This package allows to download and copy images into org-mode buffers. Sadly it does not work in a very stable manner - if you copy images that are also links to another page (like is often the case in a Google image search), Emacs might crash from this.
4.4.1.8. org-fragtog
This package automatically toggles LaTeX-fragments in org-files. It seems to also work in markdown-files which is a nice addition, as my Obsidian notes are held in markdown.
(use-package org-fragtog) (add-hook 'org-mode-hook 'org-fragtog-mode) (add-hook 'markdown-mode-hook 'org-fragtog-mode)
4.4.1.9. org-modern
This just makes org-mode a little bit more beautiful, mostly by making the begin_src
and end_src
tags in source-blocks turn into more beautiful icons, as well as hiding #+
tags before them, as well as in the properties section of the file.
(use-package org-modern :config (setq org-modern-block-name '((t . t) ("src" "»" "∥"))) :hook (org-mode . org-modern-mode))
4.4.1.10. Presentations
Recently I have grown fond of holding presentations using Emacs :)
(use-package org-present :bind (:map org-present-mode-keymap ("q" . org-present-quit) ("<left>" . swarsel/org-present-prev) ("<up>" . 'ignore) ("<down>" . 'ignore) ("<right>" . swarsel/org-present-next)) :hook ((org-present-mode . swarsel/org-present-start) (org-present-mode-quit . swarsel/org-present-end)) ) (use-package hide-mode-line) (defun swarsel/org-present-start () (setq-local face-remapping-alist '((default (:height 1.5) variable-pitch) (header-line (:height 4.0) variable-pitch) (org-document-title (:height 1.75) org-document-title) (org-code (:height 1.55) org-code) (org-verbatim (:height 1.55) org-verbatim) (org-block (:height 1.25) org-block) (org-block-begin-line (:height 0.7) org-block) )) (dolist (face '((org-level-1 . 1.1) (org-level-2 . 1.2) (org-level-3 . 1.2) (org-level-4 . 1.2) (org-level-5 . 1.2) (org-level-6 . 1.2) (org-level-7 . 1.2) (org-level-8 . 1.2))) (set-face-attribute (car face) nil :font swarsel-alt-font :weight 'medium :height (cdr face))) (setq header-line-format " ") (setq visual-fill-column-width 90) (setq indicate-buffer-boundaries nil) (setq inhibit-message nil) ;; (breadcrumb-mode 0) (org-display-inline-images) (global-hl-line-mode 0) ;; (display-line-numbers-mode 0) (org-modern-mode 0) (evil-insert-state 1) (beginning-of-buffer) (org-present-read-only) ;; (org-present-hide-cursor) (swarsel/org-present-slide) ) (defun swarsel/org-present-end () (setq-local face-remapping-alist '((default variable-pitch default))) (dolist (face '((org-level-1 . 1.1) (org-level-2 . 0.9) (org-level-3 . 0.9) (org-level-4 . 0.9) (org-level-5 . 0.9) (org-level-6 . 0.9) (org-level-7 . 0.9) (org-level-8 . 0.9))) (set-face-attribute (car face) nil :font swarsel-alt-font :weight 'medium :height (cdr face))) (setq header-line-format nil) (setq visual-fill-column-width 150) (setq indicate-buffer-boundaries t) (setq inhibit-message nil) ;; (breadcrumb-mode 1) (global-hl-line-mode 1) ;; (display-line-numbers-mode 1) (org-remove-inline-images) (org-modern-mode 1) (evil-normal-state 1) ;; (org-present-show-cursor) ) (defun swarsel/org-present-slide () (org-overview) (org-show-entry) (org-show-children) ) (defun swarsel/org-present-prev () (interactive) (org-present-prev) (swarsel/org-present-slide)) (defun swarsel/org-present-next () (interactive) (unless (eobp) (org-next-visible-heading 1) (org-fold-show-entry)) (when (eobp) (org-present-next) (swarsel/org-present-slide) )) (defun clojure-leave-clojure-mode-function () ) (add-hook 'buffer-list-update-hook #'clojure-leave-clojure-mode-function) (add-hook 'org-present-mode-hook 'swarsel/org-present-start) (add-hook 'org-present-mode-quit-hook 'swarsel/org-present-end) (add-hook 'org-present-after-navigate-functions 'swarsel/org-present-slide)
4.4.2. Nix Mode
This adds a rudimentary nix-mode to Emacs. I have not really tried this out, as I am mostly editing nix-files in org-mode anyways.
(use-package nix-mode) (use-package nix-ts-mode :mode "\\.nix\\'")
4.4.3. HCL Mode
This adds support for Hashicorp Configuration Language. I need this at work.
(use-package hcl-mode :mode "\\.hcl\\'" :config (setq hcl-indent-level 2))
4.4.4. Jenkinsfile/Groovy
This adds support for Groovy, which I specifically need to work with Jenkinsfiles. I need this at work.
(use-package groovy-mode) (use-package jenkinsfile-mode :mode "Jenkinsfile")
4.4.5. Ansible
(use-package ansible)
4.4.6. Dockerfile
This adds support for Dockerfiles. I need this at work.
(use-package dockerfile-mode :mode "Dockerfile")
4.4.7. Terraform Mode
This adds support for Terraform configuration files. I need this at work.
(use-package terraform-mode :mode "\\.tf\\'" :config (setq terraform-indent-level 2) (setq terraform-format-on-save t)) (add-hook 'terraform-mode-hook #'outline-minor-mode)
4.4.8. nixpkgs-fmt
Adds functions for formatting nix code.
(use-package nixpkgs-fmt)
4.4.9. shfmt
Adds functions for formatting shellscripts.
(use-package shfmt :config (setq shfmt-command "shfmt") (setq shfmt-arguments '("-i" "4" "-s" "-sr")))
4.4.10. Markdown Mode
4.4.10.1. Mode
(setq markdown-command "pandoc") (use-package markdown-mode :ensure t :mode ("README\\.md\\'" . gfm-mode) :init (setq markdown-command "multimarkdown") :bind (:map markdown-mode-map ("C-c C-e" . markdown-do)))
4.4.10.2. LaTeX in Markdown
(add-hook 'markdown-mode-hook (lambda () (local-set-key (kbd "C-c C-x C-l") 'org-latex-preview) (local-set-key (kbd "C-c C-x C-u") 'markdown-toggle-url-hiding) ))
4.4.11. elfeed
(use-package elfeed) (use-package elfeed-goodies) (elfeed-goodies/setup) (setq elfeed-db-directory "~/.elfeed/db/") (use-package elfeed-protocol :after elfeed) (elfeed-protocol-enable) (setq elfeed-use-curl t) (setq elfeed-set-timeout 36000) (setq elfeed-protocol-enabled-protocols '(fever)) (setq elfeed-protocol-fever-update-unread-only t) (setq elfeed-protocol-fever-fetch-category-as-tag t) (setq elfeed-protocol-feeds '(("fever+https://Swarsel@signpost.swarsel.win" :api-url "https://signpost.swarsel.win/api/fever.php" :password-file "~/.emacs.d/.fever"))) (define-key elfeed-show-mode-map (kbd ";") 'visual-fill-column-mode) (define-key elfeed-show-mode-map (kbd "j") 'elfeed-goodies/split-show-next) (define-key elfeed-show-mode-map (kbd "k") 'elfeed-goodies/split-show-prev) (define-key elfeed-search-mode-map (kbd "j") 'next-line) (define-key elfeed-search-mode-map (kbd "k") 'previous-line) (define-key elfeed-show-mode-map (kbd "S-SPC") 'scroll-down-command)
4.4.12. Ripgrep
This is the ripgrep command for Emacs.
(use-package rg)
4.4.13. Tree-sitter
Tree-sitter is a parsing library integrated into Emacs to provide better syntax highlighting and code analysis. It generates concrete syntax trees for source code, enabling more accurate and efficient text processing. Emacs' tree-sitter integration enhances language support, offering features like incremental parsing and precise syntax-aware editing. This improves the development experience by providing robust and dynamic syntax features, making it easier for me to navigate and manipulate code.
In order to update the language grammars, run the next command below.
(mapc #'treesit-install-language-grammar (mapcar #'car treesit-language-source-alist))
;; (use-package emacs ;; :ensure nil ;; :init ;; (setq treesit-language-source-alist ;; '((bash . ("https://github.com/tree-sitter/tree-sitter-bash")) ;; (c . ("https://github.com/tree-sitter/tree-sitter-c")) ;; (cmake . ("https://github.com/uyha/tree-sitter-cmake")) ;; (cpp . ("https://github.com/tree-sitter/tree-sitter-cpp")) ;; (css . ("https://github.com/tree-sitter/tree-sitter-css")) ;; (elisp . ("https://github.com/Wilfred/tree-sitter-elisp")) ;; (go . ("https://github.com/tree-sitter/tree-sitter-go")) ;; (html . ("https://github.com/tree-sitter/tree-sitter-html")) ;; (javascript . ("https://github.com/tree-sitter/tree-sitter-javascript")) ;; (json . ("https://github.com/tree-sitter/tree-sitter-json")) ;; (julia . ("https://github.com/tree-sitter/tree-sitter-julia")) ;; (latex . ("https://github.com/latex-lsp/tree-sitter-latex")) ;; (make . ("https://github.com/alemuller/tree-sitter-make")) ;; (markdown . ("https://github.com/ikatyang/tree-sitter-markdown")) ;; (nix . ("https://github.com/nix-community/tree-sitter-nix")) ;; (R . ("https://github.com/r-lib/tree-sitter-r")) ;; (python . ("https://github.com/tree-sitter/tree-sitter-python")) ;; (typescript . ("https://github.com/tree-sitter/tree-sitter-typescript" "typescript/src" "typescript")) ;; (rust . ("https://github.com/tree-sitter/tree-sitter-rust")) ;; (sql . ("https://github.com/m-novikov/tree-sitter-sql")) ;; (toml . ("https://github.com/tree-sitter/tree-sitter-toml")) ;; (tsx . ("https://github.com/tree-sitter/tree-sitter-typescript" "master" "typescript/src")) ;; (yaml . ("https://github.com/ikatyang/tree-sitter-yaml")))) ;; ) (use-package treesit-auto :custom (setq treesit-auto-install t) :config (treesit-auto-add-to-auto-mode-alist 'all) (global-treesit-auto-mode))
4.4.14. direnv (envrc)
In emacs, there are two packages for managing dev environments - emacs-direnv (direnv) and envrc. Direnv uses the global Emacs environment whereas envrc is buffer-local. I do not really care about this difference. What is more important to me is that emacs should not block upon handling a bigger flake.nix while setting up the dev environment. This seems to be better handled by envrc.
;; (use-package direnv ;; :custom (direnv-always-show-summary nil) ;; :config (direnv-mode)) (use-package envrc :hook (after-init . envrc-global-mode))
4.4.15. avy
avy
provides the ability to search for any character on the screen (not only in the current buffer!) - I enjoy this utility a lot and use it possibly even more often than the native vim commands.
(use-package avy :bind (("M-o" . avy-goto-char-timer)) :config (setq avy-all-windows 'all-frames))
4.4.16. devdocs
devdocs
is a very nice package that provides documentation from https:devdocs.io. This is very useful since e.g. pyright
provides only a very bad documentation and I do not want to leave Emacs all the time just to read documentation.
To install a documentation, use the devdocs=install
command and select the appropriate version. devdocs-update-all
can be used to download and reinstall all installed documents if a newer version is available. Check documentation with devdocs-lookup
(C-SPC h d
).
(use-package devdocs) (add-hook 'python-mode-hook (lambda () (setq-local devdocs-current-docs '("python~3.12" "numpy~1.23" "matplotlib~3.7" "pandas~1")))) (add-hook 'python-ts-mode-hook (lambda () (setq-local devdocs-current-docs '("python~3.12" "numpy~1.23" "matplotlib~3.7" "pandas~1")))) (add-hook 'c-mode-hook (lambda () (setq-local devdocs-current-docs '("c")))) (add-hook 'c-ts-mode-hook (lambda () (setq-local devdocs-current-docs '("c")))) (add-hook 'c++-mode-hook (lambda () (setq-local devdocs-current-docs '("cpp")))) (add-hook 'c++-ts-mode-hook (lambda () (setq-local devdocs-current-docs '("cpp")))) ; (devdocs-update-all)
4.4.17. Projectile
projectile is useful for keeping track of your git projects within Emacs. I mostly use it to quickly switch between projects.
(use-package projectile :diminish projectile-mode :config (projectile-mode) :custom ((projectile-completion-system 'auto)) ;; integrate ivy into completion system :bind-keymap ("C-c p" . projectile-command-map) ; all projectile commands under this :init ;; NOTE: Set this to the folder where you keep your Git repos! (when (file-directory-p swarsel-work-projects-directory) (when (file-directory-p swarsel-private-projects-directory) (setq projectile-project-search-path (list swarsel-work-projects-directory swarsel-private-projects-directory)))) (setq projectile-switch-project-action #'magit-status))
4.4.18. Magit
magit is the best git utility I have ever used - it has a beautiful interface and is very verbose. Here I mostly just setup the list of repositories that I want to expost to magit.
Also, Emacs needs a little extra love to accept my Yubikey for git commits etc. We also set that here.
(use-package magit :config (setq magit-repository-directories `((,swarsel-work-projects-directory . 1) (,swarsel-private-projects-directory . 1) ("~/.dotfiles/" . 0))) :custom (magit-display-buffer-function #'magit-display-buffer-same-window-except-diff-v1)) ; stay in the same window
4.4.19. Yubikey support
The following settings are needed to make sure emacs works for magit commits and pushes. It is not a beautiful solution since commiting uses pinentry-emacs and pushing uses pinentry-gtk2, but it works for now at least.
;; yubikey support for pushing commits ;; commiting is enabled through nixos gpg-agent config (use-package pinentry) (pinentry-start) (setq epg-pinentry-mode 'loopback) (setenv "SSH_AUTH_SOCK" (string-chop-newline (shell-command-to-string "gpgconf --list-dirs agent-ssh-socket")))
4.4.20. Forge
NOTE: Make sure to configure a GitHub token before using this package!
- https://magit.vc/manual/forge/Token-Creation.html#Token-Creation
- https://magit.vc/manual/ghub/Getting-Started.html#Getting-Started
- https://magit.vc/manual/ghub/Storing-a-Token.html
https://www.emacswiki.org/emacs/GnuPG
(1) in practice: github -<> settings -<> developer option -<> create classic token with repo; user; read:org permissions (2)machine api.github.com login USERNAMEforge password 012345abcdef…
(use-package forge :after magit)
4.4.21. git-timemachine
This is just a nice utility to browse different versions of a file of a git project within Emacs.
(use-package git-timemachine :hook (git-time-machine-mode . evil-normalize-keymaps) :init (setq git-timemachine-show-minibuffer-details t))
4.4.22. Delimiters (brackets): rainbow-delimiters, highlight-parentheses
- rainbow-delimiters colors all delimiters, also ones not in current selection
- paren highlights the current delimiter selection especially bold
- highlight-parentheses boldly highlights all delimiters in current selection
I am not completely sure on electric-pair-mode yet, sometimes it is very helpful, sometimes it annoys me to no end.
(use-package rainbow-delimiters :hook (prog-mode . rainbow-delimiters-mode)) (use-package highlight-parentheses :config (setq highlight-parentheses-colors '("black" "white" "black" "black" "black" "black" "black")) (setq highlight-parentheses-background-colors '("magenta" "blue" "cyan" "green" "yellow" "orange" "red")) (global-highlight-parentheses-mode t)) ;; (electric-pair-mode 1) ;; (setq electric-pair-preserve-balance t) ;; (setq electric-pair-skip-self nil) ;; (setq electric-pair-delete-adjacent-pairs t) ;; don't skip newline when auto-pairing parenthesis ;; (setq electric-pair-skip-whitespace-chars '(9 32)) ;; in org-mode buffers, do not pair < and > in order not to interfere with org-tempo ;; (add-hook 'org-mode-hook (lambda () ;; (setq-local electric-pair-inhibit-predicate ;; `(lambda (c) ;; (if (char-equal c ?<) t (,electric-pair-inhibit-predicate c))))))
4.4.23. rainbow-mode
Complimentary to the delimiters-packages above, this package sets the background color of the delimiters, which makes it easier to see at a glance where we are in a delimiter-tree.
(use-package rainbow-mode :config (rainbow-mode))
4.4.24. Corfu
This is the company equivalent to the vertico gang.
I dislike the standard behaviour that makes the cursor move into the completion framework on presses of <up>
and <down>
.
Nerd icons is originally enabled here: Icons
Navigation functions defined here: corfu: Do not interrupt navigation
(use-package corfu :init (global-corfu-mode) (corfu-history-mode) (corfu-popupinfo-mode) ; Popup completion info :custom (corfu-auto t) (corfu-auto-prefix 3) (corfu-auto-delay 1) (corfu-cycle t) (corfu-quit-no-match 'separator) (corfu-separator ?\s) ;; (corfu-quit-no-match t) (corfu-popupinfo-max-height 70) (corfu-popupinfo-delay '(0.5 . 0.2)) ;; (corfu-preview-current 'insert) ; insert previewed candidate (corfu-preselect 'prompt) (corfu-on-exact-match nil) ; Don't auto expand tempel snippets ;; Optionally use TAB for cycling, default is `corfu-complete'. :bind (:map corfu-map ("M-SPC" . corfu-insert-separator) ("<return>" . swarsel/corfu-normal-return) ;; ("C-<return>" . swarsel/corfu-complete) ("S-<up>" . corfu-popupinfo-scroll-down) ("S-<down>" . corfu-popupinfo-scroll-up) ("C-<up>" . corfu-previous) ("C-<down>" . corfu-next) ("<insert-state> <up>" . swarsel/corfu-quit-and-up) ("<insert-state> <down>" . swarsel/corfu-quit-and-down)) ) (use-package nerd-icons-corfu) (add-to-list 'corfu-margin-formatters #'nerd-icons-corfu-formatter) (setq nerd-icons-corfu-mapping '((array :style "cod" :icon "symbol_array" :face font-lock-type-face) (boolean :style "cod" :icon "symbol_boolean" :face font-lock-builtin-face) ;; ... (t :style "cod" :icon "code" :face font-lock-warning-face)))
4.4.25. cape
cape adds even more completion capabilities by adding a lot of completion logic that is exposed as separate functions. I tried out adding these to the completion-at-points-functions
alist, but I felt like it cluttered my suggestions too much. Hence I now just call the respective functions when I need them. For this I setup the C-z
keybinding in General evil.
I leave the commented out alist extensions here in case I want to try them out at some point in the future.
(use-package cape :bind ("C-z p" . completion-at-point) ;; capf ("C-z t" . complete-tag) ;; etags ("C-z d" . cape-dabbrev) ;; or dabbrev-completion ("C-z h" . cape-history) ("C-z f" . cape-file) ("C-z k" . cape-keyword) ("C-z s" . cape-elisp-symbol) ("C-z e" . cape-elisp-block) ("C-z a" . cape-abbrev) ("C-z l" . cape-line) ("C-z w" . cape-dict) ("C-z :" . cape-emoji) ("C-z \\" . cape-tex) ("C-z _" . cape-tex) ("C-z ^" . cape-tex) ("C-z &" . cape-sgml) ("C-z r" . cape-rfc1345) )
4.4.26. rust
This sets up rustic-mode with tree-sitter support - there is still one issue to iron out with automatic adding of dependency crates, but everything else works fine now.
(use-package rustic :init (setq rust-mode-treesitter-derive t) :config (define-key rust-ts-mode-map (kbd "C-c C-c C-r") 'rustic-cargo-run) (define-key rust-ts-mode-map (kbd "C-c C-c C-b") 'rustic-cargo-build) (define-key rust-ts-mode-map (kbd "C-c C-c C-k") 'rustic-cargo-check) (define-key rust-ts-mode-map (kbd "C-c C-c d") 'rustic-cargo-doc) (define-key rust-ts-mode-map (kbd "C-c C-c a") 'rustic-cargo-add) (setq rustic-format-on-save t) (setq rustic-lsp-client 'eglot) :mode ("\\.rs" . rustic-mode))
4.4.27. Tramp
Tramp allows for SSH access of files over Emacs. I have no ideas what the options here mean, but this is a recommended configuration that I found (sadly I lost the link). I need to research more what these options really do.
(use-package tramp :init (setq vc-ignore-dir-regexp (format "\\(%s\\)\\|\\(%s\\)" vc-ignore-dir-regexp tramp-file-name-regexp)) (setq tramp-default-method "ssh") (setq tramp-auto-save-directory (expand-file-name "tramp-auto-save" user-emacs-directory)) (setq tramp-persistency-file-name (expand-file-name "tramp-connection-history" user-emacs-directory)) (setq password-cache-expiry nil) (setq tramp-use-ssh-controlmaster-options nil) (setq remote-file-name-inhibit-cache nil) :config (customize-set-variable 'tramp-ssh-controlmaster-options (concat "-o ControlPath=/tmp/ssh-tramp-%%r@%%h:%%p " "-o ControlMaster=auto -o ControlPersist=yes")) ) (setq vterm-tramp-shells '(("ssh" "'sh'")))
4.4.28. diff-hl
This is a simple highlighting utility that uses the margin to visually show the differences since the last git commit.
(use-package diff-hl :hook ((prog-mode org-mode) . diff-hl-mode) :init (diff-hl-flydiff-mode) (diff-hl-margin-mode) (diff-hl-show-hunk-mouse-mode))
4.4.29. Commenting
This package allows for swift commenting out and in of code snippets. For some reason, it is a bit broken in my config, as it sometimes comments out too much, sometimes too little, and sometimes it splits lines during commenting. Also, in org-mode when inside a src-block, it often times jumps to the top of the block.
Still, this is avery convenient package.
(use-package evil-nerd-commenter :bind ("M-/" . evilnc-comment-or-uncomment-lines))
4.4.30. eglot
Up comes the section of lsp clients for Emacs. For a longer time, I thought that I had to choose one only, and after having started with lsp-mode
I had tried out lsp-booster
and then went to eglot
. My requirements are as follow:
Must have:
- mostly unintrusive, non-blocking
- fast (configurable) completion
- xref (or similar)
Nice to have:
- Debugger
- Multi-lsp support (running two lsp's on a single project)
- Native Emacs support
eglot
fills most items on the first list except for the non-blocking issue initially. It blocks sometimes on bigger projects as well as when entering directories using (nix-)direnv and the lsp is not yet loaded. The first issue is solved by using eglot-booster
, which increases the parsing speed by what feels like a huge margin (but I never ran any actual tests). The second issue is solved with eglot-sync-connect
, which avoids blocking the interface while the server is starting.
A blocking issue can still occur while entering a direnv that has a longer evaluation/build time. That issue can only be fixed by using Mic92's emacs-direnv fork, which calls direnv asynchronously, which in turn avoids the blocking. I am not using this on a daily basis however, since my environments are normally cached anyways and most of them (except for the LaTeX one) are not blocking for long enough for this to be worth it. However, I am considering spinning up my own fork of this at some point.
(use-package eglot :hook ((python-mode python-ts-mode c-mode c-ts-mode c++-mode c++-ts-mode go-mode go-ts-mode rust-ts-mode rustic-mode tex-mode LaTeX-mode ) . (lambda () (progn (eglot-ensure) (add-hook 'before-save-hook 'eglot-format nil 'local)))) :custom (eldoc-echo-area-use-multiline-p nil) (completion-category-defaults nil) (fset #'jsonrpc--log-event #'ignore) (eglot-events-buffer-size 0) (eglot-sync-connect nil) (eglot-connect-timeout nil) (eglot-autoshutdown t) (eglot-send-changes-idle-time 3) (flymake-no-changes-timeout 5) :bind (:map eglot-mode-map ("M-(" . flymake-goto-next-error) ("C-c ," . eglot-code-actions))) (use-package eglot-booster :ensure nil :after eglot :config (eglot-booster-mode)) (defalias 'start-lsp-server #'eglot)
4.4.31. lsp-mode & company
(use-package lsp-bridge :ensure nil) (use-package lsp-mode :init ;; set prefix for lsp-command-keymap (few alternatives - "C-l", "C-c l") (setq lsp-keymap-prefix "C-c l") :commands lsp) (use-package company)
4.4.32. lsp-bridge
(use-package lsp-bridge :ensure nil) (use-package lsp-mode :init ;; set prefix for lsp-command-keymap (few alternatives - "C-l", "C-c l") (setq lsp-keymap-prefix "C-c l") :commands lsp) (use-package company)
4.4.33. sideline-flymake
This brings back warnings and errors on the sideline for eglot; a feature that I have been missing from lsp-mode for a while.
(use-package sideline-flymake :hook (flymake-mode . sideline-mode) :init (setq sideline-flymake-display-mode 'point) ; 'point to show errors only on point ; 'line to show errors on the current line (setq sideline-backends-right '(sideline-flymake)))
4.4.34. Prevent breaking of hardlinks
This setting ensures that hard links are preserved during the backup process, which is useful for maintaining the integrity of files that are linked in multiple locations.
(setq backup-by-copying-when-linked t)
4.4.35. Dirvish
Dirvish is an improvement upon the dired-framework and has more features like file preview etc. Sadly it has an incompatibility with openwith
which is why I have disabled that package.
(use-package dirvish :init (dirvish-override-dired-mode) :config (dirvish-peek-mode) (dirvish-side-follow-mode) (setq dirvish-open-with-programs (append dirvish-open-with-programs '( (("xlsx" "docx" "doc" "odt" "ods") "libreoffice" "%f") (("jpg" "jpeg" "png") "imv" "%f") (("pdf") "sioyek" "%f") (("xopp") "xournalpp" "%f")))) :custom (delete-by-moving-to-trash t) (dired-listing-switches "-l --almost-all --human-readable --group-directories-first --no-group") (dirvish-attributes '(vc-state subtree-state nerd-icons collapse file-time file-size)) (dirvish-quick-access-entries '(("h" "~/" "Home") ("c" "~/.dotfiles/" "Config") ("d" "~/Downloads/" "Downloads") ("D" "~/Documents/" "Documents") ("p" "~/Documents/GitHub/" "Projects") ("/" "/" "Root"))) :bind (("<DUMMY-i> d" . 'dirvish) ("C-=" . 'dirvish-side) :map dirvish-mode-map ("h" . dired-up-directory) ("<left>" . dired-up-directory) ("l" . dired-find-file) ("<right>" . dired-find-file) ("j" . evil-next-visual-line) ("k" . evil-previous-visual-line) ("a" . dirvish-quick-access) ("f" . dirvish-file-info-menu) ("z" . dirvish-history-last) ("J" . dirvish-history-jump) ("y" . dirvish-yank-menu) ("/" . dirvish-narrow) ("TAB" . dirvish-subtree-toggle) ("M-f" . dirvish-history-go-forward) ("M-b" . dirvish-history-go-backward) ("M-l" . dirvish-ls-switches-menu) ("M-m" . dirvish-mark-menu) ("M-t" . dirvish-layout-toggle) ("M-s" . dirvish-setup-menu) ("M-e" . dirvish-emerge-menu) ("M-j" . dirvish-fd-jump)))
4.4.36. undo-tree
Base emacs undo logic is very useful, but not easy to understand for me. I prefer undo-tree, which makes switching between branches easier and also allows quickly switching back to a much older state using the visualizer.
Evil needs to be told to use this mode, see (evil-set-undo-system 'undo-tree)
in Evil/General.
By default, I am not using undo-tree-mode in every buffer. This might change in the future, but for now this is fine. It can be enabled manually should the need arise.
While we are at it, we are also setting up a persistent undo-file for every file that we are working with.
(use-package undo-tree :init (global-undo-tree-mode) :bind (:map undo-tree-visualizer-mode-map ("h" . undo-tree-visualize-switch-branch-left) ("l" . undo-tree-visualize-switch-branch-left) ("j" . undo-tree-visualize-redo) ("k" . undo-tree-visualize-undo)) :config (setq undo-tree-history-directory-alist '(("." . "~/.emacs.d/undo"))))
4.4.37. Hydra
Hydra allows for the writing of macro-style functions. I have not yet looked into this all too much, but it seems to be a potent feature.
(use-package hydra)
4.4.37.1. Text scaling
I only wrote this in order to try out hydra; rarely do I really need this. However, it can be useful for Presentations. It simply scales the text size.
;; change the text size of the current buffer (defhydra hydra-text-scale (:timeout 4) "scale text" ("j" text-scale-increase "in") ("k" text-scale-decrease "out") ("f" nil "finished" :exit t))
4.4.38. Email
4.4.38.1. mu4e
In this section we are setting up mu4e, a mail client for emacs using mu with mbsync as backend. The mail accounts themselves are setup in the NixOS configuration, so we only need to add Emacs specific settings here.
The hook functions are defined here: mu4e functions
(use-package mu4e :ensure nil ;; :load-path "/usr/share/emacs/site-lisp/mu4e/" ;;:defer 20 ; Wait until 20 seconds after startup :config ;; This is set to 't' to avoid mail syncing issues when using mbsync (setq send-mail-function 'sendmail-send-it) (setq mu4e-change-filenames-when-moving t) (setq mu4e-mu-binary (executable-find "mu")) (setq mu4e-hide-index-messages t) (setq mu4e-update-interval 180) (setq mu4e-get-mail-command "mbsync -a") (setq mu4e-maildir "~/Mail") ;; enable inline images (setq mu4e-view-show-images t) ;; use imagemagick, if available (when (fboundp 'imagemagick-register-types) (imagemagick-register-types)) (setq mu4e-drafts-folder "/Drafts") (setq mu4e-sent-folder "/Sent Mail") (setq mu4e-refile-folder "/All Mail") (setq mu4e-trash-folder "/Trash") (setq mu4e-maildir-shortcuts '((:maildir "/leon/Inbox" :key ?1) (:maildir "/nautilus/Inbox" :key ?2) (:maildir "/mrswarsel/Inbox" :key ?3) (:maildir "/Sent Mail" :key ?s) (:maildir "/Trash" :key ?t) (:maildir "/Drafts" :key ?d) (:maildir "/All Mail" :key ?a))) (setq user-mail-address "leon@swarsel.win" user-full-name "Leon Schwarzäugl") (setq mu4e-user-mail-address-list '(leon.schwarzaeugl@gmail.com leon@swarsel.win nautilus.dw@gmail.com mrswarsel@gmail.com))) (add-hook 'mu4e-compose-mode-hook #'swarsel/mu4e-send-from-correct-address) (add-hook 'mu4e-compose-post-hook #'swarsel/mu4e-restore-default)
4.4.38.2. mu4e-alert
This adds the simple utility of sending desktop notifications whenever a new mail is received. I am using libnotify
because I want to use this with notify-send
.
(use-package mu4e-alert :config (setq mu4e-alert-set-default-style 'libnotify)) (add-hook 'after-init-hook #'mu4e-alert-enable-notifications) (mu4e t)
4.4.39. Calendar
This provides a beautiful calender to emacs.
Yes, I am aware that I am exposing my university-calendar to the public here. I can imagine worse things ;) if you however know how to obscure this, let me know!
(use-package org-caldav :init ;; set org-caldav-sync-initalization (setq swarsel-caldav-synced 0) (setq org-caldav-url "https://stash.swarsel.win/remote.php/dav/calendars/Swarsel") (setq org-caldav-calendars '((:calendar-id "personal" :inbox "~/Calendars/leon_cal.org"))) (setq org-caldav-files '("~/Calendars/leon_cal.org")) ;; (setq org-caldav-backup-file "~/org-caldav/org-caldav-backup.org") ;; (setq org-caldav-save-directory "~/org-caldav/") :config (setq org-icalendar-alarm-time 1) ;; This makes sure to-do items as a category can show up on the calendar (setq org-icalendar-include-todo t) ;; This ensures all org "deadlines" show up, and show up as due dates (setq org-icalendar-use-deadline '(event-if-todo event-if-not-todo todo-due)) ;; This ensures "scheduled" org items show up, and show up as start times (setq org-icalendar-use-scheduled '(todo-start event-if-todo event-if-not-todo)) ) (use-package calfw :ensure nil :bind ("C-c A" . swarsel/open-calendar) :init (use-package calfw-cal :ensure nil) (use-package calfw-org :ensure nil) (use-package calfw-ical :ensure nil) :config (bind-key "g" 'cfw:refresh-calendar-buffer cfw:calendar-mode-map) (bind-key "q" 'evil-quit cfw:details-mode-map) ;; (custom-set-faces ;; '(cfw:face-title ((t (:foreground "#f0dfaf" :weight bold :height 65)))) ;; ) ) (defun swarsel/open-calendar () (interactive) (unless (eq swarsel-caldav-synced 1) (org-caldav-sync) (setq swarsel-caldav-synced 1)) ;; (select-frame (make-frame '((name . "calendar")))) ; makes a new frame and selects it ;; (set-face-attribute 'default (selected-frame) :height 65) ; reduces the font size of the new frame (cfw:open-calendar-buffer :contents-sources (list (cfw:org-create-source "Purple") ; orgmode source (cfw:ical-create-source "TISS" "https://tiss.tuwien.ac.at/events/rest/calendar/personal?locale=de&token=4463bf7a-87a3-490a-b54c-99b4a65192f3" "Cyan"))))
4.4.40. Dashboard: emacs startup screen
This sets up the dashboard
, which is really quite useless. But, it looks cool and makes me happy whenever I start an emacsclient without a file name as argument :)
(use-package dashboard :ensure t :config (dashboard-setup-startup-hook) ;; (setq initial-buffer-choice (lambda () (get-buffer-create "*dashboard*"))) (setq dashboard-display-icons-p t ;; display icons on both GUI and terminal dashboard-icon-type 'nerd-icons ;; use `nerd-icons' package dashboard-set-file-icons t dashboard-items '((recents . 5) (projects . 5) (agenda . 5)) dashboard-set-footer nil dashboard-banner-logo-title "Welcome to SwarsEmacs!" dashboard-image-banner-max-height 300 dashboard-startup-banner "~/.dotfiles/wallpaper/swarsel.png" dashboard-projects-backend 'projectile dashboard-projects-switch-function 'magit-status dashboard-set-navigator t dashboard-startupify-list '(dashboard-insert-banner dashboard-insert-newline dashboard-insert-banner-title dashboard-insert-newline dashboard-insert-navigator dashboard-insert-newline dashboard-insert-init-info dashboard-insert-items ) dashboard-navigator-buttons `(;; line1 ((,"" "SwarselSocial" "Browse Swarsele" (lambda (&rest _) (browse-url "instagram.com/Swarsele"))) (,"" "SwarselSound" "Browse SwarselSound" (lambda (&rest _) (browse-url "sound.swarsel.win")) ) (,"" "SwarselSwarsel" "Browse Swarsel" (lambda (&rest _) (browse-url "github.com/Swarsel")) ) (,"" "SwarselStash" "Browse SwarselStash" (lambda (&rest _) (browse-url "stash.swarsel.win")) ) (,"" "SwarselSport" "Browse SwarselSports" (lambda (&rest _) (browse-url "social.parkour.wien/@Lenno"))) ) ( (,"" "swarsel.win" "Browse swarsel.win" (lambda (&rest _) (browse-url "swarsel.win"))) ) )))
4.4.41. vterm
(use-package vterm :ensure t)
4.4.42. multiple cursors
(use-package multiple-cursors)
4.4.43. Less logging
(setq mu4e--log-max-size 1000) (setq message-log-max 30) (setq comint-buffer-maximum-size 50) (add-hook 'comint-output-filter-functions 'comint-truncate-buffer)
5. Appendix A: Noweb-Ref blocks
These blocks are used in several places throughout the configurations, but not on all machines necessarily. For example, the theming section needs to be in a NixOS block on NixOS machines but in a home-manager block on non-NixOS.
Originally, I used this method a lot throughout my configuration. However, as my knowledge of NixOS grew, I have been weeding these snippets out more and more as I find more efficient native solutions. Now, only the theming block remains.
This serves only to reduce code duplication in this file. The tangled files experience no size reduction, since noweb-ref only substitutes these blocks in.
For styling, I am using the stylix NixOS module, loaded by flake. This package is really great, as it adds nix expressions for basically everything. Ever since switching to this, I did not have to play around with theming anywhere else.
The full list of nerd-fonts can be found here: https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/data/fonts/nerd-fonts/manifests/fonts.json
This is where the theme for the whole OS is defined. Originally, this noweb-ref section could not be copied to the general NixOS config since they are on different folder structure levels in the config, which would have made the flake impure. By now, I have found out that using the ${self}
method for referencing the flake root, I could circumvent this problem. Also, the noweb-ref block could in general be replaced by a custom attribute set (see for example firefox). The difference here was, for a long time, that this block is used in a NixOS and a home-manager-only configuration, verbatim. If I were to use an attribute set, I would have to duplicate this block once each for NixOS and home-manager. Alas, this block stays (for now). However, I learned how to use an attribute set in a custom home-manager module and pass it to both NixOS and home-manager configurations, which also removed the need for that use of it.
enable = true; base16Scheme = "${self}/programs/stylix/swarsel.yaml"; polarity = "dark"; opacity.popups = 0.5; cursor = { package = pkgs.banana-cursor; # package = pkgs.capitaine-cursors; name = "Banana"; # name = "capitaine-cursors"; size = 16; }; fonts = { sizes = { terminal = 10; applications = 11; }; serif = { # package = (pkgs.nerdfonts.override { fonts = [ "FiraMono" "FiraCode"]; }); package = pkgs.cantarell-fonts; # package = pkgs.montserrat; name = "Cantarell"; # name = "FiraCode Nerd Font Propo"; # name = "Montserrat"; }; sansSerif = { # package = (pkgs.nerdfonts.override { fonts = [ "FiraMono" "FiraCode"]; }); package = pkgs.cantarell-fonts; # package = pkgs.montserrat; name = "Cantarell"; # name = "FiraCode Nerd Font Propo"; # name = "Montserrat"; }; monospace = { package = pkgs.nerd-fonts.fira-mono; # has overrides name = "FiraCode Nerd Font Mono"; }; emoji = { package = pkgs.noto-fonts-emoji; name = "Noto Color Emoji"; }; };
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
.
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)
.
(require 'package) (package-initialize nil) (setq package-enable-at-startup nil) (add-to-list 'package-archives '("org" . "http://orgmode.org/elpa/") t) (add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/") t) (package-initialize) (let ((default-directory "~/.emacs.d/elpa/")) (normal-top-level-add-subdirs-to-load-path)) (unless (package-installed-p 'use-package) (package-refresh-contents) (package-install 'use-package)) (require 'use-package) (use-package elfeed :ensure t :bind (:map elfeed-search-mode-map ("q" . bjm/elfeed-save-db-and-bury))) (require 'elfeed) (use-package elfeed-org :ensure t :config (elfeed-org) (setq rmh-elfeed-org-files (list "/var/lib/syncthing/.elfeed/elfeed.org"))) (use-package elfeed-goodies :ensure t) (elfeed-goodies/setup) (use-package elfeed-web :ensure t) (global-set-key (kbd "C-x w") 'bjm/elfeed-load-db-and-open) (define-key elfeed-show-mode-map (kbd "j") 'elfeed-goodies/split-show-next) (define-key elfeed-show-mode-map (kbd "k") 'elfeed-goodies/split-show-prev) (define-key elfeed-search-mode-map (kbd "j") 'next-line) (define-key elfeed-search-mode-map (kbd "k") 'previous-line) (define-key elfeed-show-mode-map (kbd "S-SPC") 'scroll-down-command) (defun bjm/elfeed-save-db-and-bury () "Wrapper to save the elfeed db to disk before burying buffer" (interactive) (elfeed-db-save) (quit-window)) (defun bjm/elfeed-load-db-and-open () "Wrapper to load the elfeed db from disk before opening" (interactive) (elfeed-db-load) (elfeed) (elfeed-search-update--force) (elfeed-update)) (defun bjm/elfeed-updater () "Wrapper to load the elfeed db from disk before opening" (interactive) (elfeed-db-load)) (run-with-timer 0 (* 1 60) 'bjm/elfeed-updater) (setq httpd-port 9812) (setq httpd-host "0.0.0.0") (setq httpd-root "/root/.emacs.d/elpa/elfeed-web-20240729.1741/") (setq elfeed-db-directory "/var/lib/syncthing/.elfeed/db/") (httpd-start) (elfeed-web-start)
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.
The command
command can be supplied with a -p
flag that will take a single argmuent which is exposed as JS_ARG
. I use this in a function that switches to an open tab if it exists and otherwise creates it.
sanitise tridactyllocal tridactylsync colourscheme base16-codeschool " General Settings set update.lastchecktime 1720629386560 set update.lastnaggedversion 1.24.1 set update.nag true set update.nagwait 7 set update.checkintervalsecs 86400 set configversion 2.0 set searchurls.no https://search.nixos.org/options?query= set searchurls.np https://search.nixos.org/packages?query= set searchurls.hm https://home-manager-options.extranix.com/?query= set completions.Tab.statusstylepretty true set hintfiltermode vimperator-reflow set hintnames numeric " Binds bind <C-m> buffer # bind gd tabdetach bind gD composite tabduplicate; tabdetach bind d composite tabprev; tabclose # bind D tabclose bind c hint bindurl ^http(s)?://www\.google\.com c hint -Jc [class="LC20lb MBeuO DKV0Md"],[class="YmvwI"],[class="YyVfkd"],[class="fl"] bindurl ^http(s)?://news\.ycombinator\.com c hint -Jc [class="titleline"],[class="age"] bindurl ^http(s)?://lobste\.rs c hint -Jc [class="u-url"],[class="comments_label"] bindurl ^http(s)?://www\.google\.com gi composite focusinput -l ; text.end_of_line " Work command tab_or_tabopen jsb -p (async () => { let tabs = await browser.tabs.query({}); let tab = tabs.find(t => t.url.includes(JS_ARG)); if (tab) {browser.tabs.update(tab.id, { active: true });} else {tri.excmds.tabopen(JS_ARG);}})() bind gwa tab_or_tabopen apic-impimba-1.m.imp.ac.at bind gwA tab_or_tabopen artifactory.imp.ac.at bind gwb tab_or_tabopen bitbucket.vbc.ac.at bind gwc tab_or_tabopen vbc.atlassian.net/wiki bind gwd tab_or_tabopen datadomain-impimba-2.imp.ac.at bind gwe tab_or_tabopen exivity.vbc.ac.at bind gwg tab_or_tabopen github.com bind gwG tab_or_tabopen goc.egi.eu bind gwh tab_or_tabopen jupyterhub.vbc.ac.at bind gwH tab_or_tabopen test-jupyterhub.vbc.ac.at bind gwj tab_or_tabopen jenkins.vbc.ac.at bind gwJ tab_or_tabopen test-jenkins.vbc.ac.at bind gwl tab_or_tabopen lucid.app bind gwm tab_or_tabopen monitoring.vbc.ac.at/grafana bind gwM tab_or_tabopen monitoring.vbc.ac.at/prometheus bind gwn tab_or_tabopen netbox.vbc.ac.at bind gwN tab_or_tabopen nap.imp.ac.at bind gwo tab_or_tabopen outlook.office.com bind gws tab_or_tabopen satellite.vbc.ac.at bind gwt tab_or_tabopen tower.vbc.ac.at bind gwv tab_or_tabopen vc-impimba-1.m.imp.ac.at/ui bind gwx tab_or_tabopen xclarity.vbc.ac.at " Search in page set findcase smart bind / fillcmdline find bind ? fillcmdline find -? bind n findnext 1 bind N findnext -1 bind j scrollline 4 bind k scrollline -4 " WARNING: This file defines and runs a command called fixamo_quiet. If you " also have a malicious addon that operates on `<all_urls>` installed this " will allow it to steal your firefox account credentials! " " With those credentials, an attacker can read anything in your sync account, " publish addons to the AMO, etc, etc. " " Without this command a malicious addon can steal credentials from any site " that you visit that is not in the restrictedDomains list. " " You should comment out the fixamo lines unless you are entirely sure that " they are what you want. command fixamo_quiet jsb tri.excmds.setpref("privacy.resistFingerprinting.block_mozAddonManager", "true").then(tri.excmds.setpref("extensions.webextensions.restrictedDomains", '""')) command fixamo js tri.excmds.setpref("privacy.resistFingerprinting.block_mozAddonManager", "true").then(tri.excmds.setpref("extensions.webextensions.restrictedDomains", '""').then(tri.excmds.fillcmdline_tmp(3000, "Permissions added to user.js. Please restart Firefox to make them take affect."))) fixamo_quiet set allowautofocus false " The following modification allows Tridactyl to function on more pages, e.g. raw GitHub pages. " You may not wish to run this. Mozilla strongly feels that you shouldn't. " Read https://wiki.mozilla.org/Security/CSP#Goals for more information. " " Equivalent to `set csp clobber` before it was removed. " This weakens your defences against cross-site-scripting attacks " and other types of code-injection by reducing the strictness " of Content Security Policy on all sites in a couple of ways. " " We remove the sandbox directive " https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/sandbox " which allows our iframe (and anyone else's) to run on any website. " " We weaken the style-src directive " https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/style-src " to allow us to theme our elements. " This exposes you to 'cross site styling' attacks jsb browser.webRequest.onHeadersReceived.addListener(tri.request.clobberCSP,{urls:["<all_urls>"],types:["main_frame"]},["blocking","responseHeaders"]) " default is 300ms set hintdelay 100 " Some pages like github break on the tridactyl quick search. have this as a fallback unbind <C-f> " Subconfig Settings seturl www.google.com followpagepatterns.next Next seturl www.google.com followpagepatterns.prev Previous " Autocmds autocmd DocStart undefined mode ignore autocmd DocStart pokerogue.net mode ignore autocmd DocStart typelit.io mode ignore autocmd DocStart vc-impimba-1.m.imp.ac.at/ui/webconsole mode ignore " For syntax highlighting see https://github.com/tridactyl/vim-tridactyl " vim: set filetype=tridactyl
6.3. Waybar style.css
This is the stylesheet used by waybar.
@define-color foreground #fdf6e3; @define-color background #1a1a1a; @define-color background-alt #292b2e; @define-color foreground-warning #268bd2; @define-color background-warning @background; @define-color foreground-error red; @define-color background-error @background; @define-color foreground-critical gold; @define-color background-critical blue; * { border: none; border-radius: 0; font-family: "FiraCode Nerd Font Propo", "Font Awesome 5 Free"; font-size: 14px; min-height: 0; margin: -1px 0px; } window#waybar { background: transparent; color: @foreground; transition-duration: .5s; } window#waybar.hidden { opacity: 0.2; } #mpris { padding: 0 10px; background-color: transparent; color: #1DB954; font-family: Monospace; font-size: 12px; } #custom-right-arrow-dark, #custom-left-arrow-dark { color: @background; background: @background-alt; font-size: 24px; } #window { font-size: 12px; padding: 0 20px; } #mode { background: @background-critical; color: @foreground-critical; padding: 0 3px; } #privacy, #custom-configwarn { color: black; padding: 0 3px; animation-name: configblink; animation-duration: 0.5s; animation-timing-function: linear; animation-iteration-count: infinite; animation-direction: alternate; } #custom-nix-updates { color: white; padding: 0 3px; } #custom-outer-right-arrow-dark, #custom-outer-left-arrow-dark { color: @background; font-size: 24px; } #custom-outer-left-arrow-dark, #custom-left-arrow-dark, #custom-left-arrow-light { margin: 0 -1px; } #custom-right-arrow-light, #custom-left-arrow-light { color: @background-alt; background: @background; font-size: 24px; } #workspaces, #clock.1, #clock.2, #clock.3, #pulseaudio, #memory, #cpu, #temperature, #custom-scratchpad-indicator, #power-profiles-daemon, #idle_inhibitor, #backlight-slider, #mpris, #tray { background: @background; } #network, #custom-vpn, #clock.2, #battery, #cpu, #custom-pseudobat, #disk { background: @background-alt; } #workspaces button { padding: 0 2px; color: #fdf6e3; } #workspaces button.focused { color: @foreground-warning; } #workspaces button:hover { background: @foreground; color: @background; border: @foreground; padding: 0 2px; box-shadow: inherit; text-shadow: inherit; } #workspaces button.urgent { color: @background-critical; background: @foreground-critical; } #custom-vpn, #network { color: #cc99c9; } #temperature, #power-profiles-daemon { color: #9ec1cf; } #disk { /*color: #b58900;*/ color: #9ee09e; } #custom-scratchpad-indicator { color: #ffffff; } #disk.warning { color: @foreground-error; background-color: @background-error; } #disk.critical, #temperature.critical { color: @foreground-critical; background-color: @background-critical; animation-name: blink; animation-duration: 0.5s; animation-timing-function: linear; animation-iteration-count: infinite; animation-direction: alternate; } #pulseaudio.muted { color: @foreground-error; } #memory { /*color: #2aa198;*/ color: #fdfd97; } #cpu { /*color: #6c71c4;*/ color: #feb144; } #pulseaudio { /*color: #268bd2;*/ color: #ff6663; } #battery, #custom-pseudobat { color: cyan; } #battery.discharging { color: #859900; } @keyframes blink { to { color: @foreground-error; background-color: @background-error; } } @keyframes configblink { to { color: @foreground-error; background-color: transparent; } } #battery.critical:not(.charging) { color: @foreground-critical; background-color: @background-critical; animation-name: blink; animation-duration: 0.5s; animation-timing-function: linear; animation-iteration-count: infinite; animation-direction: alternate; } #backlight-slider slider { min-height: 0px; min-width: 0px; opacity: 0; background-image: none; border: none; box-shadow: none; } #backlight-slider trough { min-height: 5px; min-width: 80px; border-radius: 5px; background-color: black; } #backlight-slider highlight { min-width: 0px; border-radius: 5px; background-color: grey; } #clock.1, #clock.2, #clock.3 { font-family: Monospace; } #clock, #pulseaudio, #memory, #cpu, #tray, #temperature, #power-profiles-daemon, #network, #custom-vpn, #mpris, #battery, #custom-scratchpad-indicator, #custom-pseudobat, #disk { padding: 0 3px; }
6.4. 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.
(In the org-src block I still call it a Makefile in order to get syntax highlighting)
default: @just --list check: nix flake check --keep-going check-trace: nix flake check --show-trace update: nix flake update iso: rm -rf result nix build .#nixosConfigurations.iso.config.system.build.isoImage && ln -sf result/iso/*.iso latest.iso iso-flake FLAKE SYSTEM="x86_64" FORMAT="iso": nixos-generate --flake .#{{FLAKE}} -f {{FORMAT}} --system {{SYSTEM}} iso-install DRIVE: iso sudo dd if=$(eza --sort changed result/iso/*.iso | tail -n1) of={{DRIVE}} bs=4M status=progress oflag=sync dd DRIVE ISO: sudo dd if=$(eza --sort changed {{ISO}} | tail -n1) of={{DRIVE}} bs=4M status=progress oflag=sync sync USER HOST: rsync -av --filter=':- .gitignore' -e "ssh -l {{USER}}" . {{USER}}@{{HOST}}:.dotfiles/
6.5. statix.toml
This file is used to tell statix
which checks and folders/fiels to ignore, as well as to specify the nix version that it should use.
I need this mainly to disable the repeated_keys
check, which checks if there is an attribute set called twice without stepping into it. While in general this should be avoided, since I am tangling some files and need to use the top-level attribute in each org-src block, the check would fail for all these cases.
disabled = [ "repeated_keys" ] nix_version = '2.4' ignore = ['.direnv']