HOPS - Homelab Orchestration Provisioning Script

HOPS is a comprehensive automation tool for deploying homelab infrastructure using Docker Compose. Deploy and manage popular homelab services including media servers, download clients, monitoring tools, and more through an intuitive menu-driven interface.

Important: Beta Software

HOPS is beta software. Always backup your data before installation and test in non-production environments first.

Platform Status:

• Linux: Stable and actively developed

Key Features

• Easy Installation: One-command setup with automatic Docker installation
• Security First: Encrypted secrets, firewall configuration, input validation
• Management: Real-time monitoring, centralized logs, service control
• Auto-Updates: Built-in update system with backup protection
• Reliability: Error handling, rollback capabilities, dependency management
• Linux Native: Ubuntu, Debian, and Linux Mint support

Supported Services

Media Management: Sonarr, Radarr, Lidarr, Readarr, Bazarr, Prowlarr, Tdarr, Huntarr
Download Clients: qBittorrent, Transmission, NZBGet, SABnzbd
Media Servers: Jellyfin, Plex, Emby, Jellystat
Request Management: Overseerr, Jellyseerr, Ombi
Reverse Proxy: Traefik, Nginx Proxy Manager, Caddy, Authelia
Monitoring: Portainer, Uptime Kuma, Watchtower

View complete service list with support links →

System Requirements

Minimum: 2GB RAM, 10GB storage, 2 CPU cores, internet connection

Supported Platforms:

• Linux: Ubuntu 20.04+, Debian 11+, Linux Mint 20+ (x86_64, sudo access)

View detailed installation guides →

Quick Start

# 1. Download HOPS
git clone https://git.canadabot.net/canadabot/hops.git
cd hops
chmod +x hops install uninstall

# 2. Run installation
sudo ./hops

# 3. Follow interactive setup to select services

# 4. Access your services
# URLs will be provided after installation

Directory Structure:

• ~/hops/ - Main deployment (docker-compose.yml, .env, logs)
• /opt/appdata/ - App configs
• /mnt/media/ - Media storage

Management

# Access management interface
sudo ./hops

# Update HOPS
sudo ./hops --update # Update to latest version
sudo ./hops --check-updates # Check for updates
./hops --version # Show version
./hops --help # Show help

View advanced configuration and troubleshooting →

Support

HOPS Issues: Gitea Issues

Service Issues: Contact individual service developers (links in SERVICES.md)

Contact HOPS for: Installation/deployment issues, Docker Compose problems, cross-platform issues
Contact Service Developers for: Service configuration, features, service-specific bugs

Documentation

• INSTALLATION.md - Detailed installation guide
• SERVICES.md - Complete service list with support links
• ADVANCED.md - Configuration, troubleshooting, security
• CHANGELOG.md - Version history and changes

License

MIT License - see LICENSE file for details.

---

Made for the homelab community