From 1cac395869edb3427f2555bc5a2740436e0c7f8d Mon Sep 17 00:00:00 2001 From: Ambrose Chua Date: Wed, 13 May 2020 12:22:11 +0800 Subject: [PATCH] Update README --- README.md | 33 ++------------------------------- 1 file changed, 2 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index c383332..fc5a8e8 100755 --- a/README.md +++ b/README.md @@ -1,38 +1,9 @@ -# WARNING: Upcoming Caddy v2 WILL fundamentally change the way Caddy is configured. The `latest` tag will be changed to reflect that. This LIKELY breaks existing containers using the `latest` tag and the stock Caddyfile - # [caddy](https://hub.docker.com/r/productionwentdown/caddy/) [![](https://images.microbadger.com/badges/version/productionwentdown/caddy.svg)](https://microbadger.com/images/productionwentdown/caddy "Get your own version badge on microbadger.com") [![](https://images.microbadger.com/badges/image/productionwentdown/caddy.svg)](https://microbadger.com/images/productionwentdown/caddy "Get your own image badge on microbadger.com") -A tiny 9MB Caddy image compressed with [UPX](https://github.com/upx/upx). +A tiny <10MB Caddy image compressed with [UPX](https://github.com/upx/upx). # Usage -Serve files in `$PWD`: -``` -docker run -it --rm -p 2015:2015 -v $PWD:/srv productionwentdown/caddy -``` +See the [official image](https://hub.docker.com/_/caddy) for documentation. This image behaves the same way, except that it is much slimmer. -Overwrite `Caddyfile`: -``` -docker run -it --rm -p 2015:2015 -v $PWD:/srv -v $PWD/Caddyfile:/etc/Caddyfile productionwentdown/caddy -``` - -Persist `.caddy` to avoid hitting Let's Encrypt's rate limit: -``` -docker run -it --rm -p 2015:2015 -v $PWD:/srv -v $PWD/Caddyfile:/etc/Caddyfile -v $HOME/.caddy:/etc/.caddy productionwentdown/caddy -``` - -# Build with plugins - -Using `docker build` arguments: -``` -docker build -t caddy --build-arg plugins=github.com/abiosoft/caddy-git,github.com/zikes/gopkg . -``` - -You can also fork and edit plugger.go for more advanced plugin configuration - -# Build without telemetry - -``` -docker build . -t caddy --build-arg telemetry=false -```