GIT - ooknet

┌────────────────────────────────────────────────────────────────────────────┐
│  ██████╗  ██████╗ ██╗  ██╗███╗   ██╗███████╗████████╗                              │
│ ██╔═══██╗██╔═══██╗██║ ██╔╝████╗  ██║██╔════╝╚══██╔══╝                              │
│ ██║   ██║██║   ██║█████╔╝ ██╔██╗ ██║█████╗     ██║                                 │
│ ██║   ██║██║   ██║██╔═██╗ ██║╚██╗██║██╔══╝     ██║                                 │
│ ╚██████╔╝╚██████╔╝██║  ██╗██║ ╚████║███████╗   ██║                                 │
│  ╚═════╝  ╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═══╝╚══════╝   ╚═╝ .org                            │
└────────────────────────────────────────────────────────────────────────────────────┘

┌──────────────────────────────────────┐
│  ██████╗  ██████╗ ██╗  ██╗███╗   ██╗███████╗ │
│ ████████╗                                    │
│ ██╔═══██╗██╔═══██╗██║ ██╔╝████╗  ██║██╔════╝ │
│ ╚══██╔══╝                                    │
│ ██║   ██║██║   ██║█████╔╝ ██╔██╗ ██║█████╗   │
│    ██║                                       │
│ ██║   ██║██║   ██║██╔═██╗ ██║╚██╗██║██╔══╝   │
│    ██║                                       │
│ ╚██████╔╝╚██████╔╝██║  ██╗██║ ╚████║███████╗ │
│    ██║                                       │
│  ╚═════╝  ╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═══╝╚══════╝ │
│    ╚═╝ .org                                  │
└──────────────────────────────────────────────┘

Overview

The goals of this repository are:

To maintain a centralized location for all my personal computing infrastructure
To provide a place to experiment and learn about networking, administration, security, unix, design, and programming

This repository isn't intended to be used by anyone but myself. It's highly personalized and likely doesn't fit anyone else's needs. I maintain this repository publicly as a reference for anyone building something similar.

Features

NixOS configurations for all my hosts
Home-Manager configuration for my workstations
Custom packages
Development environments
Declarative secrets with agenix
Personal website
Templates for bootstrapping projects

Fleet

Below are all the hosts I currently maintain within this flake:

┌─────────────┬───────────────┬─────────────┬───────────────┬───────────────┬────────┐
│ host        │ spec          │ role        │ description   │ architecture  │ status │
├─────────────┼───────────────┼─────────────┼───────────────┼───────────────┼────────┤
│ ooksdesk    │ 7500F /       │ Workstation │ Primary       │ x86_64        │ UP     │
│             │ RX5700XT / 32 │             │ desktop       │               │        │
│             │ GB DDR5       │             │ workstation   │               │        │
├╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌┤
│ ookst480s   │ T480s /       │ Workstation │ Secondary     │ x86_64        │ UP     │
│             │ i5-8350U / 24 │             │ mobile        │               │        │
│             │ GB DDR4       │             │ workstation   │               │        │
├╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌┤
│ ooksmicro   │ GPD Micro PC  │ Workstation │ Pocket        │ x86_64        │ UP     │
│             │ / N8100 / 8   │             │ workstation   │               │        │
│             │ GB LPDR3      │             │               │               │        │
├╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌┤
│ ooksmedia   │ i3-10100 /    │ Server      │ Homelab/Media │ x86_64        │ UP     │
│             │ 1650 Super /  │             │ server        │               │        │
│             │ 64 GB DDR4    │             │               │               │        │
├╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌┤
│ ooksx1      │ X1 Carbon G4  │ Workstation │ Guest laptop  │ x86_64        │ UP     │
│             │ / i5 6200U /  │             │               │               │        │
│             │ 8 GB LPDDR3   │             │               │               │        │
├╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌┤
│ ooknode     │ Linode Nanode │ Server      │ VPS for       │ x86_64        │ UP     │
│             │               │             │ website       │               │        │
├╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌┤
│ ookstest    │ QEMU VM       │ Server      │ Disposable    │ x86_64        │ N/A    │
│             │               │             │ test/sandbox  │               │        │
│             │               │             │ server        │               │        │
├╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌┤
│ ooksphone   │ Termux        │ Workstation │ Nix           │ aarch64       │ DOWN   │
│             │               │             │ environment   │               │        │
│             │               │             │ for android   │               │        │
│             │               │             │ phone         │               │        │
├╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌┤
│ ooksair     │ M4 MBA        │ Workstation │ Primary       │ aarch64-darwi │ UP     │
│             │               │             │ mobile        │               │        │
│             │               │             │ workstation   │               │        │
├╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌┤
│ ooksinstall │ Live ISO      │ Installer   │ Bootable      │ x86_64        │ N/A    │
│             │               │             │ installer     │               │        │
│             │               │             │ image         │               │        │
└─────────────┴───────────────┴─────────────┴───────────────┴───────────────┴────────┘

