From 09e516cc52cea4de368e1b129c30c9cd71dd248a Mon Sep 17 00:00:00 2001 From: Ramaraju-1996 Date: Thu, 2 Mar 2017 12:23:04 +0530 Subject: [PATCH 1/2] Fixing issue #1315 These file changes tries to fix issue #1315(Document openid implementation better). --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fceb365b..c7fe3811 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,6 +97,7 @@ GitHub issues are the primary way for communicating about specific proposed chan test mode, which can be useful in development phase in which an iChain proxy is not usually configured or even available. You can enable ichain authentication by setting `OSEM_ICHAIN_ENABLED` equal to `true` in `.env` file. You would also need to set following options in `devise.rb`: + ```Ruby # Activate the test mode config.ichain_test_mode = true @@ -107,3 +108,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: +Since we are taking into consideration the 'development' environment, please do the replacement in the below steps under the 'development' section. +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 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'. From 72513f27444efce6d9ff46f191febb9549955378 Mon Sep 17 00:00:00 2001 From: Ramaraju-1996 Date: Thu, 2 Mar 2017 12:27:36 +0530 Subject: [PATCH 2/2] Fixing issue #1315 These file changes tries to fix issue #1315(Document openid implementation better). --- INSTALL.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 608b3508..e0a58cc1 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -68,8 +68,21 @@ If you would like to resize exisiting logos in your OSEM installation you can do $ bundle exec rake logo:reprocess ``` -### openID -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. +### openID +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: +Based on 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 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'. ## Recurring Jobs =======