From a4335c0e52f246ad93965650cedf63af332f8496 Mon Sep 17 00:00:00 2001
From: Frédéric Guillot <fguillot@users.noreply.github.com>
Date: Sun, 4 May 2014 11:18:30 -0400
Subject: Add Google auth documentation

---
 docs/google-authentication.markdown | 65 +++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 docs/google-authentication.markdown

(limited to 'docs')

diff --git a/docs/google-authentication.markdown b/docs/google-authentication.markdown
new file mode 100644
index 00000000..033cf4bb
--- /dev/null
+++ b/docs/google-authentication.markdown
@@ -0,0 +1,65 @@
+Google Authentication
+=====================
+
+Requirements
+------------
+
+- OAuth Google API credentials (available in the Google Developer Console)
+
+How does this work?
+-------------------
+
+- The Google authentication in Kanboard use the OAuth 2.0 protocol
+- Any user account in Kanboard can be linked to a Google Account
+- When a Kanboard user account is linked to Google, you can login with one click
+
+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**
+
+Installation instructions
+-------------------------
+
+### Setting up OAuth 2.0
+
+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**
+
+### Setting up Kanboad
+
+Create a custom `config.php` file or copy the `config.default.php` file:
+
+```php
+<?php
+
+// Enable/disable Google authentication
+define('GOOGLE_AUTH', true); // Set this value to true
+
+// Google client id (Get this value from the Google developer console)
+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
+-----
+
+Kanboard use these information from your Google profile:
+
+- Full name
+- Email address
+- Google unique id
+
+The Google unique id is used to link together the local user account and the Google account.
-- 
cgit v1.2.3