https://github.com/andrewshadura/kanboard-plugin-matrix

Matrix.org plugin for Kanboard
https://github.com/andrewshadura/kanboard-plugin-matrix

kanboard kanboard-plugin matrix-org

Last synced: about 2 months ago
JSON representation

Matrix.org plugin for Kanboard

• Host: GitHub
• URL: https://github.com/andrewshadura/kanboard-plugin-matrix
• Owner: andrewshadura
• License: mit
• Created: 2017-09-24T13:49:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-10-25T09:03:55.000Z (over 4 years ago)
• Last Synced: 2024-05-02T01:26:58.494Z (9 months ago)
• Topics: kanboard, kanboard-plugin, matrix-org
• Language: PHP
• Homepage: https://kanboard.net/plugin/matrix
• Size: 29.3 KB
• Stars: 8
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Matrix plugin for Kanboard

==============================

Receive Kanboard notifications on Matrix.

Authors

-------

- Frederic Guillot wrote the original Mattermost plugin

- Andrej Shadura adapted it to work with the Matrix API

- License: MIT

Requirements

------------

- Kanboard >= 1.0.37

- An account at a Matrix homeserver

Installation

------------

You have the choice between 3 methods:

1. Install the plugin from the Kanboard plugin manager in one click

2. Download the zip file and decompress everything under the directory `plugins/Matrix`

3. Clone this repository into the folder `plugins/Matrix`

Note: Plugin folder is case-sensitive.

Configuration

-------------

### Define Matrix homeserver configuration

- In **Application settings > Integrations > Matrix**, set the homeserver URL, the username and the

password. Alternatively, if you have an access token, you can specify it instead of the username and

the password.

### Receive project notifications to a room

- Go to the project settings then choose **Integrations > Matrix**

- Set the chatroom address, for example: **#room:matrix.org**

- Enable Matrix in your project notifications **Notifications > Matrix**

## Troubleshooting

- Enable the debug mode

- All connection errors with the Matrix API are recorded in the log files `data/debug.log`