docs: add root homelab runbook and debug documentation

This commit is contained in:
KiteStacks AutoSync 2026-06-09 03:32:33 -05:00
parent 55594d4c87
commit 1b2461425f
2 changed files with 63 additions and 0 deletions

26
DEBUG-DOCUMENTATION.md Normal file
View file

@ -0,0 +1,26 @@
# KiteStacks Homelab Debug Documentation
## 2026-06-09 — Root CHANGELOG Permission Issue
Problem: CHANGELOG.md could not be read by the normal user.
Cause: CHANGELOG.md was owned by root and had 600 permissions.
Fix:
sudo chown kenpat:kenpat CHANGELOG.md
chmod 644 CHANGELOG.md
## 2026-06-09 — Repo Folder Ownership Issue
Problem: The repo root folder was owned by root, which prevented creating RUNBOOK.md.
Fix:
sudo chown -R kenpat:kenpat /opt/kitestacks-autosync/kitestacks-homelab
## 2026-06-09 — Autosync Changelog Pollution
Problem: CHANGELOG.md contains noisy autosync entries from live app/database files.
Examples: apps/authentik/postgres, apps/forgejo/data, apps/grafana/data, journal files, pg_wal files.
Next step: Review autosync excludes so database/session/cache/journal files are not committed or added to changelogs.

37
RUNBOOK.md Normal file
View file

@ -0,0 +1,37 @@
# KiteStacks Homelab Runbook
## Purpose
This repository documents the KiteStacks homelab.
## Documentation Standard
Each major repo or project should have RUNBOOK.md, CHANGELOG.md, and DEBUG-DOCUMENTATION.md.
## Main Host
Primary host: Assassin
Main repo: /opt/kitestacks-autosync/kitestacks-homelab
## Public URLs
- https://www.kitestacks.com
- https://gitforge.kitestacks.com
- https://auth.kitestacks.com
## Discord Integration
Project docs live in projects/Discord Integration/.
Recent activity channel: #recent-activity
Webhook env file: /etc/kitestacks/discord-webhook.env
Activity script: /usr/local/bin/kitestacks-discord-activity.sh
Do not commit webhook URLs, tokens, secrets, database files, sessions, or live container data.
## Known Issue
The root CHANGELOG.md was generated by autosync and includes live app/database file changes.