docs: add features.md, restructure docs, simplify README as marketing page
This commit is contained in:
Wikid82
+29
-120
@@ -1,146 +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.md) | See everything CPMP can do |
|
||||
| [🚀 Getting Started](getting-started.md) | Your first proxy in 5 minutes |
|
||||
| [📥 Import Guide](import-guide.md) | 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.md) | CrowdSec, WAF, ACLs, and rate limiting |
|
||||
| [ACME Staging](acme-staging.md) | 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
|
||||
|
||||
#### [🔒 Security Features](security.md)
|
||||
Learn about the advanced security integrations available in CPM+.
|
||||
|
||||
**What you'll learn:**
|
||||
- CrowdSec intrusion prevention setup
|
||||
- Web Application Firewall (WAF) with Coraza
|
||||
- **Access Control Lists (ACLs)** - IP and geo-blocking
|
||||
- Rate limiting configuration
|
||||
- Best practices by service type
|
||||
|
||||
#### [🐛 Debugging Local Containers](debugging-local-container.md)
|
||||
Troubleshooting guide for development and testing.
|
||||
|
||||
**What you'll learn:**
|
||||
- How to debug the Docker container
|
||||
- Inspecting logs and config
|
||||
- Testing Caddy configuration
|
||||
|
||||
#### [🔐 ACME Staging Environment](acme-staging.md)
|
||||
Guide for testing SSL certificate provisioning without hitting rate limits.
|
||||
|
||||
**What you'll learn:**
|
||||
- Using Let's Encrypt staging server
|
||||
- Testing certificate workflows
|
||||
- Switching between staging and production
|
||||
| Guide | Description |
|
||||
|-------|-------------|
|
||||
| [API Documentation](api.md) | REST API endpoints and examples |
|
||||
| [Database Schema](database-schema.md) | 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](../CONTRIBUTING.md) | How to help improve CPMP |
|
||||
| [Debugging Guide](debugging-local-container.md) | Troubleshooting containers |
|
||||
| [GitHub Setup](github-setup.md) | 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!
|
||||
- [🏠 Getting Started](getting-started.md) - *Coming soon!*
|
||||
- [📥 Import Guide](import-guide.md) - Bring in existing configs
|
||||
- [🔒 Security Features](security.md) - CrowdSec, WAF, ACLs, Rate Limiting
|
||||
|
||||
### Developer Documentation
|
||||
- [🔌 API Reference](api.md) - REST API endpoints
|
||||
- [💾 Database Schema](database-schema.md) - How data is stored
|
||||
- [🐛 Debugging Guide](debugging-local-container.md) - Troubleshooting containers
|
||||
- [🔐 ACME Staging](acme-staging.md) - SSL certificate testing
|
||||
- [✨ 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/CaddyProxyManagerPlus/discussions)
|
||||
- **🐛 Found a Bug?** [Open an Issue](https://github.com/Wikid82/CaddyProxyManagerPlus/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