mirror of
https://github.com/thegeeklab/drone-matrix.git
synced 2024-11-28 13:10:35 +00:00
73 lines
2.1 KiB
Markdown
73 lines
2.1 KiB
Markdown
---
|
|
title: drone-matrix
|
|
---
|
|
|
|
[](https://drone.thegeeklab.de/thegeeklab/drone-matrix)
|
|
[](https://hub.docker.com/r/thegeeklab/drone-matrix)
|
|
[](https://quay.io/repository/thegeeklab/drone-matrix)
|
|
[](https://github.com/thegeeklab/drone-matrix/graphs/contributors)
|
|
[](https://github.com/thegeeklab/drone-matrix)
|
|
[](https://github.com/thegeeklab/drone-matrix/blob/main/LICENSE)
|
|
|
|
Drone plugin to to send messages to a Matrix room.
|
|
|
|
<!-- prettier-ignore-start -->
|
|
<!-- spellchecker-disable -->
|
|
{{< toc >}}
|
|
<!-- spellchecker-enable -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
## Build
|
|
|
|
Build the binary with the following command:
|
|
|
|
```Shell
|
|
export GOOS=linux
|
|
export GOARCH=amd64
|
|
export CGO_ENABLED=0
|
|
export GO111MODULE=on
|
|
|
|
make build
|
|
```
|
|
|
|
Build the Docker image with the following command:
|
|
|
|
```Shell
|
|
docker build --file docker/Dockerfile.amd64 --tag thegeeklab/drone-matrix .
|
|
```
|
|
|
|
## Usage
|
|
|
|
```Shell
|
|
docker run --rm \
|
|
-e PLUGIN_ROOMID=0123456789abcdef:matrix.org \
|
|
-e PLUGIN_USERNAME=yourbot \
|
|
-e PLUGIN_PASSWORD=p455w0rd \
|
|
-v $(pwd):$(pwd) \
|
|
-w $(pwd) \
|
|
thegeeklab/drone-matrix
|
|
```
|
|
|
|
### Parameters
|
|
|
|
username
|
|
: sets username for authentication
|
|
|
|
password
|
|
: sets password for authentication
|
|
|
|
user_id
|
|
: sets userid for authentication
|
|
|
|
access_token
|
|
: sets access token for authentication
|
|
|
|
homeserver
|
|
: sets matrix home server url to use (default `https://matrix.org`)
|
|
|
|
roomid
|
|
: sets roomid to send messages to
|
|
|
|
template
|
|
: sets message template; used default template `build {{ build.status }} [{{ repo.owner }}/{{ repo.name }}#{{ truncate build.commit 8 }}]({{ build.link }}) ({{ build.branch }}) by {{ build.author }}`
|