0
0
mirror of https://github.com/thegeeklab/wp-matrix.git synced 2024-11-21 14:20:41 +00:00

cleanup docs and examples

This commit is contained in:
Robert Kaussow 2024-03-12 20:43:35 +01:00
parent 3cfde357ae
commit 4e6b959d04
Signed by: xoxys
GPG Key ID: 4E692A2EAECC03C0

View File

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