Sanitized mirror from private repository - 2026-03-29 13:33:25 UTC
Some checks failed
Documentation / Build Docusaurus (push) Failing after 5m0s
Documentation / Deploy to GitHub Pages (push) Has been skipped

This commit is contained in:
Gitea Mirror Bot
2026-03-29 13:33:25 +00:00
commit 75d4f4e02b
1280 changed files with 331190 additions and 0 deletions

View File

@@ -0,0 +1,403 @@
# 📚 Complete Service Documentation Index
This comprehensive index contains detailed documentation for all **159 services** running across the homelab infrastructure. Each service includes setup instructions, configuration details, troubleshooting guides, and security considerations.
> **🌐 External Access Services**
> Services marked with **🌐** are accessible externally via domain names with port forwarding or Cloudflare proxy.
## 🔍 Quick Service Finder
### 🌟 Most Popular Services
- **🎬 Media**: Plex Media Server, Jellyfin, Immich Photos
- **🔧 Management**: Portainer 🌐, Grafana, Uptime Kuma
- **💬 Communication**: Jitsi Meet 🌐, Matrix, Element
- **🔒 Security**: Vaultwarden, Pi-hole, WireGuard
- **📝 Development**: Gitea 🌐, Nginx Proxy Manager
### 🌐 External Access Services
- **🎥 Jitsi Meet**: `https://meet.thevish.io:4443` - Video conferencing
- **📝 Gitea**: `https://git.vish.gg` (SSH: port 2222) - Git repository
- **🐳 Portainer**: `https://pw.vish.gg:9443` - Container management
- **🌍 Web Services**: `https://vish.gg` - Main website and proxied services
## 📊 Services by Category
### 🤖 AI & Machine Learning (8 services)
| Service | Host | Difficulty | Description |
|---------|------|------------|-------------|
| **Ollama** | Guava | 🟢 | Local language model server |
| **OpenWebUI** | Guava | 🟡 | Web interface for AI models |
| **Whisper** | Atlantis | 🟡 | Speech-to-text processing |
| **Stable Diffusion** | Shinku-Ryuu | 🔴 | AI image generation |
| **Text Generation WebUI** | Guava | 🟡 | Language model interface |
| **Automatic1111** | Shinku-Ryuu | 🔴 | Stable Diffusion WebUI |
| **ComfyUI** | Shinku-Ryuu | 🔴 | Node-based AI workflow |
| **InvokeAI** | Shinku-Ryuu | 🔴 | Professional AI art generation |
### 💬 Communication & Collaboration (18 services)
| Service | Host | Difficulty | External Access | Description |
|---------|------|------------|-----------------|-------------|
| **Jitsi Meet** | Atlantis | 🟡 | 🌐 meet.thevish.io | Complete video conferencing platform |
| **Jicofo** | Atlantis | 🟡 | - | Jitsi conference focus component |
| **JVB** | Atlantis | 🟡 | - | Jitsi video bridge component |
| **Prosody** | Atlantis | 🟡 | - | XMPP server for Jitsi |
| **Matrix Synapse** | Atlantis | 🔴 | 🌐 matrix.thevish.io | Matrix homeserver |
| **Element Web** | Anubis | 🟢 | - | Matrix web client |
| **Mastodon** | Atlantis | 🔴 | - | Decentralized social network |
| **Mastodon DB** | Atlantis | 🔴 | - | PostgreSQL for Mastodon |
| **Mastodon Redis** | Atlantis | 🔴 | - | Redis cache for Mastodon |
| **Mattermost** | Homelab_VM | 🟡 | - | Team collaboration platform |
| **Mattermost DB** | Homelab_VM | 🟡 | - | PostgreSQL for Mattermost |
| **Signal CLI REST API** | Homelab_VM | 🟢 | - | Signal messaging API |
| **Discord Bot** | Guava | 🟡 | - | Custom Discord automation |
| **Telegram Bot** | Guava | 🟡 | - | Telegram notification bot |
| **Ntfy** | Guava | 🟢 | - | Push notification service |
| **Gotify** | Guava | 🟢 | - | Self-hosted push notifications |
| **Roundcube** | Calypso | 🟡 | - | Webmail client |
| **ProtonMail Bridge** | Calypso | 🟡 | - | ProtonMail IMAP/SMTP bridge |
### 🔧 Development & DevOps (38 services)
| Service | Host | Difficulty | External Access | Description |
|---------|------|------------|-----------------|-------------|
| **Gitea** | Calypso | 🟡 | 🌐 git.vish.gg | Self-hosted Git service with SSH access |
| **Portainer** | Atlantis | 🟡 | 🌐 pw.vish.gg:9443 | Docker container management |
| **Dozzle** | Multiple | 🟢 | - | Docker log viewer |
| **Watchtower** | Multiple | 🟢 | - | Automatic container updates |
| **Nginx Proxy Manager** | Calypso | 🟡 | - | Reverse proxy with SSL |
| **Nginx** | Multiple | 🟡 | 🌐 vish.gg | Web server and reverse proxy |
| **Traefik** | Guava | 🔴 | - | Modern reverse proxy |
| **Docker Registry** | Atlantis | 🟡 | - | Private container registry |
| **Harbor** | Shinku-Ryuu | 🔴 | - | Enterprise container registry |
| **Jenkins** | Guava | 🔴 | - | CI/CD automation server |
| **GitLab Runner** | Multiple | 🟡 | - | CI/CD job execution |
| **Drone CI** | Guava | 🟡 | - | Container-native CI/CD |
| **Woodpecker CI** | Guava | 🟡 | - | Lightweight CI/CD |
| **Act Runner** | Multiple | 🟡 | - | GitHub Actions runner |
| **Code Server** | Multiple | 🟡 | - | VS Code in browser |
| **Jupyter** | Guava | 🟡 | - | Interactive computing |
| **API Services** | Multiple | 🟡 | - | Custom API endpoints |
| **Database Services** | Multiple | 🟡 | - | Various database systems |
| **Redis** | Multiple | 🟡 | - | In-memory data store |
| **PostgreSQL** | Multiple | 🟡 | - | Relational database |
| **MongoDB** | Multiple | 🟡 | - | Document database |
| **Elasticsearch** | Guava | 🔴 | - | Search and analytics |
| **Kibana** | Guava | 🔴 | - | Elasticsearch visualization |
| **Logstash** | Guava | 🔴 | - | Log processing pipeline |
| **MinIO** | Atlantis | 🟡 | - | S3-compatible object storage |
| **HashiCorp Vault** | Guava | 🔴 | - | Secrets management |
| **HashiCorp Consul** | Guava | 🔴 | - | Service discovery |
| **HashiCorp Nomad** | Guava | 🔴 | - | Workload orchestration |
| **Terraform** | Guava | 🔴 | - | Infrastructure as code |
| **Ansible** | Guava | 🟡 | - | Configuration management |
| **AWX** | Guava | 🔴 | - | Ansible web interface |
| **Semaphore** | Guava | 🟡 | - | Ansible web UI |
| **Rundeck** | Guava | 🔴 | - | Job scheduler and runbook automation |
| **n8n** | Guava | 🟡 | - | Workflow automation |
| **Huginn** | Guava | 🟡 | - | Agent-based automation |
| **Zapier Alternative** | Guava | 🟡 | - | Workflow automation |
| **Webhook Services** | Multiple | 🟢 | - | HTTP webhook handlers |
| **Cron Services** | Multiple | 🟢 | - | Scheduled task execution |
### 🎬 Media & Entertainment (45 services)
| Service | Host | Difficulty | External Access | Description |
|---------|------|------------|-----------------|-------------|
| **Plex Media Server** | Calypso | 🟡 | - | Premium media streaming |
| **Jellyfin** | Chicago_VM | 🟡 | - | Open-source media server |
| **Emby** | Shinku-Ryuu | 🟡 | - | Media server alternative |
| **Kodi** | Multiple | 🟢 | - | Media center software |
| **Immich Server** | Raspberry-Pi-5 | 🟡 | - | Photo management server |
| **Immich Database** | Calypso | 🟡 | - | PostgreSQL for Immich |
| **Immich Redis** | Calypso | 🟡 | - | Redis cache for Immich |
| **Immich ML** | Calypso | 🟡 | - | AI features for Immich |
| **PhotoPrism** | Anubis | 🟡 | - | AI-powered photo management |
| **Navidrome** | Bulgaria_VM | 🟢 | - | Music streaming server |
| **Airsonic** | Guava | 🟢 | - | Music streaming alternative |
| **Funkwhale** | Guava | 🟡 | - | Social music platform |
| **Sonarr** | Calypso | 🟢 | - | TV show management |
| **Radarr** | Calypso | 🟢 | - | Movie management |
| **Lidarr** | Calypso | 🟢 | - | Music management |
| **Readarr** | Calypso | 🟢 | - | Book management |
| **Whisparr** | Calypso | 🟢 | - | Adult content management |
| **Bazarr** | Calypso | 🟢 | - | Subtitle management |
| **Prowlarr** | Calypso | 🟢 | - | Indexer management |
| **Jackett** | Atlantis | 🟢 | - | Torrent indexer proxy |
| **FlareSolverr** | Calypso | 🟢 | - | Cloudflare bypass |
| **Tautulli** | Calypso | 🟢 | - | Plex monitoring |
| **Overseerr** | Calypso | 🟡 | - | Media request management |
| **Jellyseerr** | Calypso | 🟡 | - | Jellyfin request management |
| **Ombi** | Calypso | 🟡 | - | Media request platform |
| **Requestrr** | Calypso | 🟡 | - | Discord media requests |
| **SABnzbd** | Calypso | 🟢 | - | Usenet downloader |
| **NZBGet** | Calypso | 🟢 | - | Usenet downloader alternative |
| **Deluge** | Calypso | 🟢 | - | BitTorrent client |
| **qBittorrent** | Calypso | 🟢 | - | BitTorrent client |
| **Transmission** | Calypso | 🟢 | - | BitTorrent client |
| **rTorrent** | Calypso | 🟡 | - | Command-line BitTorrent |
| **MeTube** | Atlantis | 🟢 | - | YouTube downloader |
| **YouTube-DL** | Multiple | 🟢 | - | Video downloader |
| **yt-dlp** | Multiple | 🟢 | - | Enhanced YouTube downloader |
| **Podgrab** | Atlantis | 🟢 | - | Podcast downloader |
| **AudioBookshelf** | Atlantis | 🟡 | - | Audiobook and podcast server |
| **Calibre-Web** | Atlantis | 🟢 | - | Ebook library management |
| **Komga** | Atlantis | 🟡 | - | Comic and manga server |
| **Kavita** | Atlantis | 🟡 | - | Digital library |
| **Ubooquity** | Atlantis | 🟡 | - | Comic and ebook server |
| **LazyLibrarian** | Calypso | 🟡 | - | Book management |
| **Mylar** | Calypso | 🟡 | - | Comic book management |
| **GameVault** | Shinku-Ryuu | 🟡 | - | Game library management |
| **ROMM** | Shinku-Ryuu | 🟡 | - | ROM management |
### 🎮 Gaming & Entertainment (12 services)
| Service | Host | Difficulty | Description |
|---------|------|------------|-------------|
| **Satisfactory Server** | Homelab_VM | 🟢 | Factory building game server |
| **Minecraft Server** | Shinku-Ryuu | 🟢 | Minecraft game server |
| **Valheim Server** | Shinku-Ryuu | 🟡 | Valheim game server |
| **Terraria Server** | Shinku-Ryuu | 🟢 | Terraria game server |
| **Factorio Server** | Shinku-Ryuu | 🟡 | Factorio game server |
| **Left 4 Dead 2 Server** | Shinku-Ryuu | 🟡 | L4D2 dedicated server |
| **PMC Bind Server** | Shinku-Ryuu | 🟡 | Game server management |
| **SteamCMD** | Shinku-Ryuu | 🟡 | Steam server management |
| **Game Server Manager** | Shinku-Ryuu | 🟡 | Multi-game server management |
| **Pterodactyl** | Shinku-Ryuu | 🔴 | Game server control panel |
| **Crafty Controller** | Shinku-Ryuu | 🟡 | Minecraft server management |
| **AMP** | Shinku-Ryuu | 🔴 | Application Management Panel |
### 🏠 Home Automation & IoT (15 services)
| Service | Host | Difficulty | Description |
|---------|------|------------|-------------|
| **Home Assistant** | Concord-NUC | 🟡 | Smart home automation |
| **Matter Server** | Concord-NUC | 🟡 | Matter/Thread support |
| **Zigbee2MQTT** | Concord-NUC | 🟡 | Zigbee device integration |
| **Z-Wave JS** | Concord-NUC | 🟡 | Z-Wave device integration |
| **Mosquitto MQTT** | Concord-NUC | 🟡 | MQTT message broker |
| **Node-RED** | Concord-NUC | 🟡 | Visual automation flows |
| **ESPHome** | Concord-NUC | 🟡 | ESP device management |
| **Tasmota Admin** | Concord-NUC | 🟢 | Tasmota device management |
| **Frigate** | Guava | 🔴 | AI-powered security cameras |
| **Scrypted** | Guava | 🔴 | Camera and NVR platform |
| **ZoneMinder** | Guava | 🔴 | Security camera system |
| **Motion** | Guava | 🟡 | Motion detection |
| **RTSP Simple Server** | Guava | 🟡 | RTSP streaming server |
| **UniFi Controller** | Guava | 🟡 | Ubiquiti device management |
| **Pi.Alert** | Guava | 🟢 | Network device monitoring |
### 📊 Monitoring & Analytics (28 services)
| Service | Host | Difficulty | Description |
|---------|------|------------|-------------|
| **Grafana** | Guava | 🟡 | Metrics visualization |
| **Prometheus** | Guava | 🟡 | Metrics collection |
| **Node Exporter** | Multiple | 🟢 | System metrics |
| **cAdvisor** | Multiple | 🟢 | Container metrics |
| **Blackbox Exporter** | Guava | 🟡 | Endpoint monitoring |
| **SNMP Exporter** | Guava | 🟡 | Network device metrics |
| **Speedtest Exporter** | Guava | 🟢 | Internet speed monitoring |
| **Uptime Kuma** | Guava | 🟢 | Service uptime monitoring |
| **Statping** | Guava | 🟢 | Status page |
| **Healthchecks.io** | Guava | 🟢 | Cron job monitoring |
| **Cronitor** | Guava | 🟢 | Scheduled task monitoring |
| **Netdata** | Multiple | 🟢 | Real-time system monitoring |
| **Glances** | Multiple | 🟢 | System monitoring |
| **htop** | Multiple | 🟢 | Process monitoring |
| **ctop** | Multiple | 🟢 | Container monitoring |
| **Portainer Agent** | Multiple | 🟢 | Container management agent |
| **Watchtower** | Multiple | 🟢 | Container update monitoring |
| **DIUN** | Multiple | 🟢 | Docker image update notifications |
| **Ouroboros** | Multiple | 🟢 | Container update automation |
| **Shepherd** | Multiple | 🟢 | Docker service updates |
| **Loki** | Guava | 🔴 | Log aggregation |
| **Promtail** | Multiple | 🟡 | Log collection |
| **Fluentd** | Guava | 🔴 | Log processing |
| **Vector** | Guava | 🔴 | Observability data pipeline |
| **Jaeger** | Guava | 🔴 | Distributed tracing |
| **Zipkin** | Guava | 🔴 | Distributed tracing |
| **OpenTelemetry** | Guava | 🔴 | Observability framework |
| **Sentry** | Guava | 🔴 | Error tracking |
### 🌐 Network & Web Services (32 services)
| Service | Host | Difficulty | External Access | Description |
|---------|------|------------|-----------------|-------------|
| **Nginx** | Multiple | 🟡 | 🌐 vish.gg | Web server and reverse proxy |
| **Nginx Proxy Manager** | Calypso | 🟡 | - | SSL reverse proxy management |
| **Traefik** | Guava | 🔴 | - | Modern reverse proxy |
| **Caddy** | Guava | 🟡 | - | Automatic HTTPS web server |
| **HAProxy** | Guava | 🔴 | - | Load balancer |
| **Cloudflare Tunnel** | Multiple | 🟡 | - | Secure tunnel to Cloudflare |
| **DDNS Updater** | Multiple | 🟢 | - | Dynamic DNS updates |
| **Pi-hole** | Concord-NUC | 🟢 | - | Network-wide ad blocking |
| **AdGuard Home** | Guava | 🟢 | - | DNS ad blocking |
| **Unbound** | Guava | 🟡 | - | Recursive DNS resolver |
| **BIND9** | Guava | 🔴 | - | Authoritative DNS server |
| **Dnsmasq** | Multiple | 🟡 | - | Lightweight DNS/DHCP |
| **DHCP Server** | Guava | 🟡 | - | Dynamic IP assignment |
| **FTP Server** | Atlantis | 🟡 | - | File transfer protocol |
| **SFTP Server** | Multiple | 🟡 | - | Secure file transfer |
| **Samba** | Atlantis | 🟡 | - | Windows file sharing |
| **NFS Server** | Atlantis | 🟡 | - | Network file system |
| **WebDAV** | Atlantis | 🟡 | - | Web-based file access |
| **File Browser** | Multiple | 🟢 | - | Web file manager |
| **Nextcloud** | Atlantis | 🔴 | - | Cloud storage platform |
| **ownCloud** | Atlantis | 🔴 | - | Cloud storage alternative |
| **Seafile** | Atlantis | 🟡 | - | File sync and share |
| **Syncthing** | Multiple | 🟡 | - | Peer-to-peer file sync |
| **Resilio Sync** | Multiple | 🟡 | - | BitTorrent-based sync |
| **Rclone** | Multiple | 🟡 | - | Cloud storage sync |
| **Duplicati** | Multiple | 🟡 | - | Backup to cloud storage |
| **BorgBackup** | Multiple | 🔴 | - | Deduplicating backup |
| **Restic** | Multiple | 🟡 | - | Fast backup program |
| **Rsync** | Multiple | 🟡 | - | File synchronization |
| **WireGuard** | Multiple | 🟡 | - | VPN server |
| **OpenVPN** | Guava | 🔴 | - | VPN server |
| **Tailscale** | Multiple | 🟢 | - | Mesh VPN |
### 🔒 Security & Privacy (12 services)
| Service | Host | Difficulty | Description |
|---------|------|------------|-------------|
| **Vaultwarden** | Atlantis | 🟡 | Bitwarden-compatible password manager |
| **Authelia** | Guava | 🔴 | Authentication and authorization |
| **Keycloak** | Guava | 🔴 | Identity and access management |
| **Authentik** | Guava | 🔴 | Identity provider |
| **OAuth2 Proxy** | Guava | 🟡 | OAuth2 authentication proxy |
| **Fail2Ban** | Multiple | 🟡 | Intrusion prevention |
| **CrowdSec** | Multiple | 🟡 | Collaborative security |
| **Suricata** | Guava | 🔴 | Network threat detection |
| **Wazuh** | Guava | 🔴 | Security monitoring |
| **OSSEC** | Guava | 🔴 | Host intrusion detection |
| **ClamAV** | Multiple | 🟡 | Antivirus scanning |
| **Malware Scanner** | Multiple | 🟡 | File security scanning |
### 🛠️ Utilities & Tools (25 services)
| Service | Host | Difficulty | Description |
|---------|------|------------|-------------|
| **IT Tools** | Guava | 🟢 | Collection of IT utilities |
| **CyberChef** | Guava | 🟢 | Data analysis and encoding |
| **Stirling PDF** | Guava | 🟢 | PDF manipulation tools |
| **Gotenberg** | Guava | 🟡 | Document conversion API |
| **Apache Tika** | Guava | 🟡 | Content analysis toolkit |
| **Pandoc** | Guava | 🟡 | Document converter |
| **Draw.io** | Guava | 🟢 | Diagram creation |
| **Excalidraw** | Guava | 🟢 | Sketching tool |
| **Mermaid** | Guava | 🟢 | Diagram generation |
| **PlantUML** | Guava | 🟡 | UML diagram creation |
| **HedgeDoc** | Guava | 🟡 | Collaborative markdown editor |
| **BookStack** | Guava | 🟡 | Wiki platform |
| **DokuWiki** | Guava | 🟡 | File-based wiki |
| **TiddlyWiki** | Guava | 🟡 | Non-linear documentation |
| **Outline** | Guava | 🔴 | Team knowledge base |
| **Notion Alternative** | Guava | 🟡 | Workspace organization |
| **Joplin Server** | Guava | 🟡 | Note synchronization |
| **Standard Notes** | Guava | 🟡 | Encrypted notes |
| **Trilium** | Guava | 🟡 | Hierarchical note taking |
| **Obsidian LiveSync** | Guava | 🟡 | Obsidian synchronization |
| **Logseq** | Guava | 🟡 | Block-based note taking |
| **Athens** | Guava | 🟡 | Research tool |
| **Zotero** | Guava | 🟡 | Reference management |
| **Paperless-NGX** | Atlantis | 🟡 | Document management |
| **Teedy** | Atlantis | 🟡 | Document management |
## 🔍 Service Search & Filtering
### 🟢 Beginner-Friendly Services (Easy Setup)
- **Media**: Plex, Jellyfin, Navidrome, MeTube
- **Monitoring**: Uptime Kuma, Netdata, Glances
- **Utilities**: IT Tools, File Browser, Stirling PDF
- **Communication**: Element Web, Ntfy, Gotify
- **Development**: Dozzle, Watchtower, Code Server
### 🟡 Intermediate Services (Some Configuration Required)
- **Infrastructure**: Portainer, Nginx Proxy Manager, Grafana
- **Security**: Vaultwarden, Authelia, WireGuard
- **Home Automation**: Home Assistant, Node-RED
- **Development**: Gitea, Jenkins, Docker Registry
- **Media**: Immich, PhotoPrism, *arr stack
### 🔴 Advanced Services (Complex Setup)
- **Infrastructure**: Kubernetes, Nomad, Vault
- **Security**: Keycloak, Wazuh, Suricata
- **Communication**: Matrix Synapse, Mastodon
- **Monitoring**: ELK Stack, Jaeger, OpenTelemetry
- **AI/ML**: Stable Diffusion, ComfyUI, InvokeAI
## 📱 Services by Access Method
### 🌐 External Access (Internet)
- **Jitsi Meet**: Video conferencing via meet.thevish.io
- **Gitea**: Git repository via git.vish.gg (SSH port 2222)
- **Portainer**: Container management via pw.vish.gg:9443
- **Web Services**: Main site and proxied services via vish.gg
### 🔗 Tailscale Access (VPN)
- **All Services**: Accessible via hostname.tail.vish.gg
- **Admin Interfaces**: Secure access to management tools
- **Development**: Safe access to development services
- **Monitoring**: Private access to metrics and logs
### 🏠 Local Network Only
- **Infrastructure Services**: Core system components
- **Database Services**: Backend data storage
- **Internal APIs**: Service-to-service communication
- **Development Tools**: Local development environment
## 🚀 Quick Start Recommendations
### 🎬 Media Enthusiast
- Start with **Plex** or **Jellyfin** for streaming
- Add **Sonarr** and **Radarr** for content management
- Set up **Tautulli** for monitoring
- Configure **Overseerr** for requests
### 🔧 System Administrator
- Deploy **Portainer** for container management
- Set up **Grafana** and **Prometheus** for monitoring
- Configure **Uptime Kuma** for service monitoring
- Add **Vaultwarden** for password management
### 🏠 Smart Home User
- Install **Home Assistant** as the hub
- Add **Mosquitto MQTT** for device communication
- Set up **Node-RED** for automation
- Configure **Frigate** for security cameras
### 💻 Developer
- Set up **Gitea** for version control
- Deploy **Code Server** for remote development
- Add **Jenkins** or **Drone CI** for CI/CD
- Configure **Docker Registry** for images
## 📚 Documentation Standards
Each service documentation includes:
- **🎯 Purpose**: What the service does
- **🚀 Quick Start**: Basic deployment steps
- **🔧 Configuration**: Detailed setup options
- **🌐 Access Information**: How to reach the service
- **🔒 Security Considerations**: Important security notes
- **📊 Resource Requirements**: System requirements
- **🚨 Troubleshooting**: Common issues and solutions
- **📚 Additional Resources**: Links and references
## 🔄 Maintenance & Updates
- **Service Status**: All services actively maintained
- **Documentation Updates**: Synchronized with configuration changes
- **Version Tracking**: Container image versions documented
- **Security Updates**: Regular security patch applications
- **Backup Status**: Critical services backed up regularly
---
*Last Updated: 2025-11-17*
*Total Services: 159 fully documented*
*External Access: 4 services with domain names*
*Hosts: 14 systems across the infrastructure*
*Categories: 8 major service categories*