Skip to content

Clarify Docker webhooks setup #425

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

Draft
Chandu0501 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Clarify Docker webhooks setup #425

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 3 additions & 6 deletions src/content/docs/docs/standalone/docker.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,21 +73,18 @@ To mount the current directory use `-v $PWD:/home/wiremock` e.g.:
[WireMock extensions](../../extending-wiremock/) are packaged as JAR files. In order to use them they need to be made
available at runtime and WireMock must be configured to enable them.

For example, to use the [Webhooks extension](../../webhooks-and-callbacks/) we would first download [wiremock-webhooks-extension-3.13.1.jar](https://repo1.maven.org/maven2/org/wiremock/wiremock-webhooks-extension/3.13.1/wiremock-webhooks-extension-3.13.1.jar)
into the `extensions` directory under our working directory.

Then when starting Docker we would mount the extensions directory to `/var/wiremock/extensions` and enable the webhooks extension
via a CLI parameter:
Bundled extensions such as [Webhooks](../../webhooks-and-callbacks/) are already included in WireMock `3.1.0+`, so they only need to be enabled via a CLI parameter:

```sh
docker run -it --rm \
-p 8080:8080 \
--name wiremock \
-v $PWD/extensions:/var/wiremock/extensions \
wiremock/wiremock \
--extensions org.wiremock.webhooks.Webhooks
```

For third-party or custom extensions, download the JAR into the `extensions` directory under your working directory, mount that directory to `/var/wiremock/extensions`, then enable the extension via `--extensions`. If you need the legacy standalone webhooks extension for WireMock `3.0.x` or `2.x`, refer to the [2.x webhooks documentation](https://wiremock.org/2.x/docs/webhooks-and-callbacks/).

### Building your own image

Inside the container, the WireMock uses `/home/wiremock` as the root from which it reads the `mappings` and `__files` directories.
Expand Down