nix/README.md

178 lines
7.8 KiB
Markdown
Raw Normal View History

2023-07-01 11:51:07 +02:00
# NixOS Configuration Repository
2023-09-23 15:41:18 +02:00
## NOTE: These configs expect this repo to be cloned to `/etc/nixos/git/`
2023-12-21 09:18:32 +01:00
* Clone this repo
```
sudo git clone https://git.sysctl.io/albert/nix /etc/nixos/git
2023-12-21 09:19:23 +01:00
sudo chown -R albert:root /etc/nixos/git
2023-12-21 09:18:32 +01:00
# or, with wallpapers
sudo git clone --recursive https://git.sysctl.io/albert/nix /etc/nixos/git
2023-12-21 09:19:23 +01:00
sudo chown -R albert:root /etc/nixos/git
2023-12-21 09:18:32 +01:00
```
2023-09-15 11:27:38 +02:00
2024-03-27 02:10:20 +01:00
* Installation:
2023-09-21 07:43:49 +02:00
```
2023-09-22 03:45:07 +02:00
nixos-install <Hostname> [<Username>]
2023-12-21 09:18:32 +01:00
# or
2023-11-27 04:59:26 +01:00
./docs/install.sh <Hostname> [<Username>]
```
2024-05-06 15:01:35 +02:00
* Post install (home-manager, secrets, etc)
2023-09-23 15:32:23 +02:00
```
nix develop -c /etc/nixos/git/docs/setup.sh
```
2023-10-13 03:58:39 +02:00
2023-12-29 09:12:42 +01:00
# Machines
2024-04-30 01:26:54 +02:00
| Name | Description | Status | deploy-rs |
| ----------------- | ------------------------------------------------------ | -------- | --------- |
2024-04-30 05:00:50 +02:00
| backups-rpi4 | Japan Raspberry Pi 4 for backups from nuc-server | ✔️ | ✔️ |
| framework-server | sysctl.io - main server, framework 13th gen mainboard | ✔️ | ✔️ |
| nixos-desktop | My main desktop | ✔️ | ❌ |
| nixos-framework | My AMD Framework 13 laptop | ✔️ | ❌ |
| osaka-linode-01 | Osaka Linode relay for sysctl.io external connections | ✔️ | ✔️ |
| milan-linode-01 | Milan Linode DERP relay for Tailscale | ✔️ | ✔️ |
| piaware-rpi4 | FlightAware for Raspberry Pi | ✔️ | ✔️ |
| bakersfield-rpi4 | Raspberry Pi at my brothers house. Headscale Exit Node | ✔️ | ✔️ |
| steamdeck | Valve Steam Deck, handheld gaming console | ✔️ | ❌ |
2024-04-28 07:55:13 +02:00
| Name | Description | Status |
| ----------------- | ------------------------------------------------------ | -------- |
2024-04-24 03:40:47 +02:00
| quitman-rpi4 | Raspberry Pi at my parents house. Headscale Exit Node | On Hold |
| nuc-server | Second NUC server at my brothers house | On Hold |
2024-01-12 11:28:11 +01:00
2023-12-29 09:12:42 +01:00
# Images
2024-01-12 11:55:35 +01:00
| Name | Description | Build Commands |
| ----------------- | ----------------------------------------------- | --------------------------------------------------- |
2024-01-26 07:14:23 +01:00
| nixos-iso-console | Console ISO image of this flake for installing | `nix build .#imageConfigurations.nixos-iso-console` |
| nixos-iso-desktop | Gnome ISO image of this flake for installing | `nix build .#imageConfigurations.nixos-iso-desktop` |
2024-01-12 11:55:35 +01:00
| nixos-linode-img | Image of this flake for use on Linode | `nix build .#imageConfigurations.nixos-linode-img` |
| nixos-rpi4-img | Image of this flake for use on Raspberry Pi 4's | `nix build .#imageConfigurations.nixos-rpi4-img` |
2023-12-29 09:12:42 +01:00
2023-07-01 11:51:07 +02:00
---
2024-04-30 05:00:50 +02:00
# 📋 To Do List
2024-04-30 01:19:12 +02:00
* [ ] Fix sysctl backup script
2024-04-24 06:25:16 +02:00
* [ ] 24.05 Updates:
* [ ] Re-enable a few things <SPC-S> "TODO"
* [ ] Add sound to XRDP config
2024-05-03 06:41:43 +02:00
* [ ] vimPlugins.outline-nvim
2023-12-20 05:13:02 +01:00
2024-05-06 15:06:06 +02:00
## home-manager
2023-12-20 05:13:02 +01:00
* [ ] Figure out what the home-manager `account` options are for.
2024-01-07 14:38:28 +01:00
* [ ] Find a way to remove all default search engines in Firefox (Google, Amazon, etc)
2023-12-20 05:13:02 +01:00
2024-05-06 15:08:52 +02:00
Completed To Do List [here](./docs/complete.md)
2023-09-23 15:41:18 +02:00
---
2024-04-30 05:00:50 +02:00
# Information
### 🏠 Home Manager
2023-09-23 15:41:18 +02:00
* Home Manager Documentation - [Link](https://nix-community.github.io/home-manager/index.html)
* Home Manager Options Search - [Link](https://mipmip.github.io/home-manager-option-search/)
2024-04-30 05:00:50 +02:00
### ❄️ NixOS
2023-12-17 13:07:03 +01:00
* nix.dev - Official Nix Documentation - [Link](https://nix.dev/)
2023-09-23 15:41:18 +02:00
* NixOS Documentation - Stable - [Link](https://nixos.org/manual/nixos/stable/)
* NixOS Packages / Options Search - [Link](https://search.nixos.org/)
* Nix User Repository (NUR) Search - [Link](https://nur.nix-community.org/)
* ARM NixOS Building - [Link](https://nixos.wiki/wiki/NixOS_on_ARM#NixOS_installation_.26_configuration)
2023-10-06 05:52:40 +02:00
* NixOS Manual - [Link](https://nixos.org/manual/nix/unstable/introduction)
2023-09-23 15:41:18 +02:00
2024-04-30 05:00:50 +02:00
### 🔗 Useful Links
2023-09-23 15:41:18 +02:00
* FlakeHub - [Link](https://flakehub.com)
2023-12-17 13:00:34 +01:00
* Flakestry.dev - [Link](https://flakestry.dev/)
2023-09-23 15:41:18 +02:00
* Track a Nixpkgs PR - [Link](https://nixpk.gs/pr-tracker.html)
* Awesome-Hyprland - [Link](https://github.com/hyprland-community/awesome-hyprland)
2024-04-30 05:00:50 +02:00
### 🌐 Examples
2023-09-23 15:41:18 +02:00
* Tons of good examples here - [Link](https://github.com/Mic92/dotfiles/blob/main/nixos/modules/)
* NixOS Flakes Intro Guide - [Link](https://nixos-and-flakes.thiscute.world/)
2024-04-30 05:00:50 +02:00
### 👀 Theming
2023-09-23 15:41:18 +02:00
* Neofetch Themes - [Link](https://github.com/Chick2D/neofetch-themes/)
2023-12-16 01:02:47 +01:00
* Stylix - [Link](https://github.com/danth/stylix)
2023-12-26 12:28:35 +01:00
* Hyprland Inspirations
* Aylur - [Link](https://github.com/Aylur/dotfiles)
2024-01-07 14:37:08 +01:00
* Base16 Color Schemes - [Link](https://tinted-theming.github.io/base16-gallery/)
2023-09-23 15:41:18 +02:00
2023-08-15 04:05:06 +02:00
---
2024-04-30 05:00:50 +02:00
# 🔒 Lanzaboote / SecureBoot
2023-09-23 15:41:18 +02:00
* Instructions here - [Link](https://git.sysctl.io/Mirrors/lanzaboote/src/branch/master/docs/QUICK_START.md)
2024-02-10 02:39:17 +01:00
2024-04-30 05:00:50 +02:00
## 🔒 Generic Instructions:
2023-09-23 15:41:18 +02:00
1. Create your keys: `sbctl create-keys`
2. Verify your machine is ready for SecureBoot: `sbctl verify` - Everything except `*-bzImage.efi` are signed
3. Enter Secureboot Setup mode in your EFI Settings on the motherboard (F10)
* Security -> SecureBoot -> Set to Enabled and "Reset to Setup Mode" and exit
4. Enroll the keys: `sbctl enroll-keys --microsoft`
* If you wish, you can select `--tpm-eventlog`, but checksums will change later (ie, at a kernel rebuild)
5. Reboot and verify you are activated: `bootctl status`
2024-04-30 05:00:50 +02:00
## 💻 Framework Specific:
2024-02-12 04:54:48 +01:00
1. Change boot import from `boot.nix` to `secureboot.nix` in `./nixos/hosts/<hostname>/default.nix`
4. Run `rebuild-host` to switch from `boot.nix` to `secureboot.nix`
2. Reboot into EUFI and set SecureBoot settings to:
* Enforce Secure Boot - Enabled
* Erase all Secure Boot Settings - Enabled
* Restore Secure Boot to Factory Settings - Disabled
3. Save and reboot
4. Run `sudo sbctl create-keys`
5. Run `sudo sbctl enroll-keys`
2024-03-27 02:10:20 +01:00
6. Reboot and verify with `bootctl status`
2024-02-10 02:39:17 +01:00
2024-04-30 05:00:50 +02:00
# 🗝️ Manual: GPG Keys
2023-09-23 15:41:18 +02:00
1. Import the user private key: `gpg --import gpg/users/albert/privkey.asc`
2. Mark it as trusted: `gpg --edit-key albert@sysctl.io`, then type `trust`, then `5`
3. On each new machine, run `sudo nix-shell -p ssh-to-pgp --run "ssh-to-pgp -i /etc/ssh/ssh_host_rsa_key -o /etc/nixos/git/keys/hosts/$(hostname).asc"`
* This will output the identifier you add to `.sops.yaml`
* Move `HOSTNAME.asc` to `keys/hosts/` and upload to git and rename accordingly.
2024-04-30 05:00:50 +02:00
# 🔐 Secrets
2023-09-23 15:41:18 +02:00
1. Run `nix-develop` in `/etc/nixos/git` to import new keys
2. To edit a file: `sops secrets/file.yml"`
2024-03-27 02:10:20 +01:00
3. When you add a new machine, you must update the secrets files encryption.
* Ensure `.sops.yaml` has the updated fingerprint and file mappings.
2023-09-23 15:41:18 +02:00
* Run `sops updatekeys secrets/file.yaml` and commit the change.
2024-04-30 05:00:50 +02:00
# Troubleshooting
2023-12-15 02:41:35 +01:00
1. To troubleshoot disko issues, this command can come in handy:
2023-10-05 08:07:38 +02:00
```
2024-02-01 05:02:04 +01:00
nix eval .#nixosConfigurations.`hostname`.config.disko.devices._config
2023-10-05 08:07:38 +02:00
```
2023-08-15 04:05:06 +02:00
2023-09-19 10:39:24 +02:00
# Directory Structure
2023-09-18 09:29:17 +02:00
```
2024-01-07 14:37:08 +01:00
/etc/nixos/git/
2023-09-29 06:09:10 +02:00
├── docs
2023-09-18 09:29:17 +02:00
├── home-manager
│   ├── common
│   │   ├── desktops
│   │   └── software
│   │   ├── cli
│   │   └── gui
│   ├── hosts
│   └── users
├── keys
│   ├── hosts
│   ├── ssh
│   └── users
├── lib
├── nixos
│   ├── common
│   │   ├── desktops
│   │   ├── modules
2024-05-01 04:15:05 +02:00
│   │   ├── packages
2023-09-18 09:29:17 +02:00
│   │   ├── services
│   │   └── software
│   │   ├── cli
│   │   └── gui
│   ├── hosts
2024-03-27 02:10:20 +01:00
│   ├── containers
2023-09-18 09:29:17 +02:00
│   └── users
├── secrets
2024-03-27 02:10:20 +01:00
│   ├── containers
│   └── hosts
2024-01-07 14:37:08 +01:00
├── stylix
2024-03-27 02:10:20 +01:00
│   ├── common
│   └── themes
2023-09-18 09:29:17 +02:00
└── wallpapers
2023-12-10 10:54:57 +01:00
```