Stephen Klein
a7213441da
ADVANCED.md, INSTALLATION.md, and TROUBLESHOOTING.md were ~60-70% stale: references to deleted Path B scripts, macOS/WSL2 platform sections, old GitHub URLs, and v3.1-3.3 version history. Pruned to accurate Linux-only stubs to be rebuilt as the 1.0.0 codebase stabilises. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1.5 KiB
1.5 KiB
Installation Guide
Note
: This document is being rebuilt alongside the 1.0.0 codebase. Content will be expanded as features are stabilized.
System Requirements
- OS: Ubuntu 20.04+, Debian 11+, or Linux Mint 20+ (x86_64)
- RAM: 2GB minimum, 4GB+ recommended
- Storage: 10GB free (more for media)
- CPU: 2 cores recommended
- Access: sudo privileges
Installation
git clone https://git.canadabot.net/canadabot/hops.git
cd hops
chmod +x hops install uninstall
sudo ./hops
HOPS will install Docker automatically if not present, then walk you through selecting and deploying services interactively.
Directory Structure
~/hops/ # Deployment directory
├── docker-compose.yml # Generated service definitions
├── .env # Environment variables and secrets
└── logs/ # HOPS logs
/opt/appdata/ # Application config data
├── jellyfin/
├── sonarr/
└── [other services]/
/mnt/media/ # Media storage
├── movies/
├── tv/
├── music/
└── downloads/
Post-Installation
# Check service status
cd ~/hops && docker compose ps
# View logs
docker compose logs -f [service-name]
# Access management interface
sudo ./hops
Getting Help
- Issues: git.canadabot.net/canadabot/hops/issues
- Troubleshooting: TROUBLESHOOTING.md