Home

Caddyman is a web interface for the routes of one Caddy server. It is built for home labs and small networks that issue their certificates from their own ACME CA, such as step-ca, and it also works with Caddy's defaults.

The README has the short version: requirements, installation and environment variables. This wiki explains each part of the interface.

How it works

• One file per route. Caddyman writes each route as a small Caddyfile into the sites directory that your base Caddyfile imports. These files are the only record of your routes; there is no database next to them.
• Every save reloads Caddy. Caddyman sends the configuration to Caddy's admin API right away. If Caddy refuses it, Caddyman puts the old file back, so a broken route never stays on disk.
• Your base Caddyfile stays yours. Caddyman reads it and points out what is missing on the status page, but never writes it. With the layout "Network only", Caddyman keeps a copy of it, which only you edit.
• Hand-written files are safe. A route file Caddyman cannot reproduce exactly opens as text and is never rewritten behind your back.

Pages

Page	What it covers
Installation	The two layouts, the first start, putting Caddyman behind HTTPS
Caddy settings	Admin API, snippets, DNS providers, disconnecting
Routes	Adding, editing, adopting, switching off and deleting routes
Route options	Hostnames, ports, TLS, access, target options, paths, error pages, HSTS, log
Route list	Groups, search, the Problems and To do filters, certificate status
Error pages	Designs and texts, the maintenance page, answering unknown names
Root CA	Handing out your root certificate, check codes, the open /trust page
System	Status checks, logs, backup and import, recent changes
Users and security	Accounts and rights, two-factor login, mail, alerts, HTTPS only
Troubleshooting	When something does not work