Files
Charon/README.md

76 lines
2.7 KiB
Markdown

<p align="center">
<img src="frontend/public/banner.png" alt="Caddy Proxy Manager+" width="600">
</p>
<h1 align="center">Caddy Proxy Manager+</h1>
<p align="center">
<strong>The friendly way to manage your reverse proxy</strong><br>
Point, click, done. No config files needed.
</p>
<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>
</p>
---
## ✨ Top Features
| Feature | Description |
|---------|-------------|
| 🎨 **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 |
| 📊 **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 |
| 💾 **Backup & Restore** | Never lose your settings, export anytime |
| 🔍 **Health Checks** | Test connections before saving |
| 🌐 **WebSocket Support** | Perfect for real-time apps and chat services |
| ⚡ **Zero Downtime** | Hot-reload configuration without restarts |
**[See all features →](docs/features.md)**
---
## 🚀 Quick Start
```bash
# Clone and start
git clone https://github.com/Wikid82/cpmp.git
cd cpmp
docker compose up -d
```
Open **http://localhost:8080** — that's it! 🎉
**[Full documentation →](docs/index.md)**
---
## 💬 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)
- 📋 **Roadmap** [View the project board](https://github.com/users/Wikid82/projects/7)
## 🤝 Contributing
We welcome contributions! See our [Contributing Guide](CONTRIBUTING.md) to get started.
---
<p align="center">
<a href="LICENSE"><strong>MIT License</strong></a> ·
<a href="docs/index.md"><strong>Documentation</strong></a> ·
<a href="https://github.com/Wikid82/cpmp/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>
</p>