kenpat
fb822d5142
- Rewrote RUNBOOK.md and DEBUG-DOCUMENTATION.md in simple 5th-grade language with real-world analogies for every technical concept - Updated README.md with current service inventory and folder map - Added cloud-migration/ subdirectory (from kitestacks-cloud-migration repo) - Added autosync/ subdirectory (from kitestacks-homelab-autosync-test repo) - Added osticket/ subdirectory (from OSTicketSystem repo) - Added cloud/ placeholder for future cloud configs - Excluded binary DB/postgres files from autosync subdirectory Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
55 lines
2.2 KiB
Markdown
55 lines
2.2 KiB
Markdown
# KiteStacks Homelab
|
|
|
|
Everything needed to run, fix, and understand the KiteStacks homelab lives here.
|
|
|
|
## What is KiteStacks?
|
|
|
|
KiteStacks is a personal homelab — a set of useful web apps that run on two computers
|
|
(monk at home, kscloud1 in Germany). All the websites are accessible over the internet
|
|
through Cloudflare without exposing any home IP addresses.
|
|
|
|
## How to Read This Repo
|
|
|
|
| File / Folder | What it is |
|
|
|--------------|------------|
|
|
| `RUNBOOK.md` | **Start here.** Plain-English guide to how everything works and how to do common tasks |
|
|
| `DEBUG-DOCUMENTATION.md` | Every problem we've hit and how we solved it |
|
|
| `docs/` | Detailed setup guides for specific services (Authentik SSO, etc.) |
|
|
| `apps/` | Docker Compose files for each service |
|
|
| `clusters/` | Infrastructure-level configs |
|
|
| `projects/` | Active project notes |
|
|
| `cloud/` | Cloud-specific configurations (kscloud1) |
|
|
| `cloud-migration/` | Archive of cloud migration work and volume backups |
|
|
| `autosync/` | Auto-sync scripts that keep the repo up to date automatically |
|
|
| `osticket/` | OSTicket help-desk project notes |
|
|
|
|
## Services Running Right Now
|
|
|
|
| Service | Website | What it does |
|
|
|---------|---------|--------------|
|
|
| Authentik | auth.kitestacks.com | Single login for all services |
|
|
| Portainer | portainer.kitestacks.com | Manage all Docker containers |
|
|
| Forgejo | gitforge.kitestacks.com | Git server (code + scripts) |
|
|
| BookStack | wiki.kitestacks.com | Wiki and notes |
|
|
| Grafana | grafana.kitestacks.com | Server health charts |
|
|
| Karakeep | links.kitestacks.com | Bookmark manager |
|
|
| Kavita | kavita.kitestacks.com | Ebook reader |
|
|
| OSTicket | tasks.kitestacks.com | Help desk / ticket system |
|
|
| Open WebUI | ai.kitestacks.com | AI chat (GPT, Claude, local) |
|
|
| Uptime Kuma | status.kitestacks.com | Service monitor |
|
|
| Portal | www.kitestacks.com | Homepage |
|
|
|
|
## Quick Reference
|
|
|
|
```bash
|
|
# Check all running containers
|
|
docker ps --format "table {{.Names}}\t{{.Status}}"
|
|
|
|
# Restart a service
|
|
cd ~/kitestacks-live/docker/SERVICE_NAME && docker compose restart
|
|
|
|
# View live logs
|
|
docker logs CONTAINER_NAME --tail 50 -f
|
|
```
|
|
|
|
All usernames and passwords go through Authentik at `https://auth.kitestacks.com`.
|