diff --git a/_index.md b/_index.md new file mode 100644 index 0000000..53724d9 --- /dev/null +++ b/_index.md @@ -0,0 +1,72 @@ +--- +title: drone-docker +--- + +[![Build Status](https://img.shields.io/drone/build/thegeeklab/drone-matrix?logo=drone&server=https%3A%2F%2Fdrone.thegeeklab.de)](https://drone.thegeeklab.de/thegeeklab/drone-matrix) +[![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/thegeeklab/drone-matrix) +[![Quay.io](https://img.shields.io/badge/quay-latest-blue.svg?logo=docker&logoColor=white)](https://quay.io/repository/thegeeklab/drone-matrix) +[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/drone-matrix)](https://github.com/thegeeklab/drone-matrix/graphs/contributors) +[![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/thegeeklab/drone-matrix) +[![License: MIT](https://img.shields.io/github/license/thegeeklab/drone-matrix)](https://github.com/thegeeklab/drone-matrix/blob/main/LICENSE) + +Drone plugin to to send messages to a Matrix room. + + + +{{< toc >}} + + + +## Build + +Build the binary with the following command: + +```Shell +export GOOS=linux +export GOARCH=amd64 +export CGO_ENABLED=0 +export GO111MODULE=on + +go build -v -a -tags netgo -o release/linux/amd64/drone-matrix +``` + +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) \ + plugins/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 }}`