Files

T

Wikid82 b17e7d3d5f feat: implement Caddy integration with Docker-first approach (Issue #4 )

- Add Caddy client package (client.go) with Load/GetConfig/Ping methods
- Implement config generator (config.go) transforming ProxyHost → Caddy JSON
- Add pre-flight validator (validator.go) catching config errors before reload
- Create manager (manager.go) with rollback capability using config snapshots
- Add CaddyConfig model for audit trail of configuration changes
- Update Config to include Caddy admin API and config dir settings
- Create comprehensive unit tests with 100% coverage for caddy package

Docker Infrastructure:
- Add docker-compose.yml with Caddy sidecar container
- Add docker-compose.dev.yml for development overrides
- Create .github/workflows/docker-publish.yml for GHCR publishing
- Update CI to build Docker images and run integration tests
- Add DOCKER.md with comprehensive deployment guide
- Update Makefile with docker-compose commands
- Update README with Docker-first deployment instructions

Configuration:
- Add CPM_CADDY_ADMIN_API and CPM_CADDY_CONFIG_DIR env vars
- Update .env.example with new Caddy settings
- Update AutoMigrate to include CaddyConfig model

All acceptance criteria met:
✅ Can programmatically generate valid Caddy JSON configs
✅ Can reload Caddy configuration via admin API
✅ Invalid configs caught by validator before reload
✅ Automatic rollback on failure via snapshot system

2025-11-17 19:03:59 -05:00

2.9 KiB

Raw Blame History

CaddyProxyManager+

CaddyProxyManager+ is a modern web UI and management layer that brings Nginx Proxy Manager-style simplicity to Caddy, with extra security add-ons (CrowdSec, WAF, SSO, etc.).

This repository now ships the first working slices of the Go backend and Vite/React frontend described in ARCHITECTURE_PLAN.md.

Quick links

Project board: https://github.com/users/Wikid82/projects/7
Issues: https://github.com/Wikid82/CaddyProxyManagerPlus/issues

Tech stack

Backend: Go 1.22, Gin, GORM, SQLite (configurable path via env vars)
Frontend: React 18 + TypeScript, Vite bundler, React Query, React Router
API: REST over /api/v1, currently exposes health + proxy host CRUD

See ARCHITECTURE_PLAN.md for the detailed rationale and roadmap for each tier.

Getting started

Prerequisites

Go 1.22+
Node.js 20+
SQLite3

Quick Start (using Makefile)

# Install all dependencies
make install

# Run tests
make test

# Run backend
make run

# Run frontend (in another terminal)
make run-frontend

# Or run both with tmux
make dev

Manual Setup

Backend API

cd backend
cp .env.example .env # optional overrides
go run ./cmd/api

Run tests:

cd backend
go test ./...

Frontend UI

cd frontend
npm install
npm run dev

The Vite dev server proxies /api/* to http://localhost:8080 so long as the backend is running locally.

Build for production:

cd frontend
npm run build

Docker Deployment (Recommended)

CaddyProxyManager+ is designed to run in Docker with Caddy as a sidecar container.

# Production deployment
docker-compose up -d

# Development mode (exposes Caddy admin API on :2019)
docker-compose -f docker-compose.yml -f docker-compose.dev.yml up

The docker-compose stack includes:

app: CaddyProxyManager+ management interface (:8080)
caddy: Caddy reverse proxy (:80, :443, :443/udp for HTTP/3)

Data is persisted in Docker volumes:

app_data: CPM+ database and config snapshots
caddy_data: Caddy certificates and data
caddy_config: Caddy configuration

Docker images are published to GitHub Container Registry:

# Latest stable (from main branch)
docker pull ghcr.io/wikid82/caddyproxymanagerplus:latest

# Development (from development branch)
docker pull ghcr.io/wikid82/caddyproxymanagerplus:development

# Specific version
docker pull ghcr.io/wikid82/caddyproxymanagerplus:v1.0.0

Tooling

Build system: Makefile provides common development tasks (make help for all commands)
Branching model: development is the integration branch; open PRs from feature/**
CI: .github/workflows/ci.yml runs Go tests, ESLint, and frontend builds
Docker: Multi-stage build with Node (frontend) → Go (backend) → Alpine runtime

Contributing

See CONTRIBUTING.md (coming soon) for contribution guidelines.

License

MIT License – see LICENSE.

2.9 KiB Raw Blame History Unescape Escape