github
/
wp-matrix
mirror of https://github.com/thegeeklab/wp-matrix.git
0
0
Fork 0
Code Issues Releases Activity

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
1 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/content/_index.md
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