albert/nix
albert/nix
1
0
Fork 0
Code Issues Pull requests Activity Actions

Update readme

Browse source
This commit is contained in:
albert 2024-04-30 12:00:50 +09:00
parent 4d58fb7366
commit 5b9399650f
No known key found for this signature in database
GPG key ID: 64F6C4EB46C4543A
1 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
README.md
View file

@ -23,15 +23,15 @@ nix develop -c /etc/nixos/git/docs/setup.sh
# Machines # Machines
| Name | Description | Status | deploy-rs | | Name | Description | Status | deploy-rs |
| ----------------- | ------------------------------------------------------ | -------- | --------- | | ----------------- | ------------------------------------------------------ | -------- | --------- |
| backups-rpi4 | Japan Raspberry Pi 4 for backups from nuc-server | Complete | Yes | | backups-rpi4 | Japan Raspberry Pi 4 for backups from nuc-server | ✔️ | ✔️ |
| framework-server | sysctl.io - main server, framework 13th gen mainboard | Complete | Yes | | framework-server | sysctl.io - main server, framework 13th gen mainboard | ✔️ | ✔️ |
| nixos-desktop | My main desktop | Complete | No | | nixos-desktop | My main desktop | ✔️ | ❌ |
| nixos-framework | My AMD Framework 13 laptop | Complete | No | | nixos-framework | My AMD Framework 13 laptop | ✔️ | ❌ |
| osaka-linode-01 | Osaka Linode relay for sysctl.io external connections | Complete | Yes | | osaka-linode-01 | Osaka Linode relay for sysctl.io external connections | ✔️ | ✔️ |
| milan-linode-01 | Milan Linode DERP relay for Tailscale | Complete | Yes | | milan-linode-01 | Milan Linode DERP relay for Tailscale | ✔️ | ✔️ |
| piaware-rpi4 | FlightAware for Raspberry Pi | Complete | Yes | | piaware-rpi4 | FlightAware for Raspberry Pi | ✔️ | ✔️ |
| bakersfield-rpi4 | Raspberry Pi at my brothers house. Headscale Exit Node | Complete | Yes | | bakersfield-rpi4 | Raspberry Pi at my brothers house. Headscale Exit Node | ✔️ | ✔️ |
| steamdeck | Valve Steam Deck, handheld gaming console | Complete | No | | steamdeck | Valve Steam Deck, handheld gaming console | ✔️ | ❌ |
| Name | Description | Status | | Name | Description | Status |
| ----------------- | ------------------------------------------------------ | -------- | | ----------------- | ------------------------------------------------------ | -------- |
@ -47,7 +47,7 @@ nix develop -c /etc/nixos/git/docs/setup.sh
| nixos-rpi4-img | Image of this flake for use on Raspberry Pi 4's | `nix build .#imageConfigurations.nixos-rpi4-img` | | nixos-rpi4-img | Image of this flake for use on Raspberry Pi 4's | `nix build .#imageConfigurations.nixos-rpi4-img` |
--- ---
# To Do List # 📋 To Do List
* [x] Steam Deck config * [x] Steam Deck config
* [x] Jellyfin * [x] Jellyfin
* [x] Complete bakersfield-rpi4 image * [x] Complete bakersfield-rpi4 image
@ -68,12 +68,12 @@ Completed ToDo List [here](./docs/complete.md)
--- ---
# Information # ℹ️ Information
### Home Manager ### 🏠 Home Manager
* Home Manager Documentation - [Link](https://nix-community.github.io/home-manager/index.html) * 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/) * Home Manager Options Search - [Link](https://mipmip.github.io/home-manager-option-search/)
### NixOS ### ❄️ NixOS
* nix.dev - Official Nix Documentation - [Link](https://nix.dev/) * nix.dev - Official Nix Documentation - [Link](https://nix.dev/)
* NixOS Documentation - Stable - [Link](https://nixos.org/manual/nixos/stable/) * NixOS Documentation - Stable - [Link](https://nixos.org/manual/nixos/stable/)
* NixOS Packages / Options Search - [Link](https://search.nixos.org/) * NixOS Packages / Options Search - [Link](https://search.nixos.org/)
@ -81,17 +81,17 @@ Completed ToDo List [here](./docs/complete.md)
* ARM NixOS Building - [Link](https://nixos.wiki/wiki/NixOS_on_ARM#NixOS_installation_.26_configuration) * ARM NixOS Building - [Link](https://nixos.wiki/wiki/NixOS_on_ARM#NixOS_installation_.26_configuration)
* NixOS Manual - [Link](https://nixos.org/manual/nix/unstable/introduction) * NixOS Manual - [Link](https://nixos.org/manual/nix/unstable/introduction)
### Useful Links ### 🔗 Useful Links
* FlakeHub - [Link](https://flakehub.com) * FlakeHub - [Link](https://flakehub.com)
* Flakestry.dev - [Link](https://flakestry.dev/) * Flakestry.dev - [Link](https://flakestry.dev/)
* Track a Nixpkgs PR - [Link](https://nixpk.gs/pr-tracker.html) * Track a Nixpkgs PR - [Link](https://nixpk.gs/pr-tracker.html)
* Awesome-Hyprland - [Link](https://github.com/hyprland-community/awesome-hyprland) * Awesome-Hyprland - [Link](https://github.com/hyprland-community/awesome-hyprland)
### Examples ### 🌐 Examples
* Tons of good examples here - [Link](https://github.com/Mic92/dotfiles/blob/main/nixos/modules/) * 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/) * NixOS Flakes Intro Guide - [Link](https://nixos-and-flakes.thiscute.world/)
### Theming ### 👀 Theming
* Neofetch Themes - [Link](https://github.com/Chick2D/neofetch-themes/) * Neofetch Themes - [Link](https://github.com/Chick2D/neofetch-themes/)
* Stylix - [Link](https://github.com/danth/stylix) * Stylix - [Link](https://github.com/danth/stylix)
* Hyprland Inspirations * Hyprland Inspirations
@ -99,10 +99,10 @@ Completed ToDo List [here](./docs/complete.md)
* Base16 Color Schemes - [Link](https://tinted-theming.github.io/base16-gallery/) * Base16 Color Schemes - [Link](https://tinted-theming.github.io/base16-gallery/)
--- ---
# Lanzaboote / SecureBoot # 🔒 Lanzaboote / SecureBoot
* Instructions here - [Link](https://git.sysctl.io/Mirrors/lanzaboote/src/branch/master/docs/QUICK_START.md) * Instructions here - [Link](https://git.sysctl.io/Mirrors/lanzaboote/src/branch/master/docs/QUICK_START.md)
## Generic Instructions: ## 🔒 Generic Instructions:
1. Create your keys: `sbctl create-keys` 1. Create your keys: `sbctl create-keys`
2. Verify your machine is ready for SecureBoot: `sbctl verify` - Everything except `*-bzImage.efi` are signed 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) 3. Enter Secureboot Setup mode in your EFI Settings on the motherboard (F10)
@ -111,7 +111,7 @@ Completed ToDo List [here](./docs/complete.md)
* If you wish, you can select `--tpm-eventlog`, but checksums will change later (ie, at a kernel rebuild) * 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` 5. Reboot and verify you are activated: `bootctl status`
## Framework Specific: ## 💻 Framework Specific:
1. Change boot import from `boot.nix` to `secureboot.nix` in `./nixos/hosts/<hostname>/default.nix` 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` 4. Run `rebuild-host` to switch from `boot.nix` to `secureboot.nix`
2. Reboot into EUFI and set SecureBoot settings to: 2. Reboot into EUFI and set SecureBoot settings to:
@ -123,21 +123,21 @@ Completed ToDo List [here](./docs/complete.md)
5. Run `sudo sbctl enroll-keys` 5. Run `sudo sbctl enroll-keys`
6. Reboot and verify with `bootctl status` 6. Reboot and verify with `bootctl status`
# Manual: GPG Keys # 🗝️ Manual: GPG Keys
1. Import the user private key: `gpg --import gpg/users/albert/privkey.asc` 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` 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"` 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` * This will output the identifier you add to `.sops.yaml`
* Move `HOSTNAME.asc` to `keys/hosts/` and upload to git and rename accordingly. * Move `HOSTNAME.asc` to `keys/hosts/` and upload to git and rename accordingly.
# Secrets # 🔐 Secrets
1. Run `nix-develop` in `/etc/nixos/git` to import new keys 1. Run `nix-develop` in `/etc/nixos/git` to import new keys
2. To edit a file: `sops secrets/file.yml"` 2. To edit a file: `sops secrets/file.yml"`
3. When you add a new machine, you must update the secrets files encryption. 3. When you add a new machine, you must update the secrets files encryption.
* Ensure `.sops.yaml` has the updated fingerprint and file mappings. * Ensure `.sops.yaml` has the updated fingerprint and file mappings.
* Run `sops updatekeys secrets/file.yaml` and commit the change. * Run `sops updatekeys secrets/file.yaml` and commit the change.
# Troubleshooting # ℹ️ Troubleshooting
1. To troubleshoot disko issues, this command can come in handy: 1. To troubleshoot disko issues, this command can come in handy:
``` ```
nix eval .#nixosConfigurations.`hostname`.config.disko.devices._config nix eval .#nixosConfigurations.`hostname`.config.disko.devices._config