2019-09-05 13:13:42 +12:00
|
|
|
Discord plugin for Kanboard
|
2019-09-05 12:33:42 +12:00
|
|
|
=========================
|
|
|
|
|
|
2019-09-05 13:13:42 +12:00
|
|
|
Receive Kanboard notifications on Discord.
|
2019-09-05 12:33:42 +12:00
|
|
|
|
|
|
|
|
Author
|
|
|
|
|
------
|
|
|
|
|
|
2019-09-05 13:13:42 +12:00
|
|
|
- Ryonez Coruscare
|
2019-09-05 12:33:42 +12:00
|
|
|
- License MIT
|
|
|
|
|
|
|
|
|
|
Requirements
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
- Kanboard >= 1.0.37
|
|
|
|
|
|
|
|
|
|
Installation
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
You have the choice between 3 methods:
|
|
|
|
|
|
|
|
|
|
1. Install the plugin from the Kanboard plugin manager in one click
|
2019-09-05 13:13:42 +12:00
|
|
|
2. Download the zip file and decompress everything under the directory `plugins/Discord`
|
|
|
|
|
3. Clone this repository into the folder `plugins/Discord`
|
2019-09-05 12:33:42 +12:00
|
|
|
|
|
|
|
|
Note: Plugin folder is case-sensitive.
|
|
|
|
|
|
|
|
|
|
Configuration
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
Firstly, you have to generate a new webhook url in Discord (**Server or Channel Settings > Webhooks**).
|
|
|
|
|
|
|
|
|
|
You can define only one webhook url (**Settings > Integrations > Slack**) for each project and user.
|
|
|
|
|
|
|
|
|
|
### Receive individual user notifications
|
|
|
|
|
|
|
|
|
|
- Go to your user profile then choose **Integrations > Discord**
|
|
|
|
|
- Copy and paste the webhook url from Slack or leave it blank if you want to use the global webhook url
|
|
|
|
|
- Use `@username` to receive direct message to your user
|
|
|
|
|
- Enable Discord in your user notifications **Notifications > Discord**
|
|
|
|
|
|
|
|
|
|
### Receive project notifications to a room
|
|
|
|
|
|
|
|
|
|
- Go to the project settings then choose **Integrations > Discord**
|
|
|
|
|
- Copy and paste the webhook url from Discord or leave it blank if you want to use the global webhook url
|
|
|
|
|
- Enable Discord in your project notifications **Notifications > Discord**
|
|
|
|
|
|
|
|
|
|
## Troubleshooting
|
|
|
|
|
|
|
|
|
|
- Enable the debug mode
|
|
|
|
|
- All connection errors with the Discord API are recorded in the log files `data/debug.log` or syslog
|
