Stephen Klein
b106cfc177
Strip all macOS/Windows/WSL2 mentions from README.md and SERVICES.md. Platform status, GPU support, permission examples, and config paths now reflect Linux-only. TODO.md retains references as future roadmap tracking. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
104 lines
3.4 KiB
Markdown
104 lines
3.4 KiB
Markdown
# HOPS - Homelab Orchestration Provisioning Script
|
|
|
|
[](https://opensource.org/licenses/MIT)
|
|
[]()
|
|
[]()
|
|
|
|
**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 →](SERVICES.md)
|
|
|
|
## 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 →](INSTALLATION.md)
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# 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
|
|
|
|
```bash
|
|
# 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 →](ADVANCED.md)
|
|
|
|
## Support
|
|
|
|
**HOPS Issues**: [Gitea Issues](https://git.canadabot.net/canadabot/hops/issues)
|
|
|
|
**Service Issues**: Contact individual service developers (links in [SERVICES.md](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](INSTALLATION.md) - Detailed installation guide
|
|
- [SERVICES.md](SERVICES.md) - Complete service list with support links
|
|
- [ADVANCED.md](ADVANCED.md) - Configuration, troubleshooting, security
|
|
- [CHANGELOG.md](CHANGELOG.md) - Version history and changes
|
|
|
|
## License
|
|
|
|
MIT License - see [LICENSE](LICENSE) file for details.
|
|
|
|
---
|
|
|
|
**Made for the homelab community**
|