Skip to content

Document exposing API and management ports when not using docker-compose.yaml #465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pgporada merged 2 commits into from
May 31, 2024
Merged

Document exposing API and management ports when not using docker-compose.yaml #465

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94f0b15
Expose API and management ports in dockerfile
pgporada May 24, 2024
dcdab58
Document port mapping instead
pgporada May 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ at `https://localhost:14000/dir`.

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

To download and start the containers run:

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

If you are running a one-off container for either `pebble` or
`pebble-challtestsrv`, you will need to manually map ports.
```
docker run -p 14000:14000 -p 15000:15000 ghcr.io/letsencrypt/pebble:latest
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
```

#### Prebuilt Docker Images

Pebble releases are published as Docker images to the
Expand All @@ -145,9 +152,9 @@ services:
With a Docker command:

```bash
docker run -e "PEBBLE_VA_NOSLEEP=1" ghcr.io/letsencrypt/pebble
docker run -p 14000:14000 -p 15000:15000 -e "PEBBLE_VA_NOSLEEP=1" ghcr.io/letsencrypt/pebble
# or
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
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
```

### Default validation ports
Expand Down