diff options
author | Brian Picciano <me@mediocregopher.com> | 2024-07-04 18:43:13 +0200 |
---|---|---|
committer | Brian Picciano <me@mediocregopher.com> | 2024-07-04 19:00:14 +0200 |
commit | 42d7ef1c812237812da42c3beef786172601395f (patch) | |
tree | cfd405f482330317f872ca5008661608d44d87e0 | |
parent | c9d28a108d6df59a895dd10f47e834ceba20f98a (diff) |
Update README with build instructions
-rw-r--r-- | README.md | 20 |
1 files changed, 19 insertions, 1 deletions
@@ -4,7 +4,25 @@ TODO proper introduction ## Build -TODO +A Caddy binary with these plugins included can be built using the +[xcaddy][xcaddy] tool: + +```bash +xcaddy build --with dev.mediocregopher.com/mediocre-caddy-plugins.git +``` + +If you want just a specific plugin you can choose it using its module path: + +```bash +xcaddy build \ + --with dev.mediocregopher.com/mediocre-caddy-plugins.git/http/handlers/templates/functions +``` + +It's also possible to build Caddy manually using a custom `main.go` file, see +[the example from the caddy repo][caddymain]. + +[xcaddy]: https://github.com/caddyserver/xcaddy +[caddymain]: https://github.com/caddyserver/caddy/blob/master/cmd/caddy/main.go ## Plugins |