Kanboard-Prod/docs/github-authentication.markdown

Github Authentication

Requirements

OAuth Github API credentials (available in your Settings > Applications > Developer applications)

How does this work?

The Github authentication in Kanboard uses the OAuth 2.0 protocol, so any user of Kanboard can be linked to a Github account.

When that is done, they no longer need to manually login with their Kanboard account, but can simply automatically login with their Github account.

How to link a Github account

1. Go to your user profile
2. Click on External accounts
3. Click on the link Link my Github Account
4. You are redirected to the Github Authorize application form
5. Authorize Kanboard by clicking on the button Accept
6. Your account is now linked

Now, on the login page you can be authenticated in one click with the link Login with my Github Account.

Your name and email are automatically updated from your Github Account if defined.

Installation instructions

Setting up OAuth 2.0

• On Github, go to the page Register a new OAuth application
• Just follow the official Github documentation
• In Kanboard, you can get the callback url in Settings > Integrations > Github Authentication

Setting up Kanboard

Either create a new config.php file or rename the config.default.php file and set the following values:

// Enable/disable Github authentication
define('GITHUB_AUTH', true);

// Github client id (Copy it from your settings -> Applications -> Developer applications)
define('GITHUB_CLIENT_ID', 'YOUR_GITHUB_CLIENT_ID');

// Github client secret key (Copy it from your settings -> Applications -> Developer applications)
define('GITHUB_CLIENT_SECRET', 'YOUR_GITHUB_CLIENT_SECRET');

Notes

Kanboard uses these information from your public Github profile:

• Full name
• Public email address
• Github unique id

The Github unique id is used to link the local user account and the Github account.