From ffb0e256890dc2f5df8bade156982cb4954ff6b1 Mon Sep 17 00:00:00 2001 From: Ramaraju-1996 Date: Thu, 2 Mar 2017 13:16:08 +0530 Subject: [PATCH] Fixing issue #1315 The file changes try to fix issue #1315(Document openid implementation better). --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fceb365b..6ad4fe70 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -107,3 +107,20 @@ config.ichain_force_test_username = "testuser" # set email of 'testuser' config.ichain_force_test_attributes = {:email => "testuser@example.com"} ``` + +### Using openID in development mode +In order to use [openID](http://openid.net/) logins for your OSEM installation you need to register your application with the providers ([Google](https://code.google.com/apis/console#:access), [GitHub](https://github.com/settings/applications/new) or [Facebook](https://developers.facebook.com/)) and enter their API keys in `config/secrets.yml` file, changing the existing sample values. +####Note: +1.Since we are taking into consideration the 'development' environment, please do the replacement in the below steps under the 'development' section. +2.For any other environment, please do the replacement in the below steps under the respective environment sections. +####Steps to be followed: +1.Create 'config/secrets.yml' file. +2.'config/secrets.yml' file has to be similar to the 'config/secrets.yml.example' file. +3.Run 'rake secret' and note down the secret key base. +4.Set this secret key base to the secret_key_base placeholder. +5.Now we have to register your application with the providers ([Google](https://code.google.com/apis/console#:access), [GitHub](https://github.com/settings/applications/new) or [Facebook](https://developers.facebook.com/)). +  a.In order to register with the application, we will take an example of how to integrate facebook and it can be similarly done with other providers. +  b.Join as a developer on [Facebook](https://developers.facebook.com/). +  c.Create a new app and complete filling your app details. +  d.On the app's dashboard, the app's ID/key and app's secret will be present. Note them down. +  e.Replace the noted values in facebook_key and facebook_secret placeholders in 'config.secrets.yml'.