aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 52f3019752c903b091f965f5dbb5a58288e72344 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# mediocre-caddy-plugins

TODO proper introduction

## Development

A nix-based development environment is provided with the correct versions of all
development dependencies. It can be activated by doing:

```
nix-shell -A shell
```

The `./cmd/mediocre-caddy` binary package can be used to run a Caddy instance
with all plugins provided by this package pre-installed.

The Caddyfile `./example/Caddyfile` can be used to spin up a Caddy instance with
various virtual-hosts predefined with usefule configurations for testing. See
that file for a description of the available virtual hosts.

```
go run ./cmd/mediocre-caddy run --config ./example/Caddyfile
```