JovianLinux/Guides/kanboard.md

Kanboard

The lightweigth kanban project manager

Link to documentation

Official Kanboard documentation

Installation

Use script install-kanboard in the folder Install in this repository.

Setup GUI

Website domain

In Settings/Application Settings.

Plugins

Install

Go to the plugins settings (you should be logged as an admin).

Useful plugins

GitHub authentication

Gogs webhook

Mattermost notification

Zulip notifications

Signal notification

SMS two factor authentication

Setup GitHub authentication

Install plugin

First install the GitHub authentification plugin.

Create the application on GitHub

With your admin user account, connect to Kanboard and go to Settings > Integration. You should see the GitHub authentication panel with the Github OAuth callback URL already completed.

Now, open a new tab and connect to your GitHub account. Then you have to register your application to GitHub. Fill in the form, and do not forget to put the Authorization callback URL retrieved in Kanboard. Now valid the application creation by clicking on Register application.

Now, you have been redirected to another GitHub page with the message Application successfully created. You have now access to the client id and the client secret. Copy paste these two strings in your first tab, inside the GitHub authentication panel in Kanboard.

Now, your application is registered.

Create a new user

You can now create remote user accounts to allow your team members to connect with their own GitHub account. Please replace the example user name DricomDragon by the username you want to add.

In Kanboard, go to Settings > User Management and click on Create a new user. Type DricomDragon in the username field and check the box Remote user. Click on Save.

Then, click on the newly created user. In the left side panel, in the Actions category, click on Edit authentication. You should see a Github Id field. You have to put the GitHub id yourself. To do so, use the GitHub API https://api.github.com/users/DricomDragon. Put the id in the GitHub Id field. Click on Save.

Congratulations ! This user can now connect to Kanboard using his own GitHub account.

Connect with a GitHub account

In the login page, instead of using the login form, hit the Login with my GitHub Account. The first time, the user should give the authorization to the Kanboard application to access public data. The next time, the user will only need to click the link and will be automatically redirected to Kanboard dashboard.

Beware, sometimes Kanboard can fail. Try again, it should work. ^_^'