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

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