X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/19c292c1757bf98ecb3f1979c0b759f54c0aad7a..35016e091b321c41b6632d32a45f4b5591e98c67:/doc/install/install-api-server.html.textile.liquid diff --git a/doc/install/install-api-server.html.textile.liquid b/doc/install/install-api-server.html.textile.liquid index a1cca3d8b4..6440a54e4d 100644 --- a/doc/install/install-api-server.html.textile.liquid +++ b/doc/install/install-api-server.html.textile.liquid @@ -4,44 +4,30 @@ navsection: installguide title: Install the API server ... -h2. Prerequisites: +This installation guide assumes you are on a 64 bit Debian or Ubuntu system. -# A GNU/Linux (virtual) machine -# A domain name for your api server - -h2(#dependencies). Install dependencies +h2. Install prerequisites -
~$ sudo apt-get install libcurl3 libcurl3-gnutls libcurl4-openssl-dev \
-    libxslt1.1 zlib1g-dev gettext bison libssl-dev libreadline-dev \
-    libpq-dev sqlite3 libsqlite3-dev build-essential wget postgresql sudo
+
~$ sudo apt-get install \
+    bison build-essential gettext libcurl3 libcurl3-gnutls \
+    libcurl4-openssl-dev libpcre3-dev libpq-dev libreadline-dev \
+    libssl-dev libxslt1.1 postgresql sudo wget zlib1g-dev
 

 
-h2(#ruby). Install Ruby and bundler
-
-We recommend Ruby >= 2.1.
-
-
-
mkdir -p ~/src
-cd ~/src
-wget http://cache.ruby-lang.org/pub/ruby/2.1/ruby-2.1.1.tar.gz
-tar xzf ruby-2.1.1.tar.gz
-cd ruby-2.1.1
-./configure
-make
-sudo make install
-
-sudo gem install bundler
-

+Also make sure you have "Ruby and bundler":install-manual-prerequisites-ruby.html installed.
 
 h2. Download the source tree
 
 
-
~$ git clone https://github.com/curoverse/arvados.git
+
~$ cd $HOME # (or wherever you want to install)
+~$ git clone https://github.com/curoverse/arvados.git
 

 
 See also: "Downloading the source code":https://arvados.org/projects/arvados/wiki/Download on the Arvados wiki.
 
+The API server is in @services/api@ in the source tree.
+
 h2. Install gem dependencies
 
 
@@ -49,25 +35,45 @@ h2. Install gem dependencies
 ~/arvados/services/api$ bundle install
 

 
+h2. Choose your environment
+
+The API server can be run in @development@ or in @production@ mode. Unless this installation is going to be used for development on the Arvados API server itself, you should run it in @production@ mode.
+
+Copy the example environment file for your environment. For example, if you choose @production@:
+
+
+
~/arvados/services/api$ cp -i config/environments/production.rb.example config/environments/production.rb
+

+
 h2. Configure the API server
 
-Edit the main configuration:
+First, copy the example configuration file:
 
 
 
~/arvados/services/api$ cp -i config/application.yml.example config/application.yml
 

 
-Choose a unique 5-character alphanumeric string to use as your @uuid_prefix@. An example is given that generates a 5-character string based on a hash of your hostname. The @uuid_prefix@ is a unique identifier for your API server. It also serves as the first part of the hostname for your API server.
+The API server reads the @config/application.yml@ file, as well as the @config/application.defaults.yml@ file. Values in @config/application.yml@ take precedence over the defaults that are defined in @config/application.defaults.yml@. The @config/application.yml.example@ file is not read by the API server and is provided for installation convenience, only.
+
+Consult @config/application.default.yml@ for a full list of configuration options. Always put your local configuration in @config/application.yml@, never edit @config/application.default.yml@.
+
+h3(#uuid_prefix). uuid_prefix
 
-For a development site, use your own domain instead of arvadosapi.com.
+It is recommended to explicitly define your @uuid_prefix@ in @config/application.yml@, by setting the 'uuid_prefix' field in the section for your environment.
 
-Make sure a clone of the arvados repository exists in @git_repositories_dir@:
+h3(#git_repositories_dir). git_repositories_dir
+
+This field defaults to @/var/lib/arvados/git@. You can override the value by defining it in @config/application.yml@.
+
+Make sure a clone of the arvados repository exists in @git_repositories_dir@.
 
 
-
~/arvados/services/api$ sudo mkdir -p /var/cache/git
-~/arvados/services/api$ sudo git clone --bare ../../.git /var/cache/git/arvados.git
+
~/arvados/services/api$ sudo mkdir -p /var/lib/arvados/git
+~/arvados/services/api$ sudo git clone --bare ../../.git /var/lib/arvados/git/arvados.git
 

 
+h3. secret_token
+
 Generate a new secret token for signing cookies:
 
 
@@ -75,15 +81,24 @@ Generate a new secret token for signing cookies:
 zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
 

 
-Put it in @config/application.yml@ in the production or common section:
+Then put that value in the @secret_token@ field.
 
-
-
    secret_token: zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
-

-
+h3. blob_signing_key
+
+If you want access control on your "Keepstore":install-keepstore.html server(s), you should set @blob_signing_key@ to the same value as the permission key you provide to your Keepstore daemon(s).
+
+h3. workbench_address
+
+Fill in the url of your workbench application in in @workbench_address@, for example 
+
+  https://workbench.@prefix_uuid@.your.domain
+
+h3. other options
 
 Consult @application.default.yml@ for a full list of configuration options. Always put your local configuration in @application.yml@ instead of editing @application.default.yml@.
 
+h2. Set up the database
+
 Generate a new database password. Nobody ever needs to memorize it or type it, so we'll make a strong one:
 
 
@@ -109,55 +124,70 @@ Configure API server to connect to your database by creating and updating @confi
 ~/arvados/services/api$ edit config/database.yml
-Create and initialize the database. +Create and initialize the database. If you are planning a production system, choose the @production@ rails environment, otherwise use @development@. -
~/arvados/services/api$ RAILS_ENV=development bundle exec rake db:setup
+
~/arvados/services/api$ RAILS_ENV=production bundle exec rake db:setup
 

 
-Set up omniauth:
+Alternatively, if the database user you intend to use for the API server is not allowed to create new databases, you can create the database first and then populate it with rake. Be sure to adjust the database name if you are using the @development@ environment. This sequence of commands is functionally equivalent to the rake db:setup command above.
 
 
-
~/arvados/services/api$ cp -i config/initializers/omniauth.rb.example config/initializers/omniauth.rb
+
~/arvados/services/api$ su postgres createdb arvados_production -E UTF8 -O arvados
+~/arvados/services/api$ RAILS_ENV=production bundle exec rake db:structure:load
+~/arvados/services/api$ RAILS_ENV=production bundle exec rake db:seed
 

 
-Edit @config/initializers/omniauth.rb@. Set @APP_SECRET@ to the value of @app_secret@ from "installing the single sign on server":install-sso.html .
+

+  
+  
Note!

+You can safely ignore the following error message you may see when loading the database structure:
+
+
ERROR:  must be owner of extension plpgsql

+

+
+h2. Set up omniauth
 
-You can now run the development server:
+First copy the omniauth configuration file:
 
 
-
~/arvados/services/api$ bundle exec rails server --port=3030
+
~/arvados/services/api$ cp -i config/initializers/omniauth.rb.example config/initializers/omniauth.rb
 

 
-h3. Apache/Passenger (optional)
+Edit @config/initializers/omniauth.rb@, and tell your api server to use the Curoverse SSO server for authentication. Use the @APP_SECRET@ specified in the snippet below.
 
-You can use "Passenger":https://www.phusionpassenger.com/ for deployment. Point it to the services/api directory in the source tree.
+
+
APP_ID = 'local_docker_installation'
+APP_SECRET = 'yohbai4eecohshoo1Yoot7tea9zoca9Eiz3Tajahweo9eePaeshaegh9meiye2ph'
+CUSTOM_PROVIDER_URL = 'https://auth.curoverse.com'
+

+

 
-To enable streaming so users can monitor crunch jobs in real time, add to your Passenger configuration in Apache:
+

+  
+  
Note!

+  
You can also run your own SSO server. However, the SSO server codebase currently uses OpenID 2.0 to talk to Google's authentication service. Google has deprecated that protocol. This means that new clients will not be allowed to talk to Google's authentication services anymore over OpenID 2.0, and they will phase out the use of OpenID 2.0 completely in the coming monts. We are working on upgrading the SSO server codebase to a newer protocol. That work should be complete by the end of November 2014. In the mean time, anyone is free to use the existing Curoverse SSO server for any local Arvados installation.

+

 
-
-
PassengerBufferResponse off
-

-
+h2. Start the API server
 
-h2. Add an admin user
+h3. Development environment
 
-Point your browser to the API server's login endpoint:
+If you plan to run in development mode, you can now run the development server this way:
 
 
-
https://localhost:3030/login
-

-
+
~/arvados/services/api$ bundle exec rails server --port=3030
+

 
-Log in with your google account.
+h3. Production environment
 
-Use the rails console to give yourself admin privileges:
+We recommend "Passenger":https://www.phusionpassenger.com/ to run the API server in production. 
+
+Point it to the services/api directory in the source tree.
+
+To enable streaming so users can monitor crunch jobs in real time, make sure to add the following to your Passenger configuration:
 
 
-
~/arvados/services/api$ bundle exec rails console
-irb(main):001:0> Thread.current[:user] = User.all.select(&:identity_url).last
-irb(main):002:0> Thread.current[:user].is_admin = true
-irb(main):003:0> Thread.current[:user].update_attributes is_admin: true, is_active: true
-irb(main):004:0> User.where(is_admin: true).collect &:email
-=> ["root", "your_address@example.com"]
-

+
PassengerBufferResponse off
+

+