https://github.com/ansemjo/caddy
A container image containing the caddy server in two variants: Proxy and CGI
https://github.com/ansemjo/caddy
Last synced: 6 months ago
JSON representation
A container image containing the caddy server in two variants: Proxy and CGI
- Host: GitHub
- URL: https://github.com/ansemjo/caddy
- Owner: ansemjo
- License: mit
- Created: 2019-02-16T23:24:27.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-03-03T19:18:41.000Z (over 2 years ago)
- Last Synced: 2024-03-03T20:28:12.257Z (over 2 years ago)
- Language: Dockerfile
- Size: 35.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ansemjo/caddy
A container image containing the [caddy] server in two variants:
- `ghcr.io/ansemjo/caddy:plain` – completely standalone in a scratch base image for simple file server or
proxying scenarios
- `ghcr.io/ansemjo/caddy:cgi` – with [CGI support] in a Python base image for simple dynamic content
Both images can quickly be build with `build.sh` if you have a BuildKit-enabled Docker.
[caddy]: https://caddyserver.com/
[CGI support]: https://github.com/aksdb/caddy-cgi/
## `plain`
This is the simpler image because it is intended to be used as a TLS proxy for internal services or
as one element in a `docker-compose.yml` file. The `caddy` binary is compiled statically and
stripped of all symbols, then placed in an empty `scratch` image.
### Usage
The Caddyfile in the image only activates a file browser in its root `/srv/www` and
nothing more.
docker run -d -p 8080:8080 \
-v /path/to/files:/srv/www \
ghcr.io/ansemjo/caddy:plain
If you want to do something else you can also mount a custom configuration file
over `/Caddyfile`:
docker run -d -p 8080:8080 \
-v /path/to/files:/srv/www \
-v $PWD/Caddyfile:/Caddyfile \
ghcr.io/ansemjo/caddy:plain
## `cgi`
This image uses the same `caddy` binary as above, which is built with
[aksdb/caddy-cgi](https://github.com/aksdb/caddy-cgi/) compiled-in, and is placed
in a Python base image.
That means that you can have a few simple scripts in the container that will be used
to construct the actual response dynamically without writing a full-blown application
server. This has its drawbacks of course, mainly performance. But it works great for
simple dynamically generated content like menu scripts for network booting with iPXE
or Kickstart configurations, for example. To that end, this image plays together nicely
with [ansemjo/ipxeboot](https://github.com/ansemjo/ipxeboot).
### Usage
The included `Caddyfile` handles any `/*.py` files in its `/srv/www` webroot as
Pyhton scripts and executes them with Python 3. A small sample is included in
`/srv/www/hello.py`.
docker run -d -p 8080:8080 \
-v /path/to/files:/srv/www \
ghcr.io/ansemjo/caddy:cgi
Again, if you want to configure how your CGI scripts are handled or enable other
features, mount your own configuration over `/Caddyfile` (see above).
## License
### caddy
The caddy binary is built from sources and as such is licensed under
the [Apache License 2.0]. No changes are made directly to its sources but an
own `main.go` file is used to enable the plugin below.
[Apache License 2.0]: https://github.com/caddyserver/caddy/blob/master/LICENSE
### caddy-cgi
The included [caddy-cgi] plugin is licensed under the [MIT License].
[caddy-cgi]: https://github.com/aksdb/caddy-cgi/
[MIT License]: https://github.com/aksdb/caddy-cgi/blob/master/LICENSE
### this project
This work is licensed under the [MIT License](LICENSE).