X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/5a477e71cb61c2e560e699881ac6a1d5a2fab602..d8856736576e492edf08eba46b523880569e5123:/doc/install/install-sso.html.textile.liquid diff --git a/doc/install/install-sso.html.textile.liquid b/doc/install/install-sso.html.textile.liquid index 4222ea62e5..f272d857a7 100644 --- a/doc/install/install-sso.html.textile.liquid +++ b/doc/install/install-sso.html.textile.liquid @@ -6,7 +6,7 @@ title: Install Single Sign On (SSO) server h2(#dependencies). Install dependencies -Make sure you have "Ruby and bundler":install-manual-prerequisites-ruby.html installed. +Make sure you have "Ruby and Bundler":install-manual-prerequisites-ruby.html installed. h2(#install). Install SSO server @@ -17,8 +17,8 @@ h3. Get SSO server code and create database ~$ git clone https://github.com/curoverse/sso-devise-omniauth-provider.git ~$ cd sso-devise-omniauth-provider ~/sso-devise-omniauth-provider$ bundle install -~/sso-devise-omniauth-provider$ rake db:create -~/sso-devise-omniauth-provider$ rake db:migrate +~/sso-devise-omniauth-provider$ RAILS_ENV=production bundle exec rake db:create +~/sso-devise-omniauth-provider$ RAILS_ENV=production bundle exec rake db:migrate @@ -38,11 +38,11 @@ Edit @config/initializers/secret_token.rb@ to set @config.secret_token@ to the s h3. Configure upstream authentication provider -
~/sso-devise-omniauth-provider$ cp -i config/environment.rb.example config/environment.rb
+
~/sso-devise-omniauth-provider$ cp -i config/environments/production.rb.example config/environments/production.rb
 
-Edit @config/environment.rb@ to set @config.google_client_id@ and @config.google_client_secret@. See "Omniauth Google OAuth2 gem documentation":https://github.com/zquestz/omniauth-google-oauth2 and "Using OAuth 2.0 to Access Google APIs":https://developers.google.com/accounts/docs/OAuth2 for information about using the "Google Developers Console":https://console.developers.google.com to get a Google client id and client secret. +Edit @config/environments/production.rb@ to set @config.google_oauth2_client_id@ and @config.google_oauth2_client_secret@. See "Omniauth Google OAuth2 gem documentation":https://github.com/zquestz/omniauth-google-oauth2 and "Using OAuth 2.0 to Access Google APIs":https://developers.google.com/accounts/docs/OAuth2 for information about using the "Google Developers Console":https://console.developers.google.com to get a Google client id and client secret. h3(#client). Create arvados-server client @@ -51,7 +51,7 @@ Use @rails console@ to create a @Client@ record that will be used by the Arvados
~/sso-devise-omniauth-provider$ rake secret
 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-~/sso-devise-omniauth-provider$ rails console
+~/sso-devise-omniauth-provider$ RAILS_ENV=production bundle exec rails console
 irb(main):001:0> c = Client.new
 irb(main):002:0> c.name = "joshid"
 irb(main):003:0> c.app_id = "arvados-server"
@@ -60,3 +60,18 @@ irb(main):005:0> c.save!
 irb(main):006:0> quit
 
+ +h2. Start the SSO server + +h3. Run a simple standalone server + +You can use the Webrick server that is bundled with Ruby to quickly verify that your installation is functioning: + + +
~/arvados/services/api$ RAILS_ENV=production bundle exec rails server
+
+
+ +h3. Production environment + +As a Ruby on Rails application, the SSO server should be compatible with any Ruby application server that supports Rack applications. We recommend "Passenger":https://www.phusionpassenger.com/ to run the SSO server in production.