Documentation about using OpenID

README.md

@@ -19,7 +19,7 @@ git clone https://github.com/openSUSE/osem.git
 bundle install
 ```
 3. Install ImageMagick from your distribution repository
-4. Generate secret key for devise and the rails app with 
+4. Generate secret key for devise and the rails app with
 ```
 rake secret
 ```
@@ -39,12 +39,18 @@ bundle exec rake db:setup
 ```
 rails server
 ```
-8. Visit the APP at 
+8. Visit the APP at
 ```
 http://localhost:3000
 ```
 9. Sign up, the first user will be automatically assigned the admin role.
 
+10. Use openID
+In order to use the OpenID feature you need to register your application with the providers
+(Google and Facebook) and enter their API keys in config/secrets.yml file, changing the existing sample values.
+You can register as a devoloper with Google from https://code.google.com/apis/console#:access
+You can register as a devoloper with Facebook from https://developers.facebook.com/
+
 ### Run OSEM in production
 We recommend to run OSEM in production with [mod_passenger](https://www.phusionpassenger.com/download/#open_source)
 and the [apache web-server](https://www.apache.org/). There are tons of guides on how to deploy rails apps on various
@@ -53,8 +59,8 @@ base operating systems. Check Google ;-)
 ## Documentation
 OSEM is extensively (some would say maniacally ;-) documented. You can generate a nice HTML documentation with ''rdoc''
 ```
-bundle exec rdoc --op doc/app --all -f fivefish app 
-xdg-open doc/app/index.html 
+bundle exec rdoc --op doc/app --all -f fivefish app
+xdg-open doc/app/index.html
 ```
 
 ## Testing

config/secrets.yml.example

@@ -5,11 +5,17 @@ defaults: &defaults
   secret_key_base: '12345'
 
   # For devise login tokens
-  devise_secret_key: '12345' 
+  devise_secret_key: '12345'
 
   # Your errbit API key
   # errbit_key: '12345'
 
+  google_key: 'changeme'
+  google_secret: 'changeme'
+
+  facebook_key: 'changeme'
+  facebook_secret: 'changeme'
+
 development:
   <<: *defaults