┌──────────────────────────────────────────────┐
│ host          ooksdesk                       │
│ spec          7500F / RX5700XT / 32 GB DDR5  │
│ role          Workstation                    │
│ description   Primary desktop workstation    │
│ architecture  x86_64                         │
│ status        UP                             │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ host          ookst480s                      │
│ spec          T480s / i5-8350U / 24 GB DDR4  │
│ role          Workstation                    │
│ description   Secondary mobile workstation   │
│ architecture  x86_64                         │
│ status        UP                             │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ host          ooksmicro                      │
│ spec          GPD Micro PC / N8100 / 8 GB    │
│               LPDR3                          │
│ role          Workstation                    │
│ description   Pocket workstation             │
│ architecture  x86_64                         │
│ status        UP                             │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ host          ooksmedia                      │
│ spec          i3-10100 / 1650 Super / 64 GB  │
│               DDR4                           │
│ role          Server                         │
│ description   Homelab/Media server           │
│ architecture  x86_64                         │
│ status        UP                             │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ host          ooksx1                         │
│ spec          X1 Carbon G4 / i5 6200U / 8 GB │
│               LPDDR3                         │
│ role          Workstation                    │
│ description   Guest laptop                   │
│ architecture  x86_64                         │
│ status        UP                             │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ host          ooknode                        │
│ spec          Linode Nanode                  │
│ role          Server                         │
│ description   VPS for website                │
│ architecture  x86_64                         │
│ status        UP                             │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ host          ookstest                       │
│ spec          QEMU VM                        │
│ role          Server                         │
│ description   Disposable test/sandbox server │
│ architecture  x86_64                         │
│ status        N/A                            │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ host          ooksphone                      │
│ spec          Termux                         │
│ role          Workstation                    │
│ description   Nix environment for android    │
│               phone                          │
│ architecture  aarch64                        │
│ status        DOWN                           │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ host          ooksair                        │
│ spec          M4 MBA                         │
│ role          Workstation                    │
│ description   Primary mobile workstation     │
│ architecture  aarch64-darwin                 │
│ status        UP                             │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ host          ooksinstall                    │
│ spec          Live ISO                       │
│ role          Installer                      │
│ description   Bootable installer image       │
│ architecture  x86_64                         │
│ status        N/A                            │
└──────────────────────────────────────────────┘

host	spec	role	description	architecture	status
ooksdesk	7500F / RX5700XT / 32 GB DDR5	Workstation	Primary desktop workstation	x86_64	UP
ookst480s	T480s / i5-8350U / 24 GB DDR4	Workstation	Secondary mobile workstation	x86_64	UP
ooksmicro	GPD Micro PC / N8100 / 8 GB LPDR3	Workstation	Pocket workstation	x86_64	UP
ooksmedia	i3-10100 / 1650 Super / 64 GB DDR4	Server	Homelab/Media server	x86_64	UP
ooksx1	X1 Carbon G4 / i5 6200U / 8 GB LPDDR3	Workstation	Guest laptop	x86_64	UP
ooknode	Linode Nanode	Server	VPS for website	x86_64	UP
ookstest	QEMU VM	Server	Disposable test/sandbox server	x86_64	N/A
ooksphone	Termux	Workstation	Nix environment for android phone	aarch64	DOWN
ooksair	M4 MBA	Workstation	Primary mobile workstation	aarch64-darwin	UP
ooksinstall	Live ISO	Installer	Bootable installer image	x86_64	N/A

Architecture

As this project serves as a learning environment, its architecture changes frequently. While I'll try to keep this documentation current, what follows is a high-level overview of the current design.

