Clean up stale README content

- Update platform badge and status to Linux-only (macOS/WSL2 future)
- Remove v3.2.0/v3.3.0 "What's New" sections
- Update git clone URL to git.canadabot.net
- Remove deleted setup script from chmod and quick start
- Remove user-operations commands (file deleted)
- Drop macOS directory paths from directory structure
- Update support links from GitHub to Gitea
- Update cross-platform feature claim to Linux Native

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Stephen Klein
2026-06-10 21:12:55 -04:00
parent a99a1e65ce
commit 148a0827e3
+12 -32
View File
@@ -2,7 +2,7 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Version](https://img.shields.io/badge/Version-1.0.0-blue.svg)]() [![Version](https://img.shields.io/badge/Version-1.0.0-blue.svg)]()
[![Platform](https://img.shields.io/badge/Platform-Linux%20%7C%20macOS%20%7C%20Windows-orange.svg)]() [![Platform](https://img.shields.io/badge/Platform-Linux-orange.svg)]()
**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.
@@ -10,21 +10,9 @@
**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 extensively tested - **Linux**: ✅ Stable and actively developed
- **macOS**: ✅ Recently improved with v3.2.0 fixes - **macOS**: 🗓️ Planned for a future release
- **Windows (WSL2)**: Limited testing - **Windows (WSL2)**: 🗓 Planned for a future release
## 🆕 What's New in v3.3.0
- **🔄 Automatic Updates**: Git-based update system with backup functionality
- **📱 Command Line Interface**: `--update`, `--check-updates`, `--version`, `--help` flags
- **🛡️ Safe Updates**: Automatic backup of local changes before updating
- **📋 Change Tracking**: View recent changes and version comparison
### Previous Updates (v3.2.0)
- **Enhanced macOS Support**: Docker Desktop integration, keychain authentication, user directory fixes
- **Caddy Support**: Added reverse proxy option (user provides configuration)
- **Bug Fixes**: Password generation, container creation, healthchecks, file permissions
- **Security**: Encrypted secret management, input validation, privilege separation
## ✨ Key Features ## ✨ Key Features
@@ -33,7 +21,7 @@
- **📊 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
- **🌐 Cross-Platform**: Linux, macOS, and Windows (WSL2) support - **🐧 Linux Native**: Ubuntu, Debian, and Linux Mint support
## 📱 Supported Services ## 📱 Supported Services
@@ -52,8 +40,6 @@
**Supported Platforms:** **Supported Platforms:**
- **Linux**: Ubuntu 20.04+, Debian 11+, Linux Mint 20+ (x86_64, sudo access) - **Linux**: Ubuntu 20.04+, Debian 11+, Linux Mint 20+ (x86_64, sudo access)
- **macOS**: 11.0+ Big Sur, Intel/Apple Silicon (admin access, auto-installs Docker Desktop)
- **Windows**: 10/11 with WSL2 + Ubuntu 20.04+ (limited testing, requires Docker Desktop)
[View detailed installation guides →](INSTALLATION.md) [View detailed installation guides →](INSTALLATION.md)
@@ -61,12 +47,12 @@
```bash ```bash
# 1. Download HOPS # 1. Download HOPS
git clone https://github.com/skiercm/hops.git git clone https://git.canadabot.net/canadabot/hops.git
cd hops cd hops
chmod +x hops install uninstall setup chmod +x hops install uninstall
# 2. Run installation # 2. Run installation
sudo ./setup sudo ./hops
# 3. Follow interactive setup to select services # 3. Follow interactive setup to select services
@@ -76,8 +62,8 @@ sudo ./setup
**Directory Structure:** **Directory Structure:**
- `~/hops/` - Main deployment (docker-compose.yml, .env, logs) - `~/hops/` - Main deployment (docker-compose.yml, .env, logs)
- `/opt/appdata/` (Linux) or `~/hops/config/` (macOS) - App configs - `/opt/appdata/` - App configs
- `/mnt/media/` (Linux) or `~/hops/media/` (macOS) - Media storage - `/mnt/media/` - Media storage
## 🎛️ Management ## 🎛️ Management
@@ -90,19 +76,13 @@ 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
# Service operations (no sudo required)
./user-operations status # View service status
./user-operations logs <service> # View logs
./user-operations deploy # Deploy services
./user-operations stop # Stop all services
``` ```
[View advanced configuration and troubleshooting →](ADVANCED.md) [View advanced configuration and troubleshooting →](ADVANCED.md)
## 📞 Support ## 📞 Support
**HOPS Issues**: [GitHub Issues](https://github.com/skiercm/hops/issues) | [Discussions](https://github.com/skiercm/hops/discussions) **HOPS Issues**: [Gitea Issues](https://git.canadabot.net/canadabot/hops/issues)
**Service Issues**: Contact individual service developers (links in [SERVICES.md](SERVICES.md)) **Service Issues**: Contact individual service developers (links in [SERVICES.md](SERVICES.md))
@@ -111,7 +91,7 @@ sudo ./hops --check-updates # Check for updates
## 📄 Documentation ## 📄 Documentation
- [INSTALLATION.md](INSTALLATION.md) - Detailed installation guides for all platforms - [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