0
0
mirror of https://github.com/thegeeklab/wp-matrix.git synced 2024-11-25 09:40:39 +00:00

[skip ci] auto-update documentation

This commit is contained in:
thegeeklab-bot 2024-03-12 19:59:28 +00:00
parent 6c20f8f0f9
commit a83d2689b9

View File

@ -21,17 +21,14 @@ Woodpecker CI plugin to send messages to a Matrix room.
## Usage ## Usage
```YAML ```YAML
kind: pipeline
name: default
steps: steps:
- name: notify - name: notify
image: quay.io/thegeeklab/matrix image: quay.io/thegeeklab/matrix
settings: settings:
homeserver: https://matrix.org homeserver: https://matrix.org
roomid: abcdefghijklmnopqrstuvwxyz:matrix.org roomid: randomstring:matrix.org
username: octocat username: octocat
password: secret password: random-secret
``` ```
### Parameters ### Parameters
@ -60,9 +57,9 @@ docker build --file Containerfile.multiarch --tag thegeeklab/wp-matrix .
```Shell ```Shell
docker run --rm \ docker run --rm \
-e PLUGIN_ROOMID=0123456789abcdef:matrix.org \ -e PLUGIN_ROOMID=randomstring:matrix.org \
-e PLUGIN_USERNAME=yourbot \ -e PLUGIN_USERNAME=octocat \
-e PLUGIN_PASSWORD=p455w0rd \ -e PLUGIN_PASSWORD=random-secret \
-v $(pwd):/build:z \ -v $(pwd):/build:z \
-w /build \ -w /build \
thegeeklab/wp-matrix thegeeklab/wp-matrix