doc/install/install-workbench-app.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install Workbench
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 h2. Install prerequisites
  13
  14 The Arvados package repository includes a Workbench server package that can help automate much of the deployment.
  15
  16 h3(#install_ruby_and_bundler). Install Ruby and Bundler
  17
  18 {% include 'install_ruby_and_bundler' %}
  19
  20 h2(#install_workbench). Install Workbench and dependencies
  21
  22 Workbench doesn't need its own database, so it does not need to have PostgreSQL installed.
  23
  24 {% assign rh_version = "7" %}
  25 {% include 'note_python_sc' %}
  26
  27 On a Debian-based system, install the following packages:
  28
  29 <notextile>
  30 <pre><code>~$ <span class="userinput">sudo apt-get install bison build-essential graphviz git python-arvados-python-client arvados-workbench</span>
  31 </code></pre>
  32 </notextile>
  33
  34 On a Red Hat-based system, install the following packages:
  35
  36 <notextile>
  37 <pre><code>~$ <span class="userinput">sudo yum install bison make automake gcc gcc-c++ graphviz git python-arvados-python-client arvados-workbench</span>
  38 </code></pre>
  39 </notextile>
  40
  41 h2(#configure). Configure Workbench
  42
  43 Edit @/etc/arvados/workbench/application.yml@ following the instructions below.  Workbench reads both @application.yml@ and its own @config/application.defaults.yml@ file.  Values in @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 Workbench and is provided for installation convenience only.
  44
  45 Consult @config/application.default.yml@ for a full list of configuration options.  Always put your local configuration in @/etc/arvados/workbench/application.yml@&mdash;never edit @config/application.default.yml@.
  46
  47 h3. secret_token
  48
  49 This application needs a secret token. Generate a new secret:
  50
  51 <notextile>
  52 <pre><code>~$ <span class="userinput">ruby -e 'puts rand(2**400).to_s(36)'</span>
  53 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
  54 </code></pre>
  55 </notextile>
  56
  57 Then put that value in the @secret_token@ field.
  58
  59 h3. arvados_login_base and arvados_v1_base
  60
  61 Point @arvados_login_base@ and @arvados_v1_base@ at your "API server":install-api-server.html. For example like this:
  62
  63 <notextile>
  64 <pre><code>arvados_login_base: https://prefix_uuid.your.domain/login
  65 arvados_v1_base: https://prefix_uuid.your.domain/arvados/v1
  66 </code></pre>
  67 </notextile>
  68
  69 h3. site_name
  70
  71 @site_name@ can be set to any arbitrary string. It is used to identify this Workbench to people visiting it.
  72
  73 h3. arvados_insecure_https
  74
  75 If the SSL certificate you use for your API server isn't an official certificate signed by a CA, make sure @arvados_insecure_https@ is @true@.
  76
  77 h3. Other options
  78
  79 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@.
  80
  81 h2. Configure Piwik
  82
  83 In @/var/www/arvados-workbench/current/config@, copy @piwik.yml.example@ to @piwik.yml@ and edit to suit.
  84
  85 h2. Set up Web server
  86
  87 For best performance, we recommend you use Nginx as your Web server front-end, with a Passenger backend to serve Workbench.  To do that:
  88
  89 <notextile>
  90 <ol>
  91 <li><a href="https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/nginx/oss/install_passenger_main.html">Install Nginx and Phusion Passenger</a>.</li>
  92
  93 <li><p>Edit the http section of your Nginx configuration to run the Passenger server, and act as a front-end for it.  You might add a block like the following, adding SSL and logging parameters to taste:</p>
  94
  95 <pre><code>server {
  96   listen 127.0.0.1:9000;
  97   server_name localhost-workbench;
  98
  99   root /var/www/arvados-workbench/current/public;
 100   index  index.html index.htm index.php;
 101
 102   passenger_enabled on;
 103   # If you're using RVM, uncomment the line below.
 104   #passenger_ruby /usr/local/rvm/wrappers/default/ruby;
 105
 106   # `client_max_body_size` should match the corresponding setting in
 107   # the API server's Nginx configuration.
 108   client_max_body_size 128m;
 109 }
 110
 111 upstream workbench {
 112   server     127.0.0.1:9000  fail_timeout=10s;
 113 }
 114
 115 proxy_http_version 1.1;
 116
 117 server {
 118   listen       <span class="userinput">[your public IP address]</span>:443 ssl;
 119   server_name  workbench.<span class="userinput">uuid-prefix.your.domain</span>;
 120
 121   ssl on;
 122   ssl_certificate     <span class="userinput">/YOUR/PATH/TO/cert.pem</span>;
 123   ssl_certificate_key <span class="userinput">/YOUR/PATH/TO/cert.key</span>;
 124
 125   index  index.html index.htm index.php;
 126   # `client_max_body_size` should match the corresponding setting in
 127   # the API server's Nginx configuration.
 128   client_max_body_size 128m;
 129
 130   location / {
 131     proxy_pass            http://workbench;
 132     proxy_redirect        off;
 133     proxy_connect_timeout 90s;
 134     proxy_read_timeout    300s;
 135
 136     proxy_set_header      X-Forwarded-Proto https;
 137     proxy_set_header      Host $http_host;
 138     proxy_set_header      X-Real-IP $remote_addr;
 139     proxy_set_header      X-Forwarded-For $proxy_add_x_forwarded_for;
 140   }
 141 }
 142 </code></pre>
 143 </li>
 144
 145 <li>Restart Nginx.</li>
 146
 147 </ol>
 148 </notextile>
 149
 150 h2. Prepare the Workbench deployment
 151
 152 {% assign railspkg = "arvados-workbench" %}
 153 {% include 'install_rails_reconfigure' %}
 154
 155 {% include 'notebox_begin' %}
 156 You can safely ignore the following error message you may see when Ruby Gems are installed:
 157 <notextile>
 158 <pre><code>themes_for_rails at /usr/local/rvm/gems/ruby-2.1.1/bundler/gems/themes_for_rails-1fd2d7897d75 did not have a valid gemspec.
 159 This prevents bundler from installing bins or native extensions, but that may not affect its functionality.
 160 The validation message from Rubygems was:
 161   duplicate dependency on rails (= 3.0.11, development), (>= 3.0.0) use:
 162     add_runtime_dependency 'rails', '= 3.0.11', '>= 3.0.0'
 163 Using themes_for_rails (0.5.1) from https://github.com/holtkampw/themes_for_rails (at 1fd2d78)
 164 </code></pre>
 165 </notextile>
 166 {% include 'notebox_end' %}
 167
 168 h2. Trusted client setting
 169
 170 Log in to Workbench once to ensure that the Arvados API server has a record of the Workbench client. (It's OK if Workbench says your account hasn't been activated yet. We'll deal with that next.)
 171
 172 In the <strong>API server</strong> project root, start the Rails console.  {% include 'install_rails_command' %}
 173
 174 At the console, enter the following commands to locate the ApiClient record for your Workbench installation (typically, while you're setting this up, the @last@ one in the database is the one you want), then set the @is_trusted@ flag for the appropriate client record:
 175
 176 <notextile><pre><code>irb(main):001:0&gt; <span class="userinput">wb = ApiClient.all.last; [wb.url_prefix, wb.created_at]</span>
 177 =&gt; ["https://workbench.example.com/", Sat, 19 Apr 2014 03:35:12 UTC +00:00]
 178 irb(main):002:0&gt; <span class="userinput">include CurrentApiClient</span>
 179 =&gt; true
 180 irb(main):003:0&gt; <span class="userinput">act_as_system_user do wb.update_attributes!(is_trusted: true) end</span>
 181 =&gt; true
 182 </code></pre>
 183 </notextile>
 184
 185 h2(#admin-user). Add an admin user
 186
 187 Next, we're going to use the Rails console on the <strong>API server</strong> to activate your account and give yourself admin privileges.  {% include 'install_rails_command' %}
 188
 189 Enter the following commands at the console:
 190
 191 <notextile>
 192 <pre><code>irb(main):001:0&gt; <span class="userinput">Thread.current[:user] = User.all.select(&:identity_url).last</span>
 193 irb(main):002:0&gt; <span class="userinput">Thread.current[:user].update_attributes is_admin: true, is_active: true</span>
 194 irb(main):003:0&gt; <span class="userinput">User.where(is_admin: true).collect &:email</span>
 195 =&gt; ["root", "<b>your_address@example.com</b>"]
 196 </code></pre></notextile>
 197
 198 At this point, you should have a working Workbench login with administrator privileges. Revisit your Workbench URL in a browser and reload the page to access it.