Merge pull request #253 from Wikid82/main
Propagate changes from main into development
This commit is contained in:
Jeremy
GitHub
171
docs/features.md
Normal file
171
docs/features.md
Normal file
@@ -0,0 +1,171 @@
|
||||
# ✨ Features
|
||||
|
||||
Caddy Proxy Manager+ (CPMP) is packed with features to make managing your web services simple and secure. Here's everything you can do:
|
||||
|
||||
---
|
||||
|
||||
## 🔒 Security
|
||||
|
||||
### CrowdSec Integration
|
||||
Block malicious IPs automatically using community-driven threat intelligence. CrowdSec analyzes your logs and blocks attackers before they can cause harm.
|
||||
→ [Learn more about CrowdSec](https://www.crowdsec.net/)
|
||||
|
||||
### Web Application Firewall (WAF)
|
||||
Protect your applications from common web attacks like SQL injection and cross-site scripting using Coraza WAF, an enterprise-grade firewall built into Caddy.
|
||||
→ [Learn more about Coraza WAF](https://coraza.io/)
|
||||
|
||||
### Access Control Lists (ACLs)
|
||||
Control who can access your services with IP whitelists, blacklists, and geo-blocking. Block entire countries or allow only specific networks.
|
||||
→ [ACL Documentation](security.md#access-control-lists)
|
||||
|
||||
### Rate Limiting
|
||||
Prevent abuse by limiting how many requests a single IP can make. Protect against brute force attacks and API abuse.
|
||||
→ [Rate Limiting Setup](security.md#rate-limiting)
|
||||
|
||||
### Automatic HTTPS
|
||||
Every site gets a free SSL certificate automatically. No configuration needed—just add your domain and it's secure.
|
||||
→ [SSL/TLS Configuration](security.md#ssltls-certificates)
|
||||
|
||||
---
|
||||
|
||||
## 📊 Monitoring
|
||||
|
||||
### Built-in Uptime Monitor
|
||||
Know instantly when your services go down. Get notifications via Discord, Slack, email, or webhooks when something isn't responding.
|
||||
→ [Uptime Monitoring Guide](uptime.html) *(coming soon)*
|
||||
|
||||
### Real-time Health Dashboard
|
||||
See the status of all your services at a glance. View response times, uptime history, and current availability from one dashboard.
|
||||
|
||||
### Smart Notifications
|
||||
Get notified only when it matters. Notifications are grouped by server so you don't get spammed when a whole host goes down.
|
||||
|
||||
---
|
||||
|
||||
## 🖥️ Proxy Management
|
||||
|
||||
### Visual Proxy Configuration
|
||||
Add and manage reverse proxies without touching configuration files. Point-and-click simplicity with full power under the hood.
|
||||
|
||||
### Multi-Domain Support
|
||||
Host unlimited domains from a single server. Each domain can point to a different backend service.
|
||||
|
||||
### WebSocket Support
|
||||
Real-time apps like chat, gaming, and live updates work out of the box. WebSocket connections are automatically upgraded.
|
||||
|
||||
### Load Balancing
|
||||
Distribute traffic across multiple backend servers. Keep your services fast and reliable even under heavy load.
|
||||
|
||||
### Custom Headers
|
||||
Add, modify, or remove HTTP headers as traffic passes through. Perfect for CORS, security headers, or custom routing logic.
|
||||
|
||||
---
|
||||
|
||||
## 🐳 Docker Integration
|
||||
|
||||
### Container Discovery
|
||||
See all Docker containers running on your servers. One click to create a proxy for any container.
|
||||
|
||||
### Remote Docker Support
|
||||
Manage containers on other servers through secure connections. Perfect for multi-server setups with Tailscale or WireGuard VPNs.
|
||||
→ [Remote Docker Setup](getting-started.md#remote-docker)
|
||||
|
||||
### Automatic Port Detection
|
||||
CPMP reads container labels and exposed ports automatically. Less typing, fewer mistakes.
|
||||
|
||||
---
|
||||
|
||||
## 📥 Import & Migration
|
||||
|
||||
### Caddyfile Import
|
||||
Already using Caddy? Import your existing Caddyfile and CPMP will create proxies for each site automatically.
|
||||
→ [Import Guide](import-guide.html)
|
||||
|
||||
### NPM Migration *(coming soon)*
|
||||
Migrating from Nginx Proxy Manager? We'll import your configuration so you don't start from scratch.
|
||||
|
||||
### Conflict Resolution
|
||||
When imports find existing entries, you choose what to do—keep existing, overwrite, or merge configurations.
|
||||
|
||||
---
|
||||
|
||||
## 💾 Backup & Restore
|
||||
|
||||
### Automatic Backups
|
||||
Your configuration is automatically backed up before destructive operations like deletes.
|
||||
|
||||
### One-Click Restore
|
||||
Something go wrong? Restore any previous configuration with a single click.
|
||||
|
||||
### Export Configuration
|
||||
Download your entire configuration for safekeeping or migration to another server.
|
||||
|
||||
---
|
||||
|
||||
## 🎨 User Experience
|
||||
|
||||
### Dark Mode Interface
|
||||
Easy on the eyes during late-night troubleshooting. The modern dark interface looks great on any device.
|
||||
|
||||
### Mobile Responsive
|
||||
Manage your proxies from your phone or tablet. The interface adapts to any screen size.
|
||||
|
||||
### Bulk Operations
|
||||
Select multiple items and perform actions on all of them at once. Delete, enable, or disable in bulk.
|
||||
|
||||
### Search & Filter
|
||||
Find what you're looking for quickly. Filter by status, search by name, or sort by any column.
|
||||
|
||||
---
|
||||
|
||||
## 🔌 API & Automation
|
||||
|
||||
### RESTful API
|
||||
Automate everything through a complete REST API. Create proxies, manage certificates, and monitor uptime programmatically.
|
||||
→ [API Documentation](api.html)
|
||||
|
||||
### Webhook Notifications
|
||||
Send events to any system that accepts webhooks. Integrate with your existing monitoring and automation tools.
|
||||
|
||||
---
|
||||
|
||||
## 🛡️ Enterprise Features
|
||||
|
||||
### Multi-User Support *(coming soon)*
|
||||
Add team members with different permission levels. Admins, editors, and viewers.
|
||||
|
||||
### Audit Logging *(coming soon)*
|
||||
Track who changed what and when. Full history of all configuration changes.
|
||||
|
||||
### SSO Integration *(coming soon)*
|
||||
Sign in with your existing identity provider. Support for OAuth, SAML, and OIDC.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Performance
|
||||
|
||||
### Caddy-Powered
|
||||
Built on Caddy, one of the fastest and most memory-efficient web servers available.
|
||||
|
||||
### Minimal Resource Usage
|
||||
Runs happily on a Raspberry Pi. Low CPU and memory footprint.
|
||||
|
||||
### Instant Configuration Reloads
|
||||
Changes take effect immediately without downtime. Zero-downtime configuration updates.
|
||||
|
||||
---
|
||||
|
||||
## 📚 Need More Details?
|
||||
|
||||
Each feature has detailed documentation:
|
||||
|
||||
- [Getting Started](getting-started.html) - Your first proxy in 5 minutes
|
||||
- [Security Features](security.html) - Deep dive into security options
|
||||
- [API Reference](api.html) - Complete API documentation
|
||||
- [Import Guide](import-guide.html) - Migrating from other tools
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<em>Missing a feature? <a href="https://github.com/Wikid82/cpmp/discussions">Let us know!</a></em>
|
||||
</p>
|
||||
@@ -161,7 +161,7 @@ It's a **text file that tells Caddy how to route traffic**. If you're not sure i
|
||||
|
||||
Done! Your existing setup is now in the app.
|
||||
|
||||
> **Need more help?** Check the detailed [Import Guide](import-guide.md)
|
||||
> **Need more help?** Check the detailed [Import Guide](import-guide.html)
|
||||
|
||||
---
|
||||
|
||||
@@ -265,9 +265,9 @@ You now know the basics! Here's what to explore:
|
||||
|
||||
We're here for you!
|
||||
|
||||
- 💬 [Ask on GitHub Discussions](https://github.com/Wikid82/CaddyProxyManagerPlus/discussions)
|
||||
- 🐛 [Report a Bug](https://github.com/Wikid82/CaddyProxyManagerPlus/issues)
|
||||
- 📖 [Read the Full Documentation](index.md)
|
||||
- 💬 [Ask on GitHub Discussions](https://github.com/Wikid82/cpmp/discussions)
|
||||
- 🐛 [Report a Bug](https://github.com/Wikid82/cpmp/issues)
|
||||
- 📖 [Read the Full Documentation](index.html)
|
||||
|
||||
---
|
||||
|
||||
|
||||
120
docs/index.md
120
docs/index.md
@@ -1,117 +1,55 @@
|
||||
# 📚 Caddy Proxy Manager Plus - Documentation
|
||||
# 📚 Documentation
|
||||
|
||||
Welcome! 👋 This page will help you find exactly what you need to use Caddy Proxy Manager Plus.
|
||||
Welcome to the Caddy Proxy Manager Plus documentation!
|
||||
|
||||
---
|
||||
|
||||
## 🚀 I'm New Here - Where Do I Start?
|
||||
## 📖 Start Here
|
||||
|
||||
Start with the [**README**](../README.md) - it's like the front door of our project! It will show you:
|
||||
- What this app does (in simple terms!)
|
||||
- How to install it on your computer
|
||||
- How to get it running in 5 minutes
|
||||
|
||||
**Next Step:** Once you have it running, check out the guides below!
|
||||
| Guide | Description |
|
||||
|-------|-------------|
|
||||
| [✨ Features](features.html) | See everything CPMP can do |
|
||||
| [🚀 Getting Started](getting-started.html) | Your first proxy in 5 minutes |
|
||||
| [📥 Import Guide](import-guide.html) | Migrate from Caddy or NPM |
|
||||
|
||||
---
|
||||
|
||||
## 📖 How-To Guides
|
||||
## 🔒 Security
|
||||
|
||||
### For Everyone
|
||||
|
||||
#### [🏠 Getting Started Guide](getting-started.md)
|
||||
*Coming soon!* - A step-by-step walkthrough of your first proxy setup. We'll hold your hand through the whole process!
|
||||
|
||||
#### [📥 Import Your Caddy Files](import-guide.md)
|
||||
Already have Caddy configuration files? This guide shows you how to bring them into the app so you don't have to start from scratch.
|
||||
|
||||
**What you'll learn:**
|
||||
- How to upload your existing files (it's just drag-and-drop!)
|
||||
- What to do if the app finds conflicts
|
||||
- Tips to make importing super smooth
|
||||
| Guide | Description |
|
||||
|-------|-------------|
|
||||
| [Security Features](security.html) | CrowdSec, WAF, ACLs, and rate limiting |
|
||||
| [ACME Staging](acme-staging.html) | Test SSL certificates without rate limits |
|
||||
|
||||
---
|
||||
|
||||
### For Developers & Advanced Users
|
||||
## 🔧 Reference
|
||||
|
||||
#### [🔌 API Documentation](api.md)
|
||||
Want to talk to the app using code? This guide shows all the ways you can send and receive information from the app.
|
||||
|
||||
**What you'll learn:**
|
||||
- All the different commands you can send
|
||||
- Examples in JavaScript and Python
|
||||
- What responses to expect
|
||||
|
||||
#### [💾 Database Guide](database-schema.md)
|
||||
Curious about how the app stores your information? This guide explains the database structure.
|
||||
|
||||
**What you'll learn:**
|
||||
- What information we save
|
||||
- How everything connects together
|
||||
- Tips for backing up your data
|
||||
| Guide | Description |
|
||||
|-------|-------------|
|
||||
| [API Documentation](api.html) | REST API endpoints and examples |
|
||||
| [Database Schema](database-schema.html) | How data is stored |
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Want to Help Make This Better?
|
||||
## 🛠️ Development
|
||||
|
||||
#### [✨ Contributing Guide](../CONTRIBUTING.md)
|
||||
We'd love your help! This guide shows you how to:
|
||||
- Report bugs (things that don't work right)
|
||||
- Suggest new features
|
||||
- Submit code improvements
|
||||
- Follow our project rules
|
||||
| Guide | Description |
|
||||
|-------|-------------|
|
||||
| [Contributing](https://github.com/Wikid82/cpmp/blob/main/CONTRIBUTING.md) | How to help improve CPMP |
|
||||
| [Debugging Guide](debugging-local-container.html) | Troubleshooting containers |
|
||||
| [GitHub Setup](github-setup.html) | CI/CD and deployment |
|
||||
|
||||
---
|
||||
|
||||
## 🆘 Need Help?
|
||||
## 🆘 Getting Help
|
||||
|
||||
### Quick Troubleshooting
|
||||
|
||||
**Can't get it to run?**
|
||||
- Check the [Installation section in README](../README.md#-installation)
|
||||
- Make sure Docker is installed and running
|
||||
- Try the quick start commands exactly as written
|
||||
|
||||
**Having import problems?**
|
||||
- See the [Import Guide troubleshooting section](import-guide.md#troubleshooting)
|
||||
- Check your Caddy file is valid
|
||||
- Look at the example files in the guide
|
||||
|
||||
**Found a bug?**
|
||||
- [Open an issue on GitHub](https://github.com/Wikid82/CaddyProxyManagerPlus/issues)
|
||||
- Tell us what you were trying to do
|
||||
- Share any error messages you see
|
||||
|
||||
---
|
||||
|
||||
## 📚 All Documentation Files
|
||||
|
||||
### User Documentation
|
||||
- [📖 README](../README.md) - Start here!
|
||||
- [📥 Import Guide](import-guide.md) - Bring in existing configs
|
||||
- [🏠 Getting Started](getting-started.md) - *Coming soon!*
|
||||
|
||||
### Developer Documentation
|
||||
- [🔌 API Reference](api.md) - REST API endpoints
|
||||
- [💾 Database Schema](database-schema.md) - How data is stored
|
||||
- [✨ Contributing](../CONTRIBUTING.md) - Help make this better
|
||||
- [🔧 GitHub Setup](github-setup.md) - Set up Docker builds & docs deployment
|
||||
|
||||
### Project Information
|
||||
- [📄 LICENSE](../LICENSE) - Legal stuff (MIT License)
|
||||
- [🔖 Changelog](../CHANGELOG.md) - *Coming soon!* - What's new in each version
|
||||
|
||||
---
|
||||
|
||||
## 💡 Quick Links
|
||||
|
||||
- [🏠 Project Home](https://github.com/Wikid82/CaddyProxyManagerPlus)
|
||||
- [🐛 Report a Bug](https://github.com/Wikid82/CaddyProxyManagerPlus/issues/new)
|
||||
- [💬 Ask a Question](https://github.com/Wikid82/CaddyProxyManagerPlus/discussions)
|
||||
- **💬 Questions?** [Start a Discussion](https://github.com/Wikid82/cpmp/discussions)
|
||||
- **🐛 Found a Bug?** [Open an Issue](https://github.com/Wikid82/cpmp/issues)
|
||||
- **📋 Roadmap** [Project Board](https://github.com/users/Wikid82/projects/7)
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<strong>Made with ❤️ for the community</strong><br>
|
||||
<em>Questions? Open an issue - we're here to help!</em>
|
||||
<strong>Made with ❤️ for the community</strong>
|
||||
</p>
|
||||
|
||||
Reference in New Issue
Block a user