GithubHelp home page GithubHelp logo

oliviermaridat / plugin-rocketchat Goto Github PK

View Code? Open in Web Editor NEW

This project forked from kanboard/plugin-rocketchat

5.0 4.0 1.0 39 KB

RocketChat plugin for Kanboard

Home Page: https://kanboard.net/plugin/rocketchat

License: MIT License

PHP 98.91% Makefile 1.09%

plugin-rocketchat's Introduction

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.

plugin-rocketchat's People

Contributors

fabiottini avatar fchyla avatar fguillot avatar jamie-owen avatar oliviermaridat avatar sabirovrinat85 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

fabiottini

plugin-rocketchat's Issues

User Notification Not Working

Good morning,

I'm trying to use rocketchat to notify users about taks assigned to them, but is not working even with user field set in integration to override the default channel in rocketchat. The override only works when set the user in integration project channel.

I'm using the plugin latest version.

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.