akanealw
eec8c28fb3
Some checks are pending
Go Benchmark / Performance Regression Check (push) Waiting to run
Cerberus Integration / Cerberus Security Stack Integration (push) Waiting to run
Upload Coverage to Codecov / Backend Codecov Upload (push) Waiting to run
Upload Coverage to Codecov / Frontend Codecov Upload (push) Waiting to run
CodeQL - Analyze / CodeQL analysis (go) (push) Waiting to run
CodeQL - Analyze / CodeQL analysis (javascript-typescript) (push) Waiting to run
CrowdSec Integration / CrowdSec Bouncer Integration (push) Waiting to run
Docker Build, Publish & Test / build-and-push (push) Waiting to run
Docker Build, Publish & Test / Security Scan PR Image (push) Blocked by required conditions
Quality Checks / Auth Route Protection Contract (push) Waiting to run
Quality Checks / Codecov Trigger/Comment Parity Guard (push) Waiting to run
Quality Checks / Backend (Go) (push) Waiting to run
Quality Checks / Frontend (React) (push) Waiting to run
Rate Limit integration / Rate Limiting Integration (push) Waiting to run
Security Scan (PR) / Trivy Binary Scan (push) Waiting to run
Supply Chain Verification (PR) / Verify Supply Chain (push) Waiting to run
WAF integration / Coraza WAF Integration (push) Waiting to run
45 lines
1.5 KiB
Markdown
Executable File
45 lines
1.5 KiB
Markdown
Executable File
---
|
||
title: Welcome to Charon
|
||
description: Charon documentation home. A modern, user-friendly reverse proxy manager built on Caddy.
|
||
---
|
||
|
||
## Welcome to Charon
|
||
|
||
**You're in the right place.** These guides explain everything in plain English, no technical jargon.
|
||
|
||
---
|
||
|
||
## 🎯 Start Here
|
||
|
||
**[🚀 Getting Started](getting-started.md)** — Get your first website running in 5 minutes
|
||
**[✨ What Can It Do?](features.md)** — See everything Charon can do for you
|
||
**[📥 Import Your Old Setup](import-guide.md)** — Bring your existing Caddy configs
|
||
|
||
---
|
||
|
||
## <20>️ Security (Optional)
|
||
|
||
**[Security Features](security.md)** — Block bad guys, bad countries, or bad behavior
|
||
**[Live Logs & Notifications](live-logs-guide.md)** — Real-time security monitoring and alerts
|
||
**[Testing SSL Certificates](acme-staging.md)** — Practice without hitting limits
|
||
**[Migration Guide](migration-guide.md)** — Upgrade from environment variable to GUI control
|
||
|
||
---
|
||
|
||
## <20> For Developers
|
||
|
||
**[API Reference](api.md)** — Control Charon with code
|
||
**[Database Schema](database-schema.md)** — How everything is stored
|
||
|
||
---
|
||
|
||
## ❓ Need Help?
|
||
|
||
**[💬 Ask a Question](https://github.com/Wikid82/charon/discussions)** — No question is too basic
|
||
**[🐛 Report a Bug](https://github.com/Wikid82/charon/issues)** — Something not working?
|
||
**[📋 Roadmap](https://github.com/users/Wikid82/projects/7)** — See what's coming next
|
||
|
||
---
|
||
|
||
<p align="center"><em>Everything here is written for humans, not robots.</em></p>
|