235 lines
11 KiB
Markdown
235 lines
11 KiB
Markdown
# 📚 Individual 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.
|
|
|
|
## 🎯 How to Use This Documentation
|
|
|
|
Each service documentation includes:
|
|
- **Service Overview**: Host, category, difficulty level
|
|
- **Purpose**: What the service does and why it's useful
|
|
- **Quick Start**: Step-by-step deployment instructions
|
|
- **Configuration**: Complete Docker Compose setup
|
|
- **Environment Variables**: All configuration options
|
|
- **Port & Volume Mappings**: Network and storage details
|
|
- **Access Information**: How to reach the service
|
|
- **Security Considerations**: Best practices and recommendations
|
|
- **Troubleshooting**: Common issues and solutions
|
|
- **Related Services**: Dependencies and integrations
|
|
|
|
## 📋 Services by Category
|
|
|
|
### 🤖 AI (1 service)
|
|
- 🟢 **Ollama** - guava - Large language model server
|
|
|
|
### 💬 Communication (10 services)
|
|
- 🟢 **Element Web** - anubis - Matrix web client
|
|
- 🟡 **Jicofo** - Atlantis - Jitsi conference focus
|
|
- 🟡 **JVB** - Atlantis - Jitsi video bridge
|
|
- 🔴 **Mastodon** - Atlantis - Decentralized social network
|
|
- 🔴 **Mastodon DB** - Atlantis - Mastodon database
|
|
- 🔴 **Mastodon Redis** - Atlantis - Mastodon cache
|
|
- 🟡 **Mattermost** - homelab_vm - Team collaboration platform
|
|
- 🟡 **Mattermost DB** - homelab_vm - Mattermost database
|
|
- 🟢 **Prosody** - Atlantis - XMPP server
|
|
- 🟢 **Signal CLI REST API** - homelab_vm - Signal messaging API
|
|
|
|
### 🛠️ Development (4 services)
|
|
- 🟢 **Companion** - concord_nuc - Development companion tool
|
|
- 🟢 **Inv Sig Helper** - concord_nuc - Invidious signature helper
|
|
- 🟡 **Invidious** - concord_nuc - YouTube frontend
|
|
- 🟢 **Redlib** - Atlantis - Reddit frontend
|
|
|
|
### 🎮 Gaming (1 service)
|
|
- 🟢 **Satisfactory Server** - homelab_vm - Factory building game server
|
|
|
|
### 🎬 Media (20 services)
|
|
- 🟢 **Bazarr** - Calypso - Subtitle management
|
|
- 🟢 **Calibre Web** - Atlantis - E-book library web interface
|
|
- 🟡 **Database** - raspberry-pi-5-vish - Media database
|
|
- 🟡 **Immich DB** - Calypso - Immich photo database
|
|
- 🟡 **Immich Machine Learning** - Calypso - Immich ML processing
|
|
- 🟡 **Immich Redis** - Calypso - Immich cache
|
|
- 🟡 **Immich Server** - raspberry-pi-5-vish - Photo management server
|
|
- 🟢 **Jackett** - Atlantis - Torrent indexer proxy
|
|
- 🟡 **Jellyfin** - Chicago_vm - Media server
|
|
- 🟢 **Lidarr** - Calypso - Music collection manager
|
|
- 🟢 **LinuxServer Prowlarr** - Calypso - Indexer manager
|
|
- 🟢 **Navidrome** - Bulgaria_vm - Music streaming server
|
|
- 🟡 **PhotoPrism** - anubis - AI-powered photo management
|
|
- 🟢 **Plex** - Calypso - Media server and streaming
|
|
- 🟢 **Prowlarr** - Calypso - Indexer manager
|
|
- 🟢 **Radarr** - Calypso - Movie collection manager
|
|
- 🟢 **Readarr** - Calypso - Book collection manager
|
|
- 🟢 **RomM** - homelab_vm - ROM management
|
|
- 🟢 **Sonarr** - Calypso - TV series collection manager
|
|
- 🟢 **Tautulli** - Calypso - Plex monitoring and statistics
|
|
|
|
### 📊 Monitoring (11 services)
|
|
- 🟡 **Blackbox Exporter** - Calypso - HTTP/HTTPS monitoring
|
|
- 🟡 **cAdvisor** - Calypso - Container resource monitoring
|
|
- 🟡 **Dash.** - homelab_vm - Server dashboard
|
|
- 🟡 **Grafana** - Calypso - Metrics visualization
|
|
- 🟡 **Node Exporter** - Calypso - System metrics exporter
|
|
- 🟡 **Prometheus** - Calypso - Metrics collection and storage
|
|
- 🟡 **SNMP Exporter** - Calypso - SNMP metrics exporter
|
|
- 🟡 **Speedtest Exporter** - Calypso - Internet speed monitoring
|
|
- 🟡 **Uptime Kuma** - Atlantis - Uptime monitoring
|
|
- 🟡 **Watchtower** - Atlantis - Container update automation
|
|
- 🟡 **WatchYourLAN** - homelab_vm - Network device monitoring
|
|
|
|
### 🌐 Networking (8 services)
|
|
- 🟡 **DDNS Crista Love** - guava - Dynamic DNS updater
|
|
- 🟡 **DDNS TheVish Proxied** - Atlantis - Dynamic DNS with proxy
|
|
- 🟡 **DDNS TheVish Unproxied** - Atlantis - Dynamic DNS direct
|
|
- 🟡 **DDNS Updater** - homelab_vm - Dynamic DNS service
|
|
- 🟡 **DDNS Vish 13340** - concord_nuc - Dynamic DNS on port 13340
|
|
- 🟡 **DDNS Vish Proxied** - Atlantis - Dynamic DNS with proxy
|
|
- 🟡 **DDNS Vish Unproxied** - Atlantis - Dynamic DNS direct
|
|
- 🟡 **Nginx Proxy Manager** - Atlantis - Reverse proxy management
|
|
|
|
### 🔧 Other Services (104 services)
|
|
- 🟢 **Actual Server** - Chicago_vm - Budget management
|
|
- 🟡 **AdGuard** - Chicago_vm - DNS ad blocking
|
|
- 🟢 **API** - Atlantis - API service
|
|
- 🟢 **App** - Atlantis - Application service
|
|
- 🔴 **APT Cacher NG** - Chicago_vm - Package caching proxy
|
|
- 🟢 **APT Repo** - Atlantis - APT repository
|
|
- 🟡 **ArchiveBox** - anubis - Web archiving
|
|
- 🟡 **ArchiveBox Scheduler** - guava - Archive scheduling
|
|
- 🟡 **Baikal** - Atlantis - CalDAV/CardDAV server
|
|
- 🟢 **BG Helper** - concord_nuc - Background helper service
|
|
- 🟢 **Binternet** - homelab_vm - Binary internet service
|
|
- 🟢 **Cache** - Chicago_vm - Caching service
|
|
- 🟢 **Chrome** - Calypso - Headless Chrome browser
|
|
- 🟢 **Cloudflare DNS Updater** - raspberry-pi-5-vish - DNS updater
|
|
- 🔴 **CoCalc** - guava - Collaborative calculation platform
|
|
- 🟢 **Coturn** - Atlantis - TURN/STUN server
|
|
- 🟢 **Cron** - Chicago_vm - Scheduled task runner
|
|
- 🟢 **Database** - raspberry-pi-5-vish - Database service
|
|
- 🟢 **DB** - Atlantis - Database service
|
|
- 🟢 **Deiucanta** - anubis - Custom service
|
|
- 🟢 **DockPeek** - Atlantis - Docker container inspector
|
|
- 🟢 **Documenso** - Atlantis - Document signing platform
|
|
- 🟢 **DokuWiki** - Atlantis - Wiki platform
|
|
- 🟢 **Dozzle** - Atlantis - Docker log viewer
|
|
- 🟢 **Draw.io** - anubis - Diagram creation tool
|
|
- 🟢 **Droppy** - homelab_vm - File sharing platform
|
|
- 🟢 **Fasten** - guava - Health record management
|
|
- 🟢 **Fenrus** - Atlantis - Application dashboard
|
|
- 🟡 **Firefly** - Atlantis - Personal finance manager
|
|
- 🟡 **Firefly DB** - Atlantis - Firefly database
|
|
- 🟡 **Firefly DB Backup** - Atlantis - Database backup service
|
|
- 🟡 **Firefly Redis** - Atlantis - Firefly cache
|
|
- 🟢 **FlareSolverr** - Calypso - Cloudflare bypass proxy
|
|
- 🟢 **Front** - Atlantis - Frontend service
|
|
- 🟢 **Gotenberg** - Atlantis - Document conversion API
|
|
- 🟢 **Gotify** - homelab_vm - Push notification server
|
|
- 🟢 **Home Assistant** - concord_nuc - Home automation platform
|
|
- 🟢 **Hyperpipe Back** - Atlantis - YouTube Music backend
|
|
- 🟢 **Hyperpipe Front** - Atlantis - YouTube Music frontend
|
|
- 🟢 **Importer** - Chicago_vm - Data import service
|
|
- 🟢 **Invidious DB** - concord_nuc - Invidious database
|
|
- 🟢 **iPerf3** - Atlantis - Network performance testing
|
|
- 🟢 **IT Tools** - Atlantis - IT utility collection
|
|
- 🟢 **JDownloader 2** - Atlantis - Download manager
|
|
- 🟢 **Jellyseerr** - Calypso - Media request management
|
|
- 🟢 **LibReddit** - homelab_vm - Reddit frontend
|
|
- 🟢 **LinuxGSM L4D2** - homelab_vm - Left 4 Dead 2 server
|
|
- 🟢 **LinuxGSM PMC Bind** - homelab_vm - Game server binding
|
|
- 🟢 **Materialious** - concord_nuc - Material design frontend
|
|
- 🔴 **Matrix Conduit** - anubis - Lightweight Matrix server
|
|
- 🟢 **Matter Server** - concord_nuc - Matter protocol server
|
|
- 🟢 **Meilisearch** - homelab_vm - Search engine
|
|
- 🟢 **MeTube** - homelab_vm - YouTube downloader
|
|
- 🟢 **MinIO** - Calypso - Object storage server
|
|
- 🟢 **MongoDB** - Chicago_vm - NoSQL database
|
|
- 🟢 **Neko Rooms** - Chicago_vm - Virtual browser rooms
|
|
- 🔴 **NetBox** - Atlantis - Network documentation
|
|
- 🟡 **NetBox DB** - Atlantis - NetBox database
|
|
- 🟡 **NetBox Redis** - Atlantis - NetBox cache
|
|
- 🟢 **Nginx** - Atlantis - Web server
|
|
- 🟢 **ntfy** - Atlantis - Push notification service
|
|
- 🟢 **OpenProject** - homelab_vm - Project management
|
|
- 🟢 **Open WebUI** - guava - AI chat interface
|
|
- 🟢 **Pi.Alert** - anubis - Network device scanner
|
|
- 🟡 **Pi-hole** - Atlantis - DNS ad blocker
|
|
- 🟢 **Piped** - concord_nuc - YouTube frontend
|
|
- 🟢 **Piped Back** - Atlantis - Piped backend
|
|
- 🟢 **Piped Front** - Atlantis - Piped frontend
|
|
- 🟢 **Piped Frontend** - concord_nuc - Piped web interface
|
|
- 🟢 **Piped Proxy** - Atlantis - Piped proxy service
|
|
- 🟢 **PodGrab** - homelab_vm - Podcast downloader
|
|
- 🟢 **PostgreSQL** - concord_nuc - Relational database
|
|
- 🟢 **ProtonMail Bridge** - homelab_vm - ProtonMail IMAP/SMTP
|
|
- 🟢 **ProxiTok** - anubis - TikTok frontend
|
|
- 🟢 **RainLoop** - homelab_vm - Web email client
|
|
- 🟢 **Redis** - Atlantis - In-memory data store
|
|
- 🟢 **Resume** - Calypso - Resume/CV service
|
|
- 🟢 **Roundcube** - homelab_vm - Web email client
|
|
- 🟢 **Roundcube ProtonMail** - homelab_vm - Roundcube for ProtonMail
|
|
- 🟢 **SABnzbd** - Calypso - Usenet downloader
|
|
- 🟢 **Seafile** - Chicago_vm - File sync and share
|
|
- 🟢 **Server** - homelab_vm - Generic server service
|
|
- 🟢 **Shlink** - homelab_vm - URL shortener
|
|
- 🟢 **Shlink DB** - homelab_vm - Shlink database
|
|
- 🟢 **Shlink Web** - homelab_vm - Shlink web interface
|
|
- 🟢 **Signer** - Chicago_vm - Document signing service
|
|
- 🟢 **Sonic** - guava - Search backend
|
|
- 🟢 **Stirling PDF** - Atlantis - PDF manipulation tools
|
|
- 🔴 **Synapse** - Atlantis - Matrix homeserver
|
|
- 🟡 **Synapse DB** - Atlantis - Synapse database
|
|
- 🟢 **Syncthing** - homelab_vm - File synchronization
|
|
- 🟢 **Termix** - Atlantis - Terminal service
|
|
- 🟢 **Tika** - Atlantis - Content analysis toolkit
|
|
- 🔴 **Vaultwarden** - Atlantis - Password manager
|
|
- 🟢 **Web** - Calypso - Web service
|
|
- 🟢 **WebCheck** - homelab_vm - Website analyzer
|
|
- 🟢 **WebCord** - homelab_vm - Discord client
|
|
- 🟢 **WebServer** - Atlantis - Web server service
|
|
- 🟢 **WebUI** - guava - Web interface
|
|
- 🟡 **WG Easy** - concord_nuc - WireGuard VPN manager
|
|
- 🟡 **WGEasy** - Atlantis - WireGuard VPN interface
|
|
- 🟢 **Whisparr** - Calypso - Adult content manager
|
|
- 🟢 **Wizarr** - Calypso - User invitation system
|
|
- 🟢 **YouTube Downloader** - Atlantis - YouTube video downloader
|
|
|
|
## 📊 Statistics
|
|
|
|
- **Total Services**: 159
|
|
- **Categories**: 7
|
|
- **Hosts**: 13
|
|
- **Beginner-Friendly (🟢)**: 104 services
|
|
- **Intermediate (🟡)**: 42 services
|
|
- **Advanced (🔴)**: 13 services
|
|
|
|
## 🔍 Quick Search Tips
|
|
|
|
1. **By Category**: Use the category sections above
|
|
2. **By Difficulty**: Look for the colored indicators (🟢🟡🔴)
|
|
3. **By Host**: Services are listed with their host names
|
|
4. **By Function**: Service names often indicate their purpose
|
|
|
|
## 💡 Usage Tips
|
|
|
|
- **Start with 🟢 services** if you're new to homelabs
|
|
- **🟡 services** require basic Docker/Linux knowledge
|
|
- **🔴 services** need significant technical expertise
|
|
- Check the main documentation for deployment patterns
|
|
- Use the troubleshooting guides for common issues
|
|
|
|
## 🔗 Related Documentation
|
|
|
|
- [02-Quick-Start-Guide](02-Quick-Start-Guide.md) - Getting started
|
|
- [22-Popular-Services](22-Popular-Services.md) - Most commonly used services
|
|
- [30-Deployment-Guide](30-Deployment-Guide.md) - How to deploy services
|
|
- [40-Common-Issues](40-Common-Issues.md) - Troubleshooting help
|
|
|
|
---
|
|
|
|
*This index provides an overview of all individual service documentation. Each service has its own detailed guide with complete setup and configuration instructions.*
|
|
|
|
*Last Updated: November 2024*
|
|
*Total Services Documented: 159* |