Files
KonCad/README.md
T
Daniel e9035bf6fe
Publish Docker image / build (push) Failing after 6s
Improve Caddyfile editor for demo-style configs
2026-05-03 18:59:32 +02:00

87 lines
3.1 KiB
Markdown

# KonCad
Web UI for managing an existing dockerized [Caddy](https://caddyserver.com/) instance. Parses the Caddyfile into structured sections — global options and per-site blocks — so you don't have to edit raw config files.
## Features
- **Structured editor** — separate panels for global options and each site block
- **Raw editor** — optional full Caddyfile editing escape hatch for advanced changes
- **Admin API check** — blocks editing if Caddy's admin API is unreachable on load
- **Upstream reachability check** — warns before deploy if any `reverse_proxy` target is unreachable, with option to deploy anyway
- **Atomic deploy** — posts config to Caddy's `/load` endpoint; bad configs are rejected without disrupting the running instance
## Requirements
- Docker + Docker Compose
- An existing Caddy container with the admin API enabled (`admin :2019` in global options)
- Both containers on the same Docker network
## Setup
### 1. Create a `docker-compose.yml`
```yaml
services:
koncad:
image: git.d4nn13.de/d4nn13/koncad:latest
restart: unless-stopped
volumes:
- koncad_data:/data
- /opt/caddy:/caddy:ro
environment:
# Caddy admin API reachable on the shared Docker network.
CADDY_ADMIN_URL: http://caddy:2019
# Read-only source Caddyfile from your existing Caddy setup.
CADDYFILE_IMPORT: /caddy/Caddyfile
networks:
# Join the same external Docker network as your Caddy container.
- caddy-network
volumes:
koncad_data:
networks:
caddy-network:
# Use the pre-existing network your Caddy container already uses.
external: true
```
Adjust to match your environment:
| Setting | Description |
|---|---|
| `CADDY_ADMIN_URL` | URL of Caddy's admin API — use the container name as hostname |
| `CADDYFILE_IMPORT` | Path to your existing Caddyfile (read-only, always used as source of truth — external edits are reflected on every page load) |
| `- /opt/caddy:/caddy:ro` | Adjust to wherever your Caddy config directory lives |
| `caddy-network` | Replace with your existing Caddy Docker network name |
### 2. Start
```bash
docker compose up -d
```
### Updating
```bash
docker compose pull && docker compose up -d
```
Expose KonCad through your existing Caddy setup on the shared Docker network.
On first load it imports your existing Caddyfile (read-only). After the first deploy, KonCad manages its own copy.
## Usage
| Action | Description |
|--------|-------------|
| **Global Options** panel | Edit top-level Caddy options (email, logging, etc.) |
| **Raw Caddyfile** mode | Edit the full Caddyfile directly; deploy still uses Caddy's admin API, so no restart is required |
| **+ Add Site** | Creates a new site block |
| **Remove** (per site) | Deletes that site block |
| **Deploy** | Validates and applies config via Caddy's `/load` API; shows errors inline if rejected |
If any `reverse_proxy` upstream is unreachable at deploy time, a warning modal lists them — you can cancel or deploy anyway.
Switching from raw mode back to structured mode reparses the file, so comments and exact formatting may be normalized.