====== ๐Ÿ  Vish's Homelab Documentation ====== Welcome to the comprehensive documentation for Vish's homelab infrastructure! This system manages **306 services** across **14 hosts** with **176 Docker Compose files**. Documentation designed for users ranging from complete beginners ("what is a computer?") to experienced HPC engineers. **๐ŸŒ External Access Available**\\ Many services are accessible externally via **vish.gg** and **thevish.io** domains with automatic DDNS updates every 5 minutes. ===== ๐Ÿš€ Quick Navigation ===== ==== ๐Ÿ“– Getting Started ==== * [[getting-started-quick-start|๐Ÿš€ Quick Start Guide]] - Get up and running fast * [[infrastructure-overview|๐Ÿ—๏ธ Infrastructure Overview]] - System architecture and hosts * [[network-configuration|๐ŸŒ Network Configuration]] - Tailscale, 10GbE, and connectivity * [[hardware-specifications|๐Ÿ’ป Hardware Specifications]] - Complete device inventory ==== ๐Ÿ”ง Services Documentation ==== * [[services-popular|โญ Popular Services]] - Most commonly used services * [[services-individual-index|๐Ÿ“‹ Complete Service Index]] - All 159 individual services * [[services-by-category|๐Ÿ“‚ Services by Category]] - Organized by function * [[services-external-access|๐ŸŒ External Access Services]] - Publicly available services ==== ๐Ÿ› ๏ธ Infrastructure & Networking ==== * [[port-forwarding-configuration|๐Ÿ”Œ Port Forwarding]] - External access configuration * [[tailscale-setup|๐Ÿ”— Tailscale Setup]] - Mesh VPN with split-brain DNS * [[travel-connectivity|โœˆ๏ธ Travel Connectivity]] - Mobile and laptop setup * [[family-network-integration|๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Family Network]] - Separate network bridge ==== ๐Ÿšจ Emergency & Recovery ==== * [[disaster-recovery|๐Ÿšจ Disaster Recovery]] - Router failure and network issues * [[offline-password-access|๐Ÿ” Offline Password Access]] - When Vaultwarden is down * [[troubleshooting-common|๐Ÿ”ง Common Issues]] - Frequent problems and solutions ===== ๐Ÿ–ฅ๏ธ System Overview ===== ==== ๐Ÿ  Primary Infrastructure ==== ^ Host ^ IP Address ^ Services ^ Primary Function ^ External Access ^ | **Atlantis** | 192.168.0.200 | 45 services | Primary NAS, Jitsi Meet | Portainer, Jitsi | | **Calypso** | 192.168.0.250 | 38 services | Development, Web Services | Gitea SSH, HTTPS | | **Shinku-Ryuu** | 192.168.0.201 | 32 services | Gaming, Entertainment | - | | **Guava** | 192.168.0.202 | 28 services | Monitoring, Utilities | - | | **Concord-NUC** | 192.168.0.203 | 12 services | Family Network Bridge | - | ==== ๐Ÿ“ฑ Mobile & Travel Infrastructure ==== ^ Device ^ Type ^ Purpose ^ Tailscale IP ^ | **MSI Prestige 13 AI Plus** | Travel Laptop | Business Travel | 100.x.x.x | | **GL.iNet Comet GL-RM1** | KVM Router | Remote Server Access | 100.x.x.x | | **GL.iNet Slate 7 GL-BE3600** | WiFi 7 Router | High-Speed Travel | 100.x.x.x | | **GL.iNet Beryl AX GL-MT3000** | Compact Router | Extended Travel | 100.x.x.x | | **GL.iNet Mango GL-MT300N-V2** | Mini Router | Emergency Backup | 100.x.x.x | | **GL.iNet GL-S200** | IoT Gateway | Device Management | 100.x.x.x | ===== ๐ŸŒ External Access Domains ===== ==== ๐Ÿ”Œ Port Forwarded Services ==== ^ Service ^ Domain ^ Port ^ Purpose ^ | **๐ŸŽฅ Jitsi Meet** | ''meet.thevish.io'' | 4443 | Video conferencing | | **๐Ÿ“ Gitea SSH** | ''git.vish.gg'' | 2222 | Git repository access | | **๐Ÿณ Portainer** | ''pw.vish.gg'' | 9443 | Container management | | **๐ŸŒ Web Services** | ''vish.gg'' | 443/80 | Main website | ==== ๐ŸŒ Cloudflare Proxied Services ==== * **๐Ÿ“… Calendar**: ''https://cal.vish.gg'' * **๐Ÿ’ฌ Matrix Chat**: ''https://matrix.thevish.io'' * **๐Ÿ““ Joplin Notes**: ''https://joplin.thevish.io'' * **๐Ÿ”— Reddit Alt**: ''https://reddit.vish.gg'' * **๐ŸŒ Main Sites**: ''https://www.vish.gg'', ''https://www.thevish.io'' ==== ๐Ÿ”„ DDNS Configuration ==== * **Update Frequency**: Every 5 minutes * **Domains**: vish.gg and thevish.io * **Services**: 4 DDNS updaters (proxied/unproxied for each domain) * **Records**: IPv4 (A) and IPv6 (AAAA) automatic updates ===== ๐Ÿ“Š Service Categories & Counts ===== ==== ๐ŸŽฌ Media & Entertainment (45 services) ==== * **Streaming Servers**: Plex, Jellyfin, Navidrome, Immich * **Download Management**: Sonarr, Radarr, Lidarr, Readarr, Whisparr, Bazarr * **Media Tools**: Tautulli, MeTube, Podgrab, Calibre-Web * **Gaming**: Satisfactory Server, LinuxGSM servers ==== ๐Ÿ”ง Development & DevOps (38 services) ==== * **Version Control**: Gitea (external SSH), Git repositories * **Container Management**: Portainer (external access), Docker registries * **CI/CD**: Automated builds, deployment pipelines * **Development Tools**: Code servers, API endpoints ==== ๐Ÿ“Š Monitoring & Analytics (28 services) ==== * **Metrics Collection**: Grafana, Prometheus, Node Exporter * **Uptime Monitoring**: Uptime Kuma, health checks * **Network Monitoring**: SNMP Exporter, Speedtest Exporter * **System Monitoring**: cAdvisor, Blackbox Exporter ==== ๐ŸŒ Web Services & Proxies (32 services) ==== * **Reverse Proxies**: Nginx, Nginx Proxy Manager * **Web Applications**: Various hosted web services * **APIs & Backends**: Service APIs, database frontends * **Static Sites**: Documentation, personal websites ==== ๐Ÿ’ฌ Communication & Collaboration (18 services) ==== * **Video Conferencing**: Jitsi Meet (external access via meet.thevish.io) * **Chat Platforms**: Matrix Synapse, Element Web, Mastodon * **Email Services**: Roundcube, ProtonMail Bridge * **Team Collaboration**: Mattermost, communication tools ==== ๐Ÿ  Home Automation & IoT (15 services) ==== * **Smart Home Control**: Home Assistant, Matter Server * **IoT Device Management**: Device monitoring and control * **Automation Scripts**: Workflows and triggers * **Sensor Data**: Collection and processing ==== ๐Ÿ”’ Security & Authentication (12 services) ==== * **Password Management**: Vaultwarden (with offline backup) * **VPN Services**: WireGuard Easy, Tailscale mesh * **Network Security**: Pi-hole, AdGuard Home * **Authentication**: SSO services, security tools ==== ๐Ÿค– AI & Machine Learning (8 services) ==== * **Language Models**: Ollama, OpenWebUI * **AI Tools**: Various AI-powered applications * **Machine Learning**: Model serving and inference * **Data Processing**: AI-enhanced workflows ===== ๐ŸŒ Network Architecture ===== ==== ๐Ÿ”— Tailscale Mesh VPN ==== * **Network Name**: ''tail.vish.gg'' * **Active Devices**: 23 connected devices * **Split-Brain DNS**: Local hostname resolution (atlantis.tail.vish.gg) * **Exit Nodes**: Available for secure internet routing * **Magic DNS**: Automatic device discovery and naming ==== ๐Ÿš€ 10 Gigabit Ethernet Infrastructure ==== * **Switch**: TP-Link TL-SX1008 (8-port 10GbE unmanaged) * **Connected Hosts**: Atlantis, Calypso, Shinku-Ryuu, Guava * **Bandwidth**: Full 10Gbps between connected systems * **Use Cases**: Large file transfers, media streaming, backups ==== ๐ŸŒ External Connectivity ==== * **Router**: TP-Link Archer BE800 v1.6 (WiFi 7, BE19000) * **Port Forwarding**: 10 active rules for external services * **DDNS**: Automatic Cloudflare updates every 5 minutes * **Domains**: vish.gg and thevish.io with Cloudflare proxy protection * **IPv6**: Full dual-stack support with AAAA records ===== ๐Ÿ“ฑ Mobile & Travel Infrastructure ===== ==== โœˆ๏ธ Travel Connectivity Suite ==== * **Primary Laptop**: MSI Prestige 13 AI Plus (Intel Core Ultra 7 258V) * **KVM Access**: GL.iNet Comet GL-RM1 for remote server management * **WiFi 7 Router**: GL.iNet Slate 7 GL-BE3600 for high-speed connectivity * **Compact Router**: GL.iNet Beryl AX GL-MT3000 for extended travel * **Emergency Backup**: GL.iNet Mango GL-MT300N-V2 mini router * **IoT Gateway**: GL.iNet GL-S200 for device management ==== ๐Ÿ”’ Travel Security Features ==== * **VPN Tunneling**: All traffic routed through Atlantis exit node * **Remote Mounting**: Secure file access via SSHFS * **Disposable Data**: Minimal local storage, cloud-first approach * **Encrypted Communications**: All connections via Tailscale mesh ==== ๐Ÿ“ฑ Mobile Device Support ==== * **Platforms**: iOS, Android, macOS, Linux, iPadOS, Debian, Rocky Linux * **Tailscale Integration**: All devices connected to mesh network * **Family Devices**: Separate network integration via Concord-NUC * **Guest Access**: Isolated network access for visitors ===== ๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Family Network Integration ===== ==== ๐ŸŒ‰ Network Bridge Setup ==== * **Bridge Device**: Concord-NUC (Intel NUC13ANHi7) * **Family Network**: 2 Gbps down / 400 Mbps up * **Homelab Network**: 20 Gbps up/down fiber * **Services**: Plex streaming, Immich photo sync, Synology file sharing ==== ๐ŸŽฌ Shared Services ==== * **Media Streaming**: Plex server accessible from family network * **Photo Management**: Immich for family photo backup and sharing * **File Sharing**: Synology NAS accessible for document sharing * **Bandwidth Optimization**: QoS and traffic shaping ===== ๐Ÿšจ Disaster Recovery & Emergency Procedures ===== ==== ๐Ÿ”ง Router Failure Recovery ==== * **Backup Configuration**: TP-Link settings exported monthly * **Manual Reconfiguration**: Step-by-step port forwarding restoration * **Network Isolation**: Tailscale mesh continues independent operation * **Service Priority**: Critical services restoration order documented ==== ๐Ÿ” Offline Password Access ==== * **Vaultwarden Backup**: Local database exports and encrypted storage * **Emergency Access**: Offline password retrieval procedures * **Mobile Backup**: Cached credentials on mobile devices * **Recovery Methods**: Multiple access paths documented ==== ๐Ÿ“ฑ Travel Emergency Procedures ==== * **Connectivity Loss**: Multiple router fallback options * **Device Failure**: Remote server access via KVM * **Data Recovery**: Cloud backup and sync procedures * **Communication**: Alternative contact methods ===== ๐Ÿ› ๏ธ Getting Started by Experience Level ===== ==== For Complete Beginners ๐ŸŸข ==== - **Start Here**: [[getting-started-quick-start|Quick Start Guide]] - **Learn Basics**: What is Docker, containers, networking - **First Services**: Set up Plex or Jellyfin for media streaming - **Remote Access**: Configure Tailscale for secure connections - **Popular Apps**: Explore [[services-popular|Popular Services]] ==== For Intermediate Users ๐ŸŸก ==== - **Service Exploration**: Browse [[services-individual-index|Complete Service Index]] - **External Access**: Set up [[port-forwarding-configuration|Port Forwarding]] - **Travel Setup**: Configure [[travel-connectivity|Mobile Connectivity]] - **Monitoring**: Implement Grafana and Prometheus dashboards - **Automation**: Basic Docker Compose customizations ==== For Advanced Users ๐Ÿ”ด ==== - **Architecture Review**: Study [[hardware-specifications|Hardware Architecture]] - **Disaster Recovery**: Implement [[disaster-recovery|Emergency Procedures]] - **Network Engineering**: Advanced VLANs, routing, and security - **Automation**: Infrastructure as Code with Ansible - **Scaling**: Multi-host deployments and load balancing ==== For HPC Engineers ๐Ÿ”ด ==== - **Performance Optimization**: 10GbE network utilization - **Container Orchestration**: Kubernetes cluster deployment - **Monitoring Stack**: Advanced metrics and alerting - **Security Hardening**: Enterprise-grade security implementations - **Integration Patterns**: Complex service interdependencies ===== ๐Ÿ“š Documentation Organization ===== ==== ๐Ÿ“– Documentation Types ==== * **๐ŸŸข Beginner Guides** - Step-by-step with explanations * **๐ŸŸก Configuration Guides** - Setup and customization details * **๐Ÿ”ด Advanced Topics** - Complex deployments and troubleshooting * **๐Ÿ”ง Reference Docs** - Technical specifications and APIs * **๐Ÿšจ Emergency Guides** - Crisis management and recovery ==== ๐Ÿ” How to Find Information ==== - **By Service**: Use [[services-individual-index|Service Index]] for specific applications - **By Category**: Browse [[services-by-category|Service Categories]] for related services - **By Function**: Check [[services-popular|Popular Services]] for common use cases - **By Problem**: Search [[troubleshooting-common|Common Issues]] for solutions - **By Access Method**: Review [[services-external-access|External Access]] for remote services ===== ๐Ÿ”„ Recent Major Updates ===== ==== November 2025 Updates ==== * **โœ… Port Forwarding Documentation** - Complete external access configuration * **โœ… Domain Integration** - All vish.gg and thevish.io domains documented * **โœ… Travel Infrastructure** - GL.iNet router suite and MSI laptop setup * **โœ… Family Network Integration** - Concord-NUC bridge configuration * **โœ… Disaster Recovery** - Router failure and offline access procedures * **โœ… Individual Service Docs** - All 159 services fully documented * **โœ… DDNS Configuration** - Automatic Cloudflare updates every 5 minutes ==== Infrastructure Milestones ==== * **306 Total Services** across 14 hosts * **159 Individual Service Guides** with full documentation * **23 Tailscale Devices** in active mesh network * **10 External Port Forwards** for public service access * **12 Domain Names** with automatic DDNS updates * **6 Travel Routers** for complete mobile connectivity ===== ๐Ÿค Contributing & Feedback ===== ==== ๐Ÿ“ Documentation Improvements ==== - Found an error? Check the service's individual documentation page - Missing information? Review the troubleshooting sections - Want to add content? Follow the established documentation patterns - Need help? Check the emergency procedures and common issues ==== ๐Ÿ”„ Keeping Documentation Current ==== - Service configurations are auto-generated from Docker Compose files - Infrastructure changes are documented within 24 hours - External access information is verified monthly - Hardware specifications are updated with each change ===== ๐Ÿ“Š Quick Statistics ===== **๐Ÿ“ˆ Homelab Statistics** * **Total Services**: 306 across all hosts * **Documented Services**: 159 individual guides * **External Domains**: 12 with automatic DDNS * **Network Devices**: 23 in Tailscale mesh * **Port Forwards**: 10 active external access rules * **Travel Routers**: 6 GL.iNet devices for mobility * **Documentation Pages**: 200+ comprehensive guides * **Last Updated**: 2025-11-17 ===== ๐Ÿ”— External Links & Resources ===== * **Git Repository**: ''https://git.vish.gg/Vish/homelab'' * **Jitsi Meet**: ''https://meet.thevish.io'' * **Portainer**: ''https://pw.vish.gg:9443'' * **Main Website**: ''https://vish.gg'' * **Tailscale Network**: ''tail.vish.gg'' ---- //Last Updated: 2025-11-17//\\ //Infrastructure: 306 services, 159 documented, 14 hosts, 23 Tailscale devices//\\ //External Access: 12 domains, 10 port forwards, 5-minute DDNS updates//\\ //Documentation Status: Complete with comprehensive guides for all experience levels//