Matrix

by drone-plugins

This plugin can be used to send build success or failure messages to a Matrix room. The below pipeline configuration demonstrates simple usage:

pipeline:
  notify:
    image: plugins/matrix
    homeserver: https://matrix.org
    roomid: abcdefghijklmnopqrstuvwxyz:matrix.org
    username: octocat
    password: p455w0rd

Example configuration using a secret:

pipeline:
  notify:
    image: plugins/matrix
    homeserver: https://matrix.org
    roomid: abcdefghijklmnopqrstuvwxyz:matrix.org
-   username: octocat
-   password: p455w0rd
+   secrets: [ matrix_username, matrix_password ]

Secret Reference

matrix_username
Username on homeserver
matrix_password
Password on homeserver (use with username)
matrix_userid, matrix_user_id
Matrix user ID (@user:homeserver.tld)
matrix_accesstoken, matrix_access_token
Matrix access token (use with userid)
matrix_homeserver
Matrix home server, defaults to https://matrix.org
matrix_roomid
Room ID to send messages
matrix_template
Template for the message

Parameter Reference

username
Username on homeserver
password
Password on homeserver (use with username)
userid
Matrix user ID (@user:homeserver.tld)
accesstoken
Matrix access token (use with userid)
homeserver
Matrix homeserver URL, defaults to https://matrix.org
roomid
Room ID to send messages (not alias, but ID, and you can skip the !)
template
Template for the message

¿Hay algún error en esta página? Por favor, háganoslo saber o edite esta página.