docs: add full homelab documentation structure
This commit is contained in:
103
docs/architecture/SERVICES_DIRECTORY.md
Normal file
103
docs/architecture/SERVICES_DIRECTORY.md
Normal file
@@ -0,0 +1,103 @@
|
||||
# Services Directory
|
||||
|
||||
All running services across the homelab with ports, URLs, and backend info.
|
||||
|
||||
## PlausibleDeniability
|
||||
|
||||
### Databases (internal only)
|
||||
| Service | Port | Backend | Notes |
|
||||
|---------|------|---------|-------|
|
||||
| shared-postgres | 5432 | — | immich-optimized, vectorchord + pgvector |
|
||||
| shared-mariadb | 3306 | — | |
|
||||
| shared-redis | 6379 | — | |
|
||||
|
||||
### Infrastructure
|
||||
| Service | Internal Port | Public URL | Notes |
|
||||
|---------|--------------|------------|-------|
|
||||
| newt | — | — | Pangolin reverse proxy agent |
|
||||
| homepage | — | — | Dashboard |
|
||||
| dockhand | — | — | Container management |
|
||||
| uptime-kuma | — | — | MariaDB backend |
|
||||
| netdata | — | — | Metrics |
|
||||
| tailscale | — | — | VPN |
|
||||
|
||||
### Media
|
||||
| Service | Internal Port | Public URL | Notes |
|
||||
|---------|--------------|------------|-------|
|
||||
| plex | — | — | GPU passthrough, RTX 2080 Ti |
|
||||
| tautulli | — | — | Plex analytics |
|
||||
| audiobookshelf | — | — | Audiobooks |
|
||||
| seerr | — | — | Postgres backend |
|
||||
| calibre-web-automated | — | — | Ebooks |
|
||||
|
||||
### Photos
|
||||
| Service | Internal Port | Public URL | Notes |
|
||||
|---------|--------------|------------|-------|
|
||||
| immich-server | — | — | Postgres + Redis, GPU |
|
||||
| immich-ml | — | — | GPU, CUDA |
|
||||
|
||||
### Home
|
||||
| Service | Internal Port | Public URL | Notes |
|
||||
|---------|--------------|------------|-------|
|
||||
| kitchenowl | — | — | Grocery/tasks |
|
||||
| donetick | — | — | Postgres backend, selfhosted.yaml required |
|
||||
| shlink | — | — | URL shortener, Postgres |
|
||||
| shlink-web-client | — | — | |
|
||||
| qui | — | — | qBittorrent UI, manages Serenity remotely |
|
||||
|
||||
### Dev
|
||||
| Service | Internal Port | Public URL | Notes |
|
||||
|---------|--------------|------------|-------|
|
||||
| gitea | — | gitea.paccoco.com | Postgres backend |
|
||||
| rackpeek | — | — | |
|
||||
|
||||
### AI
|
||||
| Service | Internal Port | Public URL | Notes |
|
||||
|---------|--------------|------------|-------|
|
||||
| ollama | 11434 | — | GPU, RTX 2080 Ti |
|
||||
| openwebui | 8282→8080 | ai.paccoco.com (pending) | Postgres backend |
|
||||
|
||||
### Meshtastic
|
||||
| Service | Internal Port | Public URL | Notes |
|
||||
|---------|--------------|------------|-------|
|
||||
| meshmonitor | 8081→3001 | meshmonitor.paccoco.com | Postgres backend |
|
||||
| meshmonitor virtual node | 4404 | — | TCP virtual node server |
|
||||
| meshmonitor-tileserver | 8082→8080 | — | Map tiles |
|
||||
| meshmonitor-mqtt-proxy | — | — | MQTT→TCP bridge |
|
||||
|
||||
---
|
||||
|
||||
## Serenity
|
||||
|
||||
### Media Ingestion
|
||||
| Service | Notes |
|
||||
|---------|-------|
|
||||
| sonarr | TV |
|
||||
| sonarr-anime | Anime |
|
||||
| radarr | Movies |
|
||||
| lidarr | Music |
|
||||
| readarr | Books |
|
||||
| readarr-epub | EPUBs |
|
||||
| prowlarr | Indexer manager |
|
||||
| bazarr | Subtitles |
|
||||
| unpackerr | Archive extraction |
|
||||
| qBittorrent | Download client |
|
||||
| GluetunVPN | VPN tunnel for qbit |
|
||||
| autobrr | Auto-grab |
|
||||
| qbit_manage | qBit maintenance |
|
||||
| Notifiarr | Notifications |
|
||||
| Wizarr | User invites |
|
||||
| romm | ROM manager |
|
||||
| GameVault | Game library |
|
||||
| shelfmark | Book/audiobook search, port 8084 |
|
||||
|
||||
---
|
||||
|
||||
## N.O.M.A.D.
|
||||
|
||||
| Service | Port | Notes |
|
||||
|---------|------|-------|
|
||||
| Pelican Panel | 80/443 | panel.paccoco.com, PHP 8.4 + nginx + MariaDB |
|
||||
| Wings | 8443 | node1.paccoco.com, game server daemon |
|
||||
| Minecraft | 25565 | Purpur, Java 21, direct port forward |
|
||||
| N.O.M.A.D. containers | — | 10 containers, start_nomad.sh / stop_nomad.sh |
|
||||
Reference in New Issue
Block a user