dtoro/oikos
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
18589f6d8d973d3147757d598b39a2f04f1e0caf
oikos/README.md
dtoro 2ddc1eaa18 docs: correct file naming convention — foundational docs are ALL-CAPS 
The previous naming guide was incomplete. The actual convention is:

**Foundational docs:** ALL-CAPS
- Root entry-points: AGENTS.md, README.md (discovery paths)
- Agent instruction: .agents/OIKOS.md, .agents/HERMES.md (docs agents read first)
- Reference docs: GLOSSARY.md (like classic repo files: LICENSE, CHANGELOG)

**Content pages:** lowercase-with-dashes
- Containers: <id>-<name>.md (ID from inventory)
- Infrastructure: <topic>.md (system description)
- Plans/investigations: YYYY-MM-DD-slug.md (date-sorted)
- Section indices: README.md (conventional)

**Skills:** special pattern
- <name>/SKILL.md where <name> is lowercase-with-dashes
- SKILL.md filename is always uppercase — signpost for tools and humans

Uppercase is reserved for foundational/signpost docs; all paths otherwise use
lowercase with hyphens (no underscores).

Updated page-templates.md with expanded explanation, and updated AGENTS.md +
README.md to reference the corrected convention.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-06 18:19:59 +02:00

5.7 KiB
Raw Blame History

Homelab Wiki — hubris

Living documentation for the hubris Proxmox homelab. Every node, every cross-cutting system, and every meaningful incident is its own page; pages are linked so you can start anywhere and walk the graph.

Last refreshed against live state: 2026-07-06.

Quick navigation

Map

Proxmox hosts

  • hubris — PVE node, GMKtec NucBox M6 Ultra, 192.168.8.77 — primary host, runs 8 LXCs + 2 VMs
  • strong — PVE node (cluster hostname strong), 192.168.178.181 — 2nd member of Homelab cluster. Hosts 7 LXCs migrated from hubris (Phase 1+2, 2026-07-05)

VMs

LXC containers

See the full table with IPs, hosts, mounts, and status in containers/index.md. Quick summary:

  • hubris (10 active): 102 nfs-export, 103 paperless, 104 gitea, 105 apps, 114 nextcloud, 119 sophia, 120 mule-images, 121 caddy, 124 authentik (outpost), 128 trmnl, 132 rclone
  • strong (7 active): 101 jellyfin, 118 elementsynapse, 122 arriman, 129 house, 130 grimmory, 133 seanime, 134 romm
  • Destroyed (archaeology): 100 arr, 106 flaresolverr, 107 marimo, 109 syncthing, 110 photoprism, 111 karakeep, 112 immich, 115 reticulum, 123 claudio-bot, 125 seafile, 126 plato, 127 mule-photos-new — see containers/index.md

Cross-cutting infrastructure

Investigations

Time-stamped incident notes / experiments in investigations/index.md. Resolved cases move to investigations/archive/.

Operations

Conventions

  • File naming. Foundational docs (entry-points, agent instruction, references) are ALL-CAPS (AGENTS.md, OIKOS.md, GLOSSARY.md); containers use <id>-<name>.md; infrastructure pages use lowercase-with-dashes; plans and incidents use YYYY-MM-DD-slug.md; skills are <name>/SKILL.md. See page-templates.md for the full rules.
  • Each node page ends with a ## Changelog section. Reverse-chronological. Entry format: 
    ### YYYY-MM-DD — short title
one or two lines on what changed and why.
  • Cross-linking is mandatory. If a page references another node or system, link to it. Treat orphans as a bug.
  • Live state wins. When something here disagrees with pct config / docker inspect / running config, fix the wiki and note the change in the relevant changelog.
  • Tracked configs. A node whose config lives in a Gitea repo (Caddy, Gitea customizations, Artifacto, mule-image) is auto-deployed via webhook — see auto-deploy. Edits there must be pushed, not left local.
  • No secrets. This is a private repo on git.hubris.network, but still: paths to secret files are fine, secret values are not.

Maintaining this wiki

When you change a node:

  1. Update the relevant page (config snapshot, ports, mounts).
  2. Add a changelog entry at the bottom of that page.
  3. If the change touches a cross-cutting system (DNS, Caddy, Authentik, mesh), update that page too and link it from the changelog entry.
  4. If it's an incident, add an entry to investigations/.

See also

Reference in New Issue View Git Blame Copy Permalink