The current architecture enables straightforward bootstrapping of new hosts while maintaining fine-grained configuration on a per-host basis. This is accomplished using a roles and profiles pattern (similar to Puppet's roles and profiles method).

Roles

Workstation: Desktop/laptop systems with a GUI environment
Server: Headless systems running specific services
Installer: Bootable ISO images for provisioning new hosts

Hosts are declared as plain data under flake.ooknet.{workstations,servers,images}. The builders in outputs/builder/ map that data with mapAttrs into nixosConfigurations / darwinConfigurations, wiring up the right platform modules (lib.nixosSystem for linux, nix-darwin's darwinSystem for macos) and importing the matching host module from hosts/<hostname>. The host attribute name is the hostname, so a declaration only carries what makes the host unique while the builder absorbs the boilerplate.

Workstations:

┌─ NIX ──────────────────────────────────────────────────────────────────────┐
│ flake.ooknet.workstations = {                                                      │
│   ookst480s = {                                                                    │
│     system = "x86_64-linux";                                                       │
│     type = "laptop";                                                               │
│   };                                                                               │
│   ooksair = {                                                                      │
│     system = "aarch64-darwin";                                                     │
│     type = "laptop";                                                               │
│   };                                                                               │
│ };                                                                                 │
└────────────────────────────────────────────────────────────────────────────────────┘

┌─ NIX ────────────────────────────────┐
│ flake.ooknet.workstations = {                │
│   ookst480s = {                              │
│     system = "x86_64-linux";                 │
│     type = "laptop";                         │
│   };                                         │
│   ooksair = {                                │
│     system = "aarch64-darwin";               │
│     type = "laptop";                         │
│   };                                         │
│ };                                           │
└──────────────────────────────────────────────┘

Servers:

┌─ NIX ──────────────────────────────────────────────────────────────────────┐
│ flake.ooknet.servers = {                                                           │
│   ooknode = {                                                                      │
│     system = "x86_64-linux";                                                       │
│     type = "vm";                                                                   │
│     profile = "linode";                                                            │
│     domain = "ooknet.org";                                                         │
│     services = ["website" "forgejo"];                                              │
│   };                                                                               │
│ };                                                                                 │
└────────────────────────────────────────────────────────────────────────────────────┘

┌─ NIX ────────────────────────────────┐
│ flake.ooknet.servers = {                     │
│   ooknode = {                                │
│     system = "x86_64-linux";                 │
│     type = "vm";                             │
│     profile = "linode";                      │
│     domain = "ooknet.org";                   │
│     services = ["website" "forgejo"];        │
│   };                                         │
│ };                                           │
└──────────────────────────────────────────────┘

Installer images:

┌─ NIX ──────────────────────────────────────────────────────────────────────┐
│ flake.ooknet.images = {                                                            │
│   ooksinstall = {                                                                  │
│     system = "x86_64-linux";                                                       │
│     type = "iso";                                                                  │
│     role = "installer";                                                            │
│   };                                                                               │
│ };                                                                                 │
└────────────────────────────────────────────────────────────────────────────────────┘

┌─ NIX ────────────────────────────────┐
│ flake.ooknet.images = {                      │
│   ooksinstall = {                            │
│     system = "x86_64-linux";                 │
│     type = "iso";                            │
│     role = "installer";                      │
│   };                                         │
│ };                                           │
└──────────────────────────────────────────────┘

Profiles

Profiles are collections of related software and configuration that can be enabled on a per-host basis. Some example workstation profiles:

gaming: Steam & emulators
communication: Discord, Teams, Matrix
productivity: Document editing, note-taking
creative: Art and design tools
media: Audio/video playback and management
virtualization: Virtual machine support
infra: Infrastructure and ops tooling
work: Work specific tooling

Example:

┌─ NIX ──────────────────────────────────────────────────────────────────────┐
│ ooknet.workstation.profiles = ["gaming" "creative" "media"];                       │
└────────────────────────────────────────────────────────────────────────────────────┘

┌─ NIX ────────────────────────────────┐
│ ooknet.workstation.profiles = ["gaming" "cre │
│ ative" "media"];                             │
└──────────────────────────────────────────────┘

Servers pick a base profile (for VMs, e.g. linode) and a list of services to run. Some example services:

website: My static website
forgejo: Git server
ookflix: Media server services
monitoring: Metrics and dashboards
authentik: Identity provider

┌─ NIX ──────────────────────────────────────────────────────────────────────┐
│ ooknet.server.services = ["ookflix" "monitoring"];                                 │
└────────────────────────────────────────────────────────────────────────────────────┘

┌─ NIX ────────────────────────────────┐
│ ooknet.server.services = ["ookflix" "monitor │
│ ing"];                                       │
└──────────────────────────────────────────────┘

Desktop environment

Compositor: Hyprland
Utilities:
- Idle: hypridle
- Screen locker: hyprlock
- Wallpaper: hyprpaper
- Bar: Waybar
- Notifications: Mako
Color Palette: Gruvbox extended

Appreciation

I want to give some appreciation to the many people/resources who have helped in some way to build this project.

Overview

Features

Fleet

Architecture

Roles

Profiles

Desktop environment

Appreciation

People

Resources