Skip to content

oliviermaridat/plugin-rocketchat

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RocketChat plugin for Kanboard

Note: The original RocketChat plugin repository is declared "Not Maintained". This fork is maintained, has been kind of accepted as the official replacement and is listed in the Kanboard plugin marketplace.

Receive Kanboard notifications on RocketChat.

notifications

You can configure RocketChat notifications for a project or for each individual Kanboard user.

Author

  • Frédéric Guillot
  • Olivier Maridat
  • License MIT

Requirements

  • Kanboard >= 1.0.37
  • RocketChat

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/RocketChat
  3. Clone this repository into the folder plugins/RocketChat

Note: Plugin folder is case-sensitive.

Configuration

RocketChat configuration

  • Generate a new webhook url
  • Go to Administration > Integrations > New Integration > Incoming Webhook
  • You can override the channel later if required

Kanboard configuration

Individual notifications

  1. Copy and paste the webhook url into Integrations > RocketChat in your user profile
  2. Enable RocketChat notifications in your user profile or project settings
  3. Enjoy!

Project notification

  1. Copy and paste the webhook url into Integrations > RocketChat in the project settings
  2. Add the channel name (Optional)
  3. Enable RocketChat notification in the project
  4. Enjoy!

Kanboard configuration file

One technical parameter can be override by the Kanboard config.php file:

Key Description Default value
PLUGIN_RC_MAX_MSG_SIZE If a task description or comment has more characters than this config, the message is truncated before to be posted to RocketChat. 1000

Development

Please do not hesitate to suggest Pull Request :D

To generate a new release archive, run: make version=v1.0.x.

About

RocketChat plugin for Kanboard

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 98.9%
  • Makefile 1.1%