canadabot/hops
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Strip emojis from documentation

Browse Source 
Remove all emoji characters from README.md and SERVICES.md.
Box-drawing characters and typographic arrows (U+2192) retained.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Stephen Klein
2026-06-10 21:21:11 -04:00
parent a7213441da
commit f618ce2c69
2 changed files with 34 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+23 -23
View File
@@ -6,24 +6,24 @@
**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. **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 ## Important: Beta Software
**HOPS is beta software**. Always backup your data before installation and test in non-production environments first. **HOPS is beta software**. Always backup your data before installation and test in non-production environments first.
**Platform Status:** **Platform Status:**
- **Linux**: ✅ Stable and actively developed - **Linux**: Stable and actively developed
- **macOS**: 🗓️ Planned for a future release - **macOS**: Planned for a future release
- **Windows (WSL2)**: 🗓️ Planned for a future release - **Windows (WSL2)**: Planned for a future release
## ✨ Key Features ## Key Features
- **🚀 Easy Installation**: One-command setup with automatic Docker installation - **Easy Installation**: One-command setup with automatic Docker installation
- **🔒 Security First**: Encrypted secrets, firewall configuration, input validation - **Security First**: Encrypted secrets, firewall configuration, input validation
- **📊 Management**: Real-time monitoring, centralized logs, service control - **Management**: Real-time monitoring, centralized logs, service control
- **🔄 Auto-Updates**: Built-in update system with backup protection - **Auto-Updates**: Built-in update system with backup protection
- **🔧 Reliability**: Error handling, rollback capabilities, dependency management - **Reliability**: Error handling, rollback capabilities, dependency management
- **🐧 Linux Native**: Ubuntu, Debian, and Linux Mint support - **Linux Native**: Ubuntu, Debian, and Linux Mint support
## 📱 Supported Services ## Supported Services
**Media Management**: Sonarr, Radarr, Lidarr, Readarr, Bazarr, Prowlarr, Tdarr, Huntarr **Media Management**: Sonarr, Radarr, Lidarr, Readarr, Bazarr, Prowlarr, Tdarr, Huntarr
**Download Clients**: qBittorrent, Transmission, NZBGet, SABnzbd **Download Clients**: qBittorrent, Transmission, NZBGet, SABnzbd
@@ -34,7 +34,7 @@
[View complete service list with support links →](SERVICES.md) [View complete service list with support links →](SERVICES.md)
## 🔧 System Requirements ## System Requirements
**Minimum**: 2GB RAM, 10GB storage, 2 CPU cores, internet connection **Minimum**: 2GB RAM, 10GB storage, 2 CPU cores, internet connection
@@ -43,7 +43,7 @@
[View detailed installation guides →](INSTALLATION.md) [View detailed installation guides →](INSTALLATION.md)
## 🚀 Quick Start ## Quick Start
```bash ```bash
# 1. Download HOPS # 1. Download HOPS
@@ -65,22 +65,22 @@ sudo ./hops
- `/opt/appdata/` - App configs - `/opt/appdata/` - App configs
- `/mnt/media/` - Media storage - `/mnt/media/` - Media storage
## 🎛️ Management ## Management
```bash ```bash
# Access management interface # Access management interface
sudo ./hops sudo ./hops
# Update HOPS # Update HOPS
sudo ./hops --update # Update to latest version sudo ./hops --update # Update to latest version
sudo ./hops --check-updates # Check for updates sudo ./hops --check-updates # Check for updates
./hops --version # Show version ./hops --version # Show version
./hops --help # Show help ./hops --help # Show help
``` ```
[View advanced configuration and troubleshooting →](ADVANCED.md) [View advanced configuration and troubleshooting →](ADVANCED.md)
## 📞 Support ## Support
**HOPS Issues**: [Gitea Issues](https://git.canadabot.net/canadabot/hops/issues) **HOPS Issues**: [Gitea Issues](https://git.canadabot.net/canadabot/hops/issues)
@@ -89,17 +89,17 @@ sudo ./hops --check-updates # Check for updates
**Contact HOPS for**: Installation/deployment issues, Docker Compose problems, cross-platform issues **Contact HOPS for**: Installation/deployment issues, Docker Compose problems, cross-platform issues
**Contact Service Developers for**: Service configuration, features, service-specific bugs **Contact Service Developers for**: Service configuration, features, service-specific bugs
## 📄 Documentation ## Documentation
- [INSTALLATION.md](INSTALLATION.md) - Detailed installation guide - [INSTALLATION.md](INSTALLATION.md) - Detailed installation guide
- [SERVICES.md](SERVICES.md) - Complete service list with support links - [SERVICES.md](SERVICES.md) - Complete service list with support links
- [ADVANCED.md](ADVANCED.md) - Configuration, troubleshooting, security - [ADVANCED.md](ADVANCED.md) - Configuration, troubleshooting, security
- [CHANGELOG.md](CHANGELOG.md) - Version history and changes - [CHANGELOG.md](CHANGELOG.md) - Version history and changes
## 📄 License ## License
MIT License - see [LICENSE](LICENSE) file for details. MIT License - see [LICENSE](LICENSE) file for details.
--- ---
**Made with ❤️ for the homelab community** **Made for the homelab community**
SERVICES.md
+11 -11
View File
@@ -2,7 +2,7 @@
HOPS supports a comprehensive collection of homelab services across multiple categories. All services use LinuxServer.io containers for consistency and reliability. HOPS supports a comprehensive collection of homelab services across multiple categories. All services use LinuxServer.io containers for consistency and reliability.
## 📺 Media Management (*arr Stack) ## Media Management (*arr Stack)
### Sonarr - TV Series Management ### Sonarr - TV Series Management
**Purpose**: Automatic TV show downloading and management **Purpose**: Automatic TV show downloading and management
@@ -27,7 +27,7 @@ HOPS supports a comprehensive collection of homelab services across multiple cat
**Default Port**: 8787 **Default Port**: 8787
**Support**: [github.com/Readarr/Readarr](https://github.com/Readarr/Readarr) **Support**: [github.com/Readarr/Readarr](https://github.com/Readarr/Readarr)
**Documentation**: [wiki.servarr.com/readarr](https://wiki.servarr.com/readarr) **Documentation**: [wiki.servarr.com/readarr](https://wiki.servarr.com/readarr)
**Status**: ⚠️ Project retired, limited support **Status**: Project retired, limited support
### Bazarr - Subtitle Management ### Bazarr - Subtitle Management
**Purpose**: Automatic subtitle downloading for movies and TV **Purpose**: Automatic subtitle downloading for movies and TV
@@ -53,7 +53,7 @@ HOPS supports a comprehensive collection of homelab services across multiple cat
**Support**: [github.com/plexguide/Huntarr.io](https://github.com/plexguide/Huntarr.io) **Support**: [github.com/plexguide/Huntarr.io](https://github.com/plexguide/Huntarr.io)
**Documentation**: Community-driven **Documentation**: Community-driven
## ⬇️ Download Clients ## Download Clients
### qBittorrent - BitTorrent Client ### qBittorrent - BitTorrent Client
**Purpose**: Feature-rich BitTorrent client with web interface **Purpose**: Feature-rich BitTorrent client with web interface
@@ -79,7 +79,7 @@ HOPS supports a comprehensive collection of homelab services across multiple cat
**Support**: [github.com/sabnzbd/sabnzbd](https://github.com/sabnzbd/sabnzbd) **Support**: [github.com/sabnzbd/sabnzbd](https://github.com/sabnzbd/sabnzbd)
**Documentation**: [sabnzbd.org/wiki](https://sabnzbd.org/wiki) **Documentation**: [sabnzbd.org/wiki](https://sabnzbd.org/wiki)
## 🎞️ Media Servers ## Media Servers
### Jellyfin - Open Source Media Server ### Jellyfin - Open Source Media Server
**Purpose**: Free, open-source media server and entertainment hub **Purpose**: Free, open-source media server and entertainment hub
@@ -109,7 +109,7 @@ HOPS supports a comprehensive collection of homelab services across multiple cat
**Documentation**: GitHub repository **Documentation**: GitHub repository
**Requirements**: Requires Jellyfin server **Requirements**: Requires Jellyfin server
## 🎛️ Request Management ## Request Management
### Overseerr - Plex Request Management ### Overseerr - Plex Request Management
**Purpose**: Media discovery and request management for Plex **Purpose**: Media discovery and request management for Plex
@@ -132,7 +132,7 @@ HOPS supports a comprehensive collection of homelab services across multiple cat
**Documentation**: [docs.ombi.app](https://docs.ombi.app) **Documentation**: [docs.ombi.app](https://docs.ombi.app)
**Integration**: Plex, Emby, Jellyfin **Integration**: Plex, Emby, Jellyfin
## 🔒 Reverse Proxy & Security ## Reverse Proxy & Security
### Traefik - Modern Reverse Proxy ### Traefik - Modern Reverse Proxy
**Purpose**: Automatic reverse proxy with SSL certificate management **Purpose**: Automatic reverse proxy with SSL certificate management
@@ -153,7 +153,7 @@ HOPS supports a comprehensive collection of homelab services across multiple cat
**Default Ports**: 80, 443, 2019 (admin) **Default Ports**: 80, 443, 2019 (admin)
**Support**: [github.com/caddyserver/caddy](https://github.com/caddyserver/caddy) **Support**: [github.com/caddyserver/caddy](https://github.com/caddyserver/caddy)
**Documentation**: [caddyserver.com/docs](https://caddyserver.com/docs) **Documentation**: [caddyserver.com/docs](https://caddyserver.com/docs)
**Note**: ⚠️ **Configuration not included** - Users must provide their own Caddyfile **Note**: **Configuration not included** - Users must provide their own Caddyfile
### Authelia - Authentication & Authorization ### Authelia - Authentication & Authorization
**Purpose**: Multi-factor authentication and single sign-on **Purpose**: Multi-factor authentication and single sign-on
@@ -162,7 +162,7 @@ HOPS supports a comprehensive collection of homelab services across multiple cat
**Documentation**: [authelia.com/integration](https://www.authelia.com/integration) **Documentation**: [authelia.com/integration](https://www.authelia.com/integration)
**Features**: 2FA, LDAP, OAuth2, OIDC **Features**: 2FA, LDAP, OAuth2, OIDC
## 📈 Monitoring & Management ## Monitoring & Management
### Portainer - Container Management ### Portainer - Container Management
**Purpose**: Web-based Docker container management interface **Purpose**: Web-based Docker container management interface
@@ -185,7 +185,7 @@ HOPS supports a comprehensive collection of homelab services across multiple cat
**Documentation**: [containrrr.dev/watchtower](https://containrrr.dev/watchtower) **Documentation**: [containrrr.dev/watchtower](https://containrrr.dev/watchtower)
**Features**: Scheduled updates, notifications, selective updating **Features**: Scheduled updates, notifications, selective updating
## 🔧 Service Dependencies ## Service Dependencies
### Common Dependencies ### Common Dependencies
Most services depend on: Most services depend on:
@@ -213,7 +213,7 @@ Most services depend on:
2. **Uptime Kuma** → Service monitoring 2. **Uptime Kuma** → Service monitoring
3. **Watchtower** → Automatic updates 3. **Watchtower** → Automatic updates
## ⚠️ Important Service Notes ## Important Service Notes
### Caddy Configuration ### Caddy Configuration
HOPS provides the Caddy container but **does not include Caddyfile configuration**. Users must: HOPS provides the Caddy container but **does not include Caddyfile configuration**. Users must:
@@ -243,7 +243,7 @@ All web-based services include health checks for:
- Automatic restart on failure - Automatic restart on failure
- Status monitoring integration - Status monitoring integration
## 🆘 Service-Specific Support ## Service-Specific Support
### When to Contact Service Developers ### When to Contact Service Developers