diff --git a/README.md b/README.md index 22de5ee7..35f1e938 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@

- Caddy Proxy Manager+ + Charon

-

Caddy Proxy Manager+

+

Charon

The friendly way to manage your reverse proxy
@@ -11,8 +11,8 @@

License: MIT - Release - Build Status + Release + Build Status

--- @@ -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: + - :/app/data + - :/data + - :/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

MIT License ยท - Documentation ยท - Releases + Documentation ยท + Releases

Built with โค๏ธ by @Wikid82
- Powered by Caddy Server ยท Inspired by Nginx Proxy Manager + Security Suite: Charon is powered by Cerberus โ€” an optional security engine bundling WAF (Coraza), CrowdSec integrations, ACLs and rate-limiting. + Powered by Caddy Server ยท Inspired by Nginx Proxy Manager & Pangolin