56 lines
1.4 KiB
Markdown
56 lines
1.4 KiB
Markdown
# 📚 Documentation
|
|
|
|
Welcome to the Charon documentation!
|
|
|
|
---
|
|
|
|
## 📖 Start Here
|
|
|
|
| Guide | Description |
|
|
|-------|-------------|
|
|
| [✨ Features](features.md) | See everything Charon can do |
|
|
| [🚀 Getting Started](getting-started.md) | Your first proxy in 5 minutes |
|
|
| [📥 Import Guide](import-guide.md) | Migrate from Caddy or NPM |
|
|
|
|
---
|
|
|
|
## 🔒 Security
|
|
|
|
| Guide | Description |
|
|
|-------|-------------|
|
|
| [Security Features](security.md) | CrowdSec, WAF, ACLs, and rate limiting |
|
|
| [ACME Staging](acme-staging.md) | Test SSL certificates without rate limits |
|
|
|
|
---
|
|
|
|
## 🔧 Reference
|
|
|
|
| Guide | Description |
|
|
|-------|-------------|
|
|
| [API Documentation](api.md) | REST API endpoints and examples |
|
|
| [Database Schema](database-schema.md) | How data is stored |
|
|
|
|
---
|
|
|
|
## 🛠️ Development
|
|
|
|
| Guide | Description |
|
|
|-------|-------------|
|
|
| [Contributing](https://github.com/Wikid82/charon/blob/main/CONTRIBUTING.md) | How to help improve Charon |
|
|
| [Debugging Guide](debugging-local-container.md) | Troubleshooting containers |
|
|
| [GitHub Setup](github-setup.md) | CI/CD and deployment |
|
|
|
|
---
|
|
|
|
## 🆘 Getting Help
|
|
|
|
- **💬 Questions?** [Start a Discussion](https://github.com/Wikid82/charon/discussions)
|
|
- **🐛 Found a Bug?** [Open an Issue](https://github.com/Wikid82/charon/issues)
|
|
- **📋 Roadmap** [Project Board](https://github.com/users/Wikid82/projects/7)
|
|
|
|
---
|
|
|
|
<p align="center">
|
|
<strong>Made with ❤️ for the community</strong>
|
|
</p>
|