gunghogeoduck/osem-fcy
1
0
Fork 0
mirror of https://github.com/openSUSE/osem.git synced 2026-08-13 19:54:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Documentation about using OpenID

Browse source
This commit is contained in:
Stella Rouzi 2014-06-20 15:26:15 +03:00
parent 983c08c8e4
commit 9eeb60b5cd
2 changed files with 17 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -19,7 +19,7 @@ git clone https://github.com/openSUSE/osem.git
bundle install bundle install
``` ```
3. Install ImageMagick from your distribution repository 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 rake secret
``` ```
@ -39,12 +39,18 @@ bundle exec rake db:setup
``` ```
rails server rails server
``` ```
8. Visit the APP at 8. Visit the APP at
``` ```
http://localhost:3000 http://localhost:3000
``` ```
9. Sign up, the first user will be automatically assigned the admin role. 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 ### Run OSEM in production
We recommend to run OSEM in production with [mod_passenger](https://www.phusionpassenger.com/download/#open_source) 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 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 ## Documentation
OSEM is extensively (some would say maniacally ;-) documented. You can generate a nice HTML documentation with ''rdoc'' 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 bundle exec rdoc --op doc/app --all -f fivefish app
xdg-open doc/app/index.html xdg-open doc/app/index.html
``` ```
## Testing ## Testing

8
config/secrets.yml.example
View file

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