Display OAuth2 urls on integration page and update doc

This commit is contained in:
Frederic Guillot
2015-07-16 20:58:22 -04:00
parent ede1f1d9b0
commit 94068019db
4 changed files with 90 additions and 80 deletions

View File

@@ -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