Skip to content

Commit ad9e5bb

Browse files
authored
Document exposing API and management ports when not using docker-compose.yaml (#465)
#444 removed exposing the API and management ports directly in the `Dockerfile` in favor of the `docker-compose.yml`. Not everyone will be using `docker compose` so let's document how it should be done. Fixes #452
1 parent db1f587 commit ad9e5bb

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ at `https://localhost:14000/dir`.
9595

9696
Pebble includes a [docker-compose](https://docs.docker.com/compose/) file that
9797
will create a `pebble` instance that uses a `pebble-challtestsrv` instance for
98-
DNS resolution.
98+
DNS resolution with the correct ports mapped to the host system.
9999

100100
To download and start the containers run:
101101

@@ -119,6 +119,13 @@ See the [pebble-challtestsrv
119119
README](https://github.com/letsencrypt/pebble/blob/master/cmd/pebble-challtestsrv/README.md)
120120
for more information.
121121

122+
If you are running a one-off container for either `pebble` or
123+
`pebble-challtestsrv`, you will need to manually map ports.
124+
```
125+
docker run -p 14000:14000 -p 15000:15000 ghcr.io/letsencrypt/pebble:latest
126+
docker run -p 5001:5001 -p 5002:5002 -p 5003:5003 -p 8053:8053 -p 8055:8055 -p 8443:8443 ghcr.io/letsencrypt/pebble-challtestsrv:latest
127+
```
128+
122129
#### Prebuilt Docker Images
123130

124131
Pebble releases are published as Docker images to the
@@ -145,9 +152,9 @@ services:
145152
With a Docker command:
146153
147154
```bash
148-
docker run -e "PEBBLE_VA_NOSLEEP=1" ghcr.io/letsencrypt/pebble
155+
docker run -p 14000:14000 -p 15000:15000 -e "PEBBLE_VA_NOSLEEP=1" ghcr.io/letsencrypt/pebble
149156
# or
150-
docker run -e "PEBBLE_VA_NOSLEEP=1" --mount src=$(pwd)/my-pebble-config.json,target=/test/my-pebble-config.json,type=bind ghcr.io/letsencrypt/pebble pebble -config /test/my-pebble-config.json
157+
docker run -p 14000:14000 -p 15000:15000 -e "PEBBLE_VA_NOSLEEP=1" --mount src=$(pwd)/my-pebble-config.json,target=/test/my-pebble-config.json,type=bind ghcr.io/letsencrypt/pebble pebble -config /test/my-pebble-config.json
151158
```
152159

153160
### Default validation ports

0 commit comments

Comments
 (0)