Skip to content

Commit 1b3b13d

Browse files
committed
docs: update README.md
1 parent b87e888 commit 1b3b13d

File tree

2 files changed

+18
-34
lines changed

2 files changed

+18
-34
lines changed

Dockerfile

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
ARG CADDY_VERSION=2.10.0
2-
FROM caddy:${CADDY_VERSION}-builder AS builder
1+
FROM caddy:2.10.2-builder AS builder
32

43
COPY . .
54

65
RUN xcaddy build \
7-
--with github.com/sablierapp/sablier/plugins/caddy=.
6+
--with github.com/sablierapp/sablier-caddy-plugin=.
87

9-
FROM caddy:${CADDY_VERSION}
8+
FROM caddy:2.10.2
109

1110
COPY --from=builder /usr/bin/caddy /usr/bin/caddy

README.md

Lines changed: 15 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,30 @@
1+
<!-- omit in toc -->
12
# Caddy Sablier Plugin
23

3-
- [Caddy Sablier Plugin](#caddy-sablier-plugin)
4-
- [Build the custom Caddy image with Sablier middleware in it](#build-the-custom-caddy-image-with-sablier-middleware-in-it)
5-
- [By using the provided Dockerfile](#by-using-the-provided-dockerfile)
6-
- [By updating your Caddy Dockerfile](#by-updating-your-caddy-dockerfile)
7-
- [Configuration](#configuration)
8-
- [Exemple with a minimal configuration](#exemple-with-a-minimal-configuration)
9-
- [Running end-to-end tests](#running-end-to-end-tests)
4+
[![Go Report Card](https://goreportcard.com/badge/github.com/sablierapp/sablier-caddy-plugin)](https://goreportcard.com/report/github.com/sablierapp/sablier-caddy-plugin)
105

11-
## Build the custom Caddy image with Sablier middleware in it
6+
Start your containers on demand, shut them down automatically when there's no activity using Caddy.
127

13-
In order to use the custom plugin for Caddy, you need to bundle it with Caddy.
14-
Here I'll show you two options with Docker.
8+
- [Installation](#installation)
9+
- [Configuration](#configuration)
10+
- [Exemple with a minimal configuration](#exemple-with-a-minimal-configuration)
1511

16-
### By using the provided Dockerfile
12+
See the [official module page](https://caddyserver.com/docs/modules/http.handlers.sablier#github.com/sablierapp/sablier-caddy-plugin).
1713

18-
```bash
19-
docker build https://github.com/sablierapp/sablier.git#v1.10.1:plugins/caddy -t caddy:with-sablier
20-
```
14+
## Installation
15+
16+
This plugin does not come with a pre-built version of Caddy (see [#10](https://github.com/sablierapp/sablier-caddy-plugin/issues/10)).
2117

22-
**Note:** You can change `main` for any other branch (such as `beta`, or tags `v1.10.1`)
18+
You must build a custom version of Caddy with this plugin. See [](https://caddyserver.com/docs/build#xcaddy) for more information.
2319

24-
### By updating your Caddy Dockerfile
2520

2621
```Dockerfile
27-
ARG CADDY_VERSION=2.9.1
28-
FROM caddy:${CADDY_VERSION}-builder AS builder
22+
FROM caddy:2.10.2-builder AS builder
2923

3024
RUN xcaddy build \
31-
--with github.com/sablierapp/sablier/plugins/caddy
25+
--with github.com/sablierapp/sablier-caddy-plugin:v1.1.0 # x-release-please-version
3226

33-
FROM caddy:${CADDY_VERSION}
27+
FROM caddy:2.10.2
3428

3529
COPY --from=builder /usr/bin/caddy /usr/bin/caddy
3630
```
@@ -75,13 +69,4 @@ Almost all options are optional and you can setup very simple rules to use the s
7569
reverse_proxy myservice:port
7670
}
7771
}
78-
```
79-
80-
## Running end-to-end tests
81-
82-
1. Build local sablier
83-
`docker build -t caddy:local .`
84-
2. Build local caddy
85-
`docker build -t sablierapp/sablier:local ../..`
86-
3. Run test
87-
`cd e2e/docker && bash ./run.sh`
72+
```

0 commit comments

Comments
 (0)