Reorganize repos into kitestacks-homelab + plain-English doc rewrite
- 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>
This commit is contained in:
parent
f79478158d
commit
fb822d5142
75 changed files with 11711 additions and 338 deletions
70
README.md
70
README.md
|
|
@ -1,37 +1,55 @@
|
|||
# KiteStacks Homelab
|
||||
|
||||
<!-- version: 1.3.922 -->
|
||||
Everything needed to run, fix, and understand the KiteStacks homelab lives here.
|
||||
|
||||
Private GitOps repository for the KiteStacks homelab.
|
||||
## What is KiteStacks?
|
||||
|
||||
## Cluster
|
||||
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.
|
||||
|
||||
- K3s
|
||||
- FluxCD (planned)
|
||||
- Longhorn (planned)
|
||||
## How to Read This Repo
|
||||
|
||||
## Applications
|
||||
| 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 |
|
||||
|
||||
- Homepage
|
||||
- Authentik (SSO identity provider)
|
||||
- Grafana
|
||||
- Open WebUI (Kite AI)
|
||||
- Forgejo
|
||||
- BookStack
|
||||
- OpenProject
|
||||
- Kavita
|
||||
- Raindrop.io (cloud, bookmark manager)
|
||||
- Uptime Kuma
|
||||
- LiteLLM
|
||||
- Linkding
|
||||
- Prometheus (monitoring, no SSO)
|
||||
- Portainer (admin, no SSO)
|
||||
## Services Running Right Now
|
||||
|
||||
## SSO
|
||||
| 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 |
|
||||
|
||||
All services use [Authentik](https://auth.kitestacks.com) as the identity provider.
|
||||
Setup guide: [docs/authentik-sso-setup.md](docs/authentik-sso-setup.md)
|
||||
## Quick Reference
|
||||
|
||||
## Documentation
|
||||
```bash
|
||||
# Check all running containers
|
||||
docker ps --format "table {{.Names}}\t{{.Status}}"
|
||||
|
||||
docs/KiteStacks-Homelab-Documentation-v1.3.884.md
|
||||
# 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`.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue