Documentation Hub
Welcome to the documentation repository for the self-hosted, lean homelab.
Architecture & System Design
- System Architecture: Hardware specifications, Tailscale mesh networking, storage topology, and measured zero-idle resource metrics.
- Discord Mobile Intake Specification: MeTube-style interactive widget (Pattern A), sequence diagrams, and channel auto-routing logic.
- KOReader E-Reader OPDS Sync Guide: Step-by-step KOReader setup, OPDS 1.2 catalog navigation, e-ink Tailscale access, and Calibre-Web integration.
Operational References & Guides
- iPod Classic & Rockbox Music Sync Guide: Delta rsync over USB, Subsonic playlist management, and battery optimization.
- Network IPAM & Tailscale Mesh Guide: Port allocation matrix, internal Docker network isolation, MagicDNS hostnames, and subnet router setup.
- Mobile Bot & Intake Cheat Sheet: Discord intake channels, stealth emoji reactions, slash commands, and Telegram AES-256 CLI crypto.
- Root README: Quickstart guide, port mapping table, and Makefile commands.
- Production Deployment & Operations Guide: Host prerequisites, permissions, day-2 updates (
make update), remote deploys (make deploy), and HDD expansion. - Agent Context & Invariants: Primer for AI assistants and contributors regarding key architectural invariants.
- Roadmap & TODO: Status of all project phases.
- Engineering Checkpoint: Detailed technical log of verified tests, resolved bugs, and benchmark stats.
🌐 Service Endpoints & Client URLs Reference
| Service | Port | Local Web UI | Tailscale / Remote Web UI | Client / App Endpoint | Dedicated Apps |
|---|---|---|---|---|---|
| Documentation Runbook | 8000 |
http://localhost:8000 | http://<tailscale-ip>:8000 |
http://<host>:8000 |
Material for MkDocs (Mobile Browser / PWA) |
| Audiobookshelf | 13378 |
http://localhost:13378 | http://<tailscale-ip>:13378 |
http://<host>:13378 |
Audiobookshelf (iOS / Android) |
| Calibre-Web | 8083 |
http://localhost:8083 | http://<tailscale-ip>:8083 |
http://<host>:8083/opds |
KOReader, Kobo Sync |
| Navidrome | 4533 |
http://localhost:4533 | http://<tailscale-ip>:4533 |
http://<host>:4533/rest |
Symfonium, Feishin, Amplefin |
| Immich | 2283 |
http://localhost:2283 | http://<tailscale-ip>:2283 |
http://<host>:2283/api |
Immich (iOS / Android) |