doc/install/install-api-server.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install the API server
   5 ...
   6
   7 h2. Prerequisites:
   8
   9 # A GNU/Linux (virtual) machine
  10 # A domain name for your api server
  11
  12 h2(#dependencies). Install dependencies
  13
  14 <notextile>
  15 <pre><code>~$ <span class="userinput">sudo apt-get install libcurl3 libcurl3-gnutls libcurl4-openssl-dev \
  16     libxslt1.1 zlib1g-dev gettext bison libssl-dev libreadline-dev \
  17     libpq-dev sqlite3 libsqlite3-dev build-essential wget postgresql sudo
  18 </span></code></pre></notextile>
  19
  20 h2(#ruby). Install Ruby and bundler
  21
  22 We recommend Ruby >= 2.1.
  23
  24 <notextile>
  25 <pre><code><span class="userinput">mkdir -p ~/src
  26 cd ~/src
  27 wget http://cache.ruby-lang.org/pub/ruby/2.1/ruby-2.1.1.tar.gz
  28 tar xzf ruby-2.1.1.tar.gz
  29 cd ruby-2.1.1
  30 ./configure
  31 make
  32 sudo make install
  33
  34 sudo gem install bundler</span>
  35 </code></pre></notextile>
  36
  37 h2. Download the source tree
  38
  39 <notextile>
  40 <pre><code>~$ <span class="userinput">git clone https://github.com/curoverse/arvados.git</span>
  41 </code></pre></notextile>
  42
  43 See also: "Downloading the source code":https://arvados.org/projects/arvados/wiki/Download on the Arvados wiki.
  44
  45 h2. Install gem dependencies
  46
  47 <notextile>
  48 <pre><code>~$ <span class="userinput">cd arvados/services/api</span>
  49 ~/arvados/services/api$ <span class="userinput">bundle install</span>
  50 </code></pre></notextile>
  51
  52 h2. Configure the API server
  53
  54 Edit the main configuration:
  55
  56 <notextile>
  57 <pre><code>~/arvados/services/api$ <span class="userinput">cp -i config/application.yml.example config/application.yml</span>
  58 </code></pre></notextile>
  59
  60 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.
  61
  62 For a development site, use your own domain instead of arvadosapi.com.
  63
  64 Make sure a clone of the arvados repository exists in @git_repositories_dir@:
  65
  66 <notextile>
  67 <pre><code>~/arvados/services/api$ <span class="userinput">sudo mkdir -p /var/cache/git</span>
  68 ~/arvados/services/api$ <span class="userinput">sudo git clone --bare ../../.git /var/cache/git/arvados.git</span>
  69 </code></pre></notextile>
  70
  71 Generate a new secret token for signing cookies:
  72
  73 <notextile>
  74 <pre><code>~/arvados/services/api$ <span class="userinput">rake secret</span>
  75 zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
  76 </code></pre></notextile>
  77
  78 Put it in @config/application.yml@ in the production or common section:
  79
  80 <notextile>
  81 <pre><code><span class="userinput">    secret_token: zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz</span>
  82 </code></pre>
  83 </notextile>
  84
  85 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@.
  86
  87 Generate a new database password. Nobody ever needs to memorize it or type it, so we'll make a strong one:
  88
  89 <notextile>
  90 <pre><code>~/arvados/services/api$ <span class="userinput">ruby -e 'puts rand(2**128).to_s(36)'</span>
  91 6gqa1vu492idd7yca9tfandj3
  92 </code></pre></notextile>
  93
  94 Create a new database user with permission to create its own databases.
  95
  96 <notextile>
  97 <pre><code>~/arvados/services/api$ <span class="userinput">sudo -u postgres createuser --createdb --encrypted --pwprompt arvados</span>
  98 [sudo] password for <b>you</b>: <span class="userinput">yourpassword</span>
  99 Enter password for new role: <span class="userinput">paste-password-you-generated</span>
 100 Enter it again: <span class="userinput">paste-password-again</span>
 101 Shall the new role be a superuser? (y/n) <span class="userinput">n</span>
 102 Shall the new role be allowed to create more new roles? (y/n) <span class="userinput">n</span>
 103 </code></pre></notextile>
 104
 105 Configure API server to connect to your database by creating and updating @config/database.yml@. Replace the @xxxxxxxx@ database password placeholders with the new password you generated above.
 106
 107 <notextile>
 108 <pre><code>~/arvados/services/api$ <span class="userinput">cp -i config/database.yml.sample config/database.yml</span>
 109 ~/arvados/services/api$ <span class="userinput">edit config/database.yml</span>
 110 </code></pre></notextile>
 111
 112 Create and initialize the database.
 113
 114 <notextile>
 115 <pre><code>~/arvados/services/api$ <span class="userinput">RAILS_ENV=development bundle exec rake db:setup</span>
 116 </code></pre></notextile>
 117
 118 Set up omniauth:
 119
 120 <notextile>
 121 <pre><code>~/arvados/services/api$ <span class="userinput">cp -i config/initializers/omniauth.rb.example config/initializers/omniauth.rb
 122 </code></pre></notextile>
 123
 124 Edit @config/initializers/omniauth.rb@. Set @APP_SECRET@ to the value of @app_secret@ from "installing the single sign on server":install-sso.html .
 125
 126 You can now run the development server:
 127
 128 <notextile>
 129 <pre><code>~/arvados/services/api$ <span class="userinput">bundle exec rails server --port=3030
 130 </code></pre></notextile>
 131
 132 h3. Apache/Passenger (optional)
 133
 134 You can use "Passenger":https://www.phusionpassenger.com/ for deployment. Point it to the services/api directory in the source tree.
 135
 136 To enable streaming so users can monitor crunch jobs in real time, add to your Passenger configuration in Apache:
 137
 138 <notextile>
 139 <pre><code><span class="userinput">PassengerBufferResponse off</span>
 140 </code></pre>
 141 </notextile>
 142
 143 h2. Add an admin user
 144
 145 Point your browser to the API server's login endpoint:
 146
 147 <notextile>
 148 <pre><code><span class="userinput">https://localhost:3030/login</span>
 149 </code></pre>
 150 </notextile>
 151
 152 Log in with your google account.
 153
 154 Use the rails console to give yourself admin privileges:
 155
 156 <notextile>
 157 <pre><code>~/arvados/services/api$ <span class="userinput">bundle exec rails console</span>
 158 irb(main):001:0&gt; <span class="userinput">Thread.current[:user] = User.all.select(&:identity_url).last</span>
 159 irb(main):002:0&gt; <span class="userinput">Thread.current[:user].is_admin = true</span>
 160 irb(main):003:0&gt; <span class="userinput">Thread.current[:user].update_attributes is_admin: true, is_active: true</span>
 161 irb(main):004:0&gt; <span class="userinput">User.where(is_admin: true).collect &:email</span>
 162 =&gt; ["root", "<b>your_address@example.com</b>"]
 163 </code></pre></notextile>