blob: 8d2f000047f43f18c9c0b564385ee5c5cdb2237e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
Gitlab Authentication
=====================
Requirements
------------
- Account on [Gitlab.com](https://gitlab.com) or you own self-hosted Gitlab instance
- Have Kanboard registered as application in Gitlab
How does this work?
-------------------
The Gitlab authentication in Kanboard uses the [OAuth 2.0](http://oauth.net/2/) protocol, so any user of Kanboard can be linked to a Gitlab account.
That means you can use your Gitlab account to login on Kanboard.
How to link a Gitlab account
----------------------------
1. Go to your user profile
2. Click on **External accounts**
3. Click on the link **Link my Gitlab Account**
4. You are redirected to the **Gitlab authorization 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 Gitlab Account**.
Your name and email are automatically updated from your Gitlab Account if defined.
Installation instructions
-------------------------
### Setting up OAuth 2.0
- On Gitlab, register a new application by following the [official documentation](http://doc.gitlab.com/ce/integration/oauth_provider.html)
- In Kanboard, you can get the **callback url** in **Settings > Integrations > Gitlab Authentication**, just copy and paste the url
### Setting up Kanboard
Either create a new `config.php` file or rename the `config.default.php` file and set the following values:
```php
// Enable/disable Gitlab authentication
define('GITLAB_AUTH', true);
// Gitlab application id
define('GITLAB_CLIENT_ID', 'YOUR_APPLICATION_ID');
// Gitlab application secret
define('GITLAB_CLIENT_SECRET', 'YOUR_APPLICATION_SECRET');
```
### Custom endpoints for self-hosted Gitlab
Change these default values if you use a self-hosted instance of Gitlab:
```php
// Gitlab oauth2 authorize url
define('GITLAB_OAUTH_AUTHORIZE_URL', 'https://gitlab.com/oauth/authorize');
// Gitlab oauth2 token url
define('GITLAB_OAUTH_TOKEN_URL', 'https://gitlab.com/oauth/token');
// Gitlab API url endpoint (don't forget the slash at the end)
define('GITLAB_API_URL', 'https://gitlab.com/api/v3/');
```
Notes
-----
Kanboard uses these information from your Gitlab profile:
- Full name
- Email address
- Gitlab unique id
The Gitlab unique id is used to link the local user account and the Gitlab account.
Known issues
------------
Gitlab OAuth will work only with url rewrite enabled. At the moment, Gitlab doesn't support callback url with query string parameters. See [Gitlab issue](https://gitlab.com/gitlab-org/gitlab-ce/issues/2443)
|
