fix: update README to reflect project name change and improve clarity

2025-11-28 15:17:41 -05:00
parent 7f85fd8ecd
commit 7030d3d9d3
1 changed files with 57 additions and 16 deletions
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
 <p align="center">
-  <img src="frontend/public/banner.png" alt="Caddy Proxy Manager+" width="600">
+  <img src="frontend/public/banner.png" alt="Charon" width="600">
 </p>

-<h1 align="center">Caddy Proxy Manager+</h1>
+<h1 align="center">Charon</h1>

 <p align="center">
  <strong>The friendly way to manage your reverse proxy</strong><br>
@@ -11,8 +11,8 @@

 <p align="center">
  <a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a>
-  <a href="https://github.com/Wikid82/cpmp/releases"><img src="https://img.shields.io/github/v/release/Wikid82/cpmp?include_prereleases" alt="Release"></a>
-  <a href="https://github.com/Wikid82/cpmp/actions"><img src="https://img.shields.io/github/actions/workflow/status/Wikid82/cpmp/docker-publish.yml" alt="Build Status"></a>
+  <a href="https://github.com/Wikid82/charon/releases"><img src="https://img.shields.io/github/v/release/Wikid82/charon?include_prereleases" alt="Release"></a>
+  <a href="https://github.com/Wikid82/charon/actions"><img src="https://img.shields.io/github/actions/workflow/status/Wikid82/charon/docker-publish.yml" alt="Build Status"></a>
 </p>

 ---
@@ -23,7 +23,7 @@
 |---------|-------------|
 | 🎨 **Beautiful Dark UI** | Modern interface that's easy on the eyes, works on any device |
 | 🔐 **Automatic HTTPS** | Free SSL certificates from Let's Encrypt, auto-renewed |
-| 🛡️ **Built-in Security** | CrowdSec integration, geo-blocking, IP access lists |
+| 🛡️ **Built-in Security** | CrowdSec integration, geo-blocking, IP access lists (optional, powered by Cerberus) |
 | 📊 **Uptime Monitoring** | Know when your services go down with smart notifications |
 | 🐳 **Docker Discovery** | Auto-detect containers on local and remote Docker hosts |
 | 📥 **Easy Import** | Bring your existing Caddy or NPM configs with one click |
@@ -32,29 +32,69 @@
 | 🌐 **WebSocket Support** | Perfect for real-time apps and chat services |
 | ⚡ **Zero Downtime** | Hot-reload configuration without restarts |

-**[See all features →](https://wikid82.github.io/cpmp/docs/features.html)**
+**[See all features →](https://wikid82.github.io/charon/features)**

 ---

 ## 🚀 Quick Start

 ```bash
-# Clone and start
-git clone https://github.com/Wikid82/cpmp.git
-cd cpmp
-docker compose up -d
+services:
+  charon:
+    image: ghcr.io/wikid82/charon:latest
+    container_name: charon
+    restart: unless-stopped
+    ports:
+      - "80:80"        # HTTP (Caddy proxy)
+      - "443:443"      # HTTPS (Caddy proxy)
+      - "443:443/udp"  # HTTP/3 (Caddy proxy)
+      - "8080:8080"    # Management UI (Charon)
+    environment:
+      - CHARON_ENV=production # New env var prefix (CHARON_). CPM_ values still supported.
+      - TZ=UTC # Set timezone (e.g., America/New_York)
+      - CHARON_HTTP_PORT=8080
+      - CHARON_DB_PATH=/app/data/charon.db
+      - CHARON_FRONTEND_DIR=/app/frontend/dist
+      - CHARON_CADDY_ADMIN_API=http://localhost:2019
+      - CHARON_CADDY_CONFIG_DIR=/app/data/caddy
+      - CHARON_CADDY_BINARY=caddy
+      - CHARON_IMPORT_CADDYFILE=/import/Caddyfile
+      - CHARON_IMPORT_DIR=/app/data/imports
+      # Security Services (Optional)
+      #- CERBERUS_SECURITY_CROWDSEC_MODE=disabled # disabled, local, external
+      #- CERBERUS_SECURITY_CROWDSEC_API_URL= # Required if mode is external
+      #- CERBERUS_SECURITY_CROWDSEC_API_KEY= # Required if mode is external
+      #- CERBERUS_SECURITY_WAF_MODE=disabled # disabled, enabled
+      #- CERBERUS_SECURITY_RATELIMIT_ENABLED=false
+      #- CERBERUS_SECURITY_ACL_ENABLED=false
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+    volumes:
+      - <path_to_charon_data>:/app/data
+      - <path_to_caddy_data>:/data
+      - <path_to_caddy_config>:/config
+      - /var/run/docker.sock:/var/run/docker.sock:ro # For local container discovery
+      # Mount your existing Caddyfile for automatic import (optional)
+      # - ./my-existing-Caddyfile:/import/Caddyfile:ro
+      # - ./sites:/import/sites:ro # If your Caddyfile imports other files
+    healthcheck:
+      test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://localhost:8080/api/v1/health"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 40s
 ```

 Open **http://localhost:8080** — that's it! 🎉

-**[Full documentation →](https://wikid82.github.io/cpmp/docs/index.html)**
+**[Full documentation →](https://wikid82.github.io/charon/)**

 ---

 ## 💬 Community

- 🐛 **Found a bug?** [Open an issue](https://github.com/Wikid82/cpmp/issues)
- 💡 **Have an idea?** [Start a discussion](https://github.com/Wikid82/cpmp/discussions)
+- 🐛 **Found a bug?** [Open an issue](https://github.com/Wikid82/charon/issues)
+- 💡 **Have an idea?** [Start a discussion](https://github.com/Wikid82/charon/discussions)
 - 📋 **Roadmap** [View the project board](https://github.com/users/Wikid82/projects/7)

 ## 🤝 Contributing
@@ -65,11 +105,12 @@ We welcome contributions! See our [Contributing Guide](CONTRIBUTING.md) to get s

 <p align="center">
  <a href="LICENSE"><strong>MIT License</strong></a> ·
-  <a href="https://wikid82.github.io/cpmp/docs/index.html"><strong>Documentation</strong></a> ·
-  <a href="https://github.com/Wikid82/cpmp/releases"><strong>Releases</strong></a>
+  <a href="https://wikid82.github.io/charon/"><strong>Documentation</strong></a> ·
+  <a href="https://github.com/Wikid82/charon/releases"><strong>Releases</strong></a>
 </p>

 <p align="center">
  <em>Built with ❤️ by <a href="https://github.com/Wikid82">@Wikid82</a></em><br>
-  <sub>Powered by <a href="https://caddyserver.com/">Caddy Server</a> · Inspired by <a href="https://nginxproxymanager.com/">Nginx Proxy Manager</a></sub>
+  <sub>Security Suite: Charon is powered by Cerberus — an optional security engine bundling WAF (Coraza), CrowdSec integrations, ACLs and rate-limiting.</sub>
+  <sub>Powered by <a href="https://caddyserver.com/">Caddy Server</a> · Inspired by <a href="https://nginxproxymanager.com/">Nginx Proxy Manager</a> & <a href="https://pangolin.net/">Pangolin</a></sub>
 </p>