🦆 Rubberverse Container Images

"Others stray away from insanity, we embrace it." - Totally not the owner of this repo

Not sure what to pull? Check currently available images.

Notice

This is a major rewrite of qor-caddy that completely changes how it was used compared to now. Before updating, make sure that you're ready to adapt to them.

Features

• Uses scratch image for runner, meaning there's no shell or any extra utilities
• Rootless, supports any UID:GID combination as long as you fix up the directory and file permissions
• Ready for cross-compilation, no hard-dependencies on single architecture
• Lower container size: only 58.9MB as opposed to ~120MB
• Includes third-party Caddy modules
• Only read and execute permissions for executables inside the container
• Doesn't use xcaddy (you decide if it's a feature or not)

🔗 Image Tags

Base	Tag(s)	Arch	Description
scratch	latest, $tag	x86_64	Stable branch Caddy builds
scratch	beta, beta-$tag	x86_64	Beta/RC Caddy builds

Warning

security tag is discontinued. I don't have time to maintain it, sorry!

Tags follow SemVer versioning

• X: Image revision
• Y: Image major changes
• Z: Image minor changes, minor version bumps, fixes etc.

💲 Environmental variables

Required environmental variables are CONFIG_PATH, rest is optional.

Variable	Default Value
CONFIG_PATH	Empty
DEPLOY_TYPE	Fallback to "prod"
EXTRA_ARGS	Empty

CONFIG_PATH should point to a full path where Caddyfile, or caddy.json residues in. We recommend mounting your configuration files in /app/configs!

Here's an example .env you can use as a base

CONFIG_PATH=/app/configs/Caddyfile
# Can be prod or test, use prod in production environments!
DEPLOY_TYPE=prod
# Any extra arguments you can pass to caddy run (prod) or caddy start (test), refer to Caddy documentation to know more
EXTRA_ARGUMENTS=""

If using Quadlet, you can use the .env above like so

# SNIPPET
[Container]
(...)
EnvironmentFile=/home/example_user/Environments/.env
Volume=/home/example_user/Caddyfile:/app/configs/Caddyfile

Deploying

Quadlet unit, only supported on Podman +v5.2.1

1. Copy qor-caddy.container from this repository and put it in ~/.config/containers/systemd
2. Edit it to your own liking, there are comments inside of it to guide you around
3. Reload systemctl daemon with systemctl --user daemon-reload
4. Deploy the Quadlet unit by starting the service - systemctl --user start qor-caddy

⚙️ List of third-party Caddy modules

These modules can be removed at any time and for any reason, they're mostly here to just serve a purpose for me. If I happen to switch technologies or something similar, I generally tend to remove things I don't need as it makes it easier to manage.

Repo	Type	Short Desc
caddy-dns/cloudflare	DNS Provider	Manage Cloudflare DNS, useful for DNS-01 challenges
corazawaf/coraza-caddy	Web application firewall	OWASP Coraza Caddy
hslatman/caddy-crowdsec-bouncer	Web application firewall	https://crowdsec.net, includes Layer4 sub-module
porech/caddy-maxmind-geolocation	Geo Filtering	Uses GeoLite2 Country database and filters requests by country
mholt/caddy-l4	Raw TCP/UDP Routing	Allows Caddy to route Layer 4 traffic
mholt/caddy-ratelimit	Traffic Limiting	Implements rate limiting similar to Nginx rate limit (WIP)
jonaharagon/caddy-umami	Utility	Implement Umami Analytics to any website straight from Caddy
fvpommel/caddy-combine-ip-ranges	Utility / Extension	Allows combination of trusted_proxies directives
fvpommel/caddy-dns-ip-range	Utility / Extension	Checks against locally running cloudflared DNS and updates their IP addresses
WeidiDeng/caddy-cloudflare-ip	Utility / Extension	Periodically checks Cloudflare IP ranges and updates them

Any issues involving third-party modules should be reported to the module's respective repository, not to Caddy maintainers. In case the issue comes from my image, create an issue about it here!

🛠️ Usage

In case you enabled admin endpoint, you can reload your configuration file with following commands:

• podman exec -t qor-caddy /app/bin/entrypoint --reload
• podman exec -t qor-caddy /app/bin/caddy reload --config /app/configs/Caddyfile

This will reload your configuration if you've done any changes to it.

Otherwise, the usage is about the same as average Caddy image. You can read more about admin endpoint on caddy docs

Warning

Volume mounted configuration files will still need a container restart if you re-created the configuration file when it was on. So in case something seems fishy, restart your container. You'll know instantly in case config file is wrong ;)

Here's some helpful links to get you head-started with Caddy as your Web Server. On your own time, you can learn even more advanced things that Caddy can do!

• Getting started @ Caddy docs
• Quick-starts @ Caddy docs
• Caddyfile Reference @ Caddy docs
• My own Caddyfiles: WAN and LAN.

I make use of plenty of moduels from here so you can take a lookie. Though they're updated once in a while.

🥰 Contributing

Feel free to contribute if you feel like something is wrong, needs changing or other various reasons. Though I would appreciate it if you created a GitHub issue first to talk about it! (Just so we can be on the same table)