diff options
author | Frederic Guillot <fred@kanboard.net> | 2015-07-16 20:58:22 -0400 |
---|---|---|
committer | Frederic Guillot <fred@kanboard.net> | 2015-07-16 20:58:22 -0400 |
commit | 94068019db4ec74e0e2a9550aabf9ca8b0087455 (patch) | |
tree | 8064951cdc16d615720c3e27960c5f56fd0fafea /docs | |
parent | ede1f1d9b0c06a05845f4125d59c97c29b6d9842 (diff) |
Display OAuth2 urls on integration page and update doc
Diffstat (limited to 'docs')
-rw-r--r-- | docs/github-authentication.markdown | 127 | ||||
-rw-r--r-- | docs/google-authentication.markdown | 29 | ||||
-rw-r--r-- | docs/index.markdown | 2 |
3 files changed, 78 insertions, 80 deletions
diff --git a/docs/github-authentication.markdown b/docs/github-authentication.markdown index d6c1e1e8..8c3b622d 100644 --- a/docs/github-authentication.markdown +++ b/docs/github-authentication.markdown @@ -1,64 +1,63 @@ -GitHub Authentication
-=====================
-
-Requirements
-------------
-
-- OAuth GitHub API credentials (available in your [Settings > Applications > Developer applications](https://github.com/settings/applications))
-
-How does this work?
--------------------
-
-The GitHub authentication in Kanboard uses the [OAuth 2.0](http://oauth.net/2/) 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. Login to Kanboard with the desired user
-2. Go to the **Edit user** page and click on the link **Link my GitHub Account**
-3. You are redirected to the GitHub **Authorize application** form, authorize Kanboard by clicking on the button **Accept**
-4. Finally, you are redirected to Kanboard and now your user account is linked to your GitHub account
-5. During the process, Kanboard has updated your full name and your email address based on your GitHub profile, if either of those are publically available
-6. Log out of Kanboard and you should be able to login directly with GitHub by clicking on the link **Login with my GitHub Account**
-
-Installation instructions
--------------------------
-
-### Setting up OAuth 2.0
-
-On Github, go to the page ["Register a new OAuth application"](https://github.com/settings/applications/new).
-
-Just follow the [official GitHub documentation](https://developer.github.com/guides/basics-of-authentication/#registering-your-app):
-
-- Open your [Settings](https://github.com/settings), select [Applications](https://github.com/settings/applications) from the sidebar and click on [Register new application](https://github.com/settings/applications/new) on the top, next to where it says **Developer applications**
-- Fill out the form with whatever values you like, the **Authorization callback URL** _must_ be: **http://YOUR_SERVER/?controller=user&action=gitHub**
-
-### 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 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
------
-**Important:** _*Never*_ store your GITHUB_CLIENT_ID or GITHUB_CLIENT_SECRET in GitHub or somewhere with full public access in general!
-
-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.
+Github Authentication +===================== + +Requirements +------------ + +OAuth Github API credentials (available in your [Settings > Applications > Developer applications](https://github.com/settings/applications)) + +How does this work? +------------------- + +The Github authentication in Kanboard uses the [OAuth 2.0](http://oauth.net/2/) 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](https://github.com/settings/applications/new) +- Just follow the [official Github documentation](https://developer.github.com/guides/basics-of-authentication/#registering-your-app) +- 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: + +```php +// 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. diff --git a/docs/google-authentication.markdown b/docs/google-authentication.markdown index 033cf4bb..0f4f3ec1 100644 --- a/docs/google-authentication.markdown +++ b/docs/google-authentication.markdown @@ -4,7 +4,7 @@ Google Authentication Requirements ------------ -- OAuth Google API credentials (available in the Google Developer Console) +OAuth Google API credentials (available in the Google Developer Console) How does this work? ------------------- @@ -16,24 +16,24 @@ How does this work? Procedure to link a Google Account ---------------------------------- -1. The first step is to link an existing user account to a Google Account -2. Login with the desired user -3. Go to the **Edit user** page and click on the link **Link my Google Account** -4. You are redirected to the **Google Consent screen**, authorize Kanboard by clicking on the button **Accept** -5. Finally, you are redirected to Kanboard and now your user account is linked to your Google account -6. During the process, Kanboard have updated your full name and your email address based on your Google profile -7. Log out and you should be able to login directly with Google by clicking on the link **Login with my Google Account** +1. Go to your user profile +2. Click on **External accounts** +3. Click on the link **Link my Google Account** +4. You are redirected to the **Google Consent screen** +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 Google Account**. + +Your name and email are automatically updated from your Google Account. Installation instructions ------------------------- -### Setting up OAuth 2.0 +### Setting up OAuth 2.0 in Google Developer Console -Follow the [official Google documentation](https://developers.google.com/accounts/docs/OAuth2Login#appsetup), in summary: - -- Go to the [Developer Console](https://console.developers.google.com) -- On the sidebar, click on **Credentials** and choose **Create a new Client Id** -- Fill the form, the redirect URL must be: **http://YOUR_SERVER/?controller=user&action=google** +- Follow the [official Google documentation](https://developers.google.com/accounts/docs/OAuth2Login#appsetup) to create a new application +- In Kanboard, you can get the **redirect url** in **Settings > Integrations > Google Authentication** ### Setting up Kanboad @@ -50,7 +50,6 @@ define('GOOGLE_CLIENT_ID', 'YOUR_CLIENT_ID'); // Google client secret key (Get this value from the Google developer console) define('GOOGLE_CLIENT_SECRET', 'YOUR_CLIENT_SECRET'); - ``` Notes diff --git a/docs/index.markdown b/docs/index.markdown index 70ff0ec4..9277ea9b 100644 --- a/docs/index.markdown +++ b/docs/index.markdown @@ -110,7 +110,7 @@ Technical details - [LDAP authentication](ldap-authentication.markdown) - [Google authentication](google-authentication.markdown) -- [GitHub authentication](github-authentication.markdown) +- [Github authentication](github-authentication.markdown) - [Reverse proxy authentication](reverse-proxy-authentication.markdown) ### Contributors |