README
¶
Backend Service
This folder contains the Go API for CaddyProxyManager+.
Prerequisites
- Go 1.24+
Getting started
cp .env.example .env # optional
cd backend
go run ./cmd/api
Tests
cd backend
go test ./...
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
api
command
Package main is the entry point for the Charon backend API.
|
Package main is the entry point for the Charon backend API. |
|
seed
command
|
|
|
Package integration contains end-to-end integration tests.
|
Package integration contains end-to-end integration tests. |
|
internal
|
|
|
api/handlers
Package handlers provides HTTP request handlers for the API.
|
Package handlers provides HTTP request handlers for the API. |
|
api/middleware
Package middleware provides Gin middleware for the Charon backend API.
|
Package middleware provides Gin middleware for the Charon backend API. |
|
api/routes
Package routes defines the API route registration and wiring.
|
Package routes defines the API route registration and wiring. |
|
caddy
Package caddy provides a client and manager for interacting with the Caddy Admin API.
|
Package caddy provides a client and manager for interacting with the Caddy Admin API. |
|
cerberus
Package cerberus provides lightweight security checks (WAF, ACL, CrowdSec) with notification support.
|
Package cerberus provides lightweight security checks (WAF, ACL, CrowdSec) with notification support. |
|
config
Package config handles configuration loading and validation.
|
Package config handles configuration loading and validation. |
|
crowdsec
Package crowdsec provides integration with CrowdSec for security decisions and remediation.
|
Package crowdsec provides integration with CrowdSec for security decisions and remediation. |
|
database
Package database handles database connections and migrations.
|
Package database handles database connections and migrations. |
|
logger
Package logger provides logging functionality with broadcast capabilities for real-time log streaming.
|
Package logger provides logging functionality with broadcast capabilities for real-time log streaming. |
|
metrics
Package metrics provides Prometheus metrics collectors for the application.
|
Package metrics provides Prometheus metrics collectors for the application. |
|
models
Package models defines the data types used throughout the application.
|
Package models defines the data types used throughout the application. |
|
server
Package server provides the HTTP server and router configuration.
|
Package server provides the HTTP server and router configuration. |
|
services
Package services provides the core application services used across the backend.
|
Package services provides the core application services used across the backend. |
|
util
Package util provides utility functions used across the application.
|
Package util provides utility functions used across the application. |
|
version
Package version provides build version information.
|
Package version provides build version information. |
Click to show internal directories.
Click to hide internal directories.