Code Monkey home page Code Monkey logo

kanboard-plugin-matrix's Introduction

Matrix plugin for Kanboard

Receive Kanboard notifications on Matrix.

Author

  • Chris Metz
  • Frederic Guillot (original Mattermost plugin)
  • License MIT

Requirements

  • Kanboard >= 1.0.37
  • Matrix server

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

Firstly, you have to generate a new webhook url in Matrix (Integration Settings > Incoming Webhooks).

Receive project notifications to a room

  • Go to the project settings then choose Integrations > Matrix
  • Copy and paste the webhook url from Matrix or leave it blank if you want to use the global webhook url
  • Enable Matrix in your project notifications Notifications > Matrix

You can also define the webhook URL globally in the Application settings > Integrations > Matrix.

Matrix configuration

  • Change the config option EnablePostUsernameOverride to true to have Kanboard as username
  • Change EnablePostIconOverride to true to see Kanboard icon

Troubleshooting

  • Enable the debug mode
  • All connection errors with the Matrix API are recorded in the log files data/debug.log

kanboard-plugin-matrix's People

Contributors

chriswep avatar fguillot avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

kanboard-plugin-matrix's Issues

How to setup Matrix webhook in Element ?

Hi,
I'm trying to use the Matrix plugin in Kanboard. However, I could not find any setting in Element for desktop (a PC Matrix client) to get the webhook URL required.
Is there a way to get this URL somewhere ? Are there other clients that allow that ?
Thanks !

Other messangers

If I understood your plugin correctly, the notifications from Kanboard come to the messanger matrix instead of by mail.

Would it also be possible to control other messangers like Whatsapp, Threema and/or Signal?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.