diff --git a/README.md b/README.md new file mode 100644 index 0000000..cdb6f71 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# NixOS nuc + +## Running: + +Ensure `nix` is installed and flakes are enabled. + +To run nixOS in a virtual machine, run `nix run .`. +To build the nixOS virtual machine, run `nix build .#vm`. + +To switch to this configuration on a nixOS machine, run `nixos-rebuild switch --flake .#nuc` + +## Included services: + +- [ ] tailscale +- [ ] coredns +- [ ] caddy +- [ ] vaultwarden +- [ ] immich + - [ ] server + - [ ] ml + - [ ] redis + - [ ] db +- [ ] pds + - [ ] gatekeeper +- [ ] tranquil +- [ ] knot +- [ ] spindle +- [ ] piper +- [ ] discord donger +- [ ] wol/upsnap