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 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 h3(#build_tools_workbench). Build tools
  16
  17 Workbench doesn't need its own database, so it does not need to have PostgreSQL installed.
  18
  19 On older distributions, you may need to use a backports repository to satisfy these requirements.  For example, on older Red Hat-based systems, consider using the "nginx16":https://www.softwarecollections.org/en/scls/rhscl/nginx16/ Software Collection.
  20
  21 On a Debian-based system, install the following packages:
  22
  23 <notextile>
  24 <pre><code>~$ <span class="userinput">sudo apt-get install bison build-essential graphviz git nginx python-arvados-python-client arvados-workbench</span>
  25 </code></pre>
  26 </notextile>
  27
  28 On a Red Hat-based system, install the following packages:
  29
  30 <notextile>
  31 <pre><code>~$ <span class="userinput">sudo yum install bison make automake gcc gcc-c++ graphviz git nginx python27-python-arvados-python-client arvados-workbench</span>
  32 </code></pre>
  33 </notextile>
  34
  35 {% include 'notebox_begin' %}
  36
  37 If you intend to use specific versions of these packages from Software Collections, you may have to adapt some of the package names to match; e.g., @nginx16@.
  38
  39 {% include 'notebox_end' %}
  40
  41 {% include 'note_python27_sc' %}
  42
  43 h2. Set up configuration files
  44
  45 The Workbench server package uses configuration files that you write to @/etc/arvados/workbench@ and ensures they're consistently deployed.  Create this directory and copy the example configuration files to it:
  46
  47 <notextile>
  48 <pre><code>~$ <span class="userinput">sudo mkdir -p /etc/arvados/workbench</span>
  49 ~$ <span class="userinput">sudo chmod 700 /etc/arvados/workbench</span>
  50 ~$ <span class="userinput">sudo cp /var/www/arvados-workbench/current/config/application.yml.example /etc/arvados/workbench/application.yml</span>
  51 </code></pre>
  52 </notextile>
  53
  54 h2. Configure Workbench
  55
  56 Edit @/etc/arvados/workbench/application.yml@ following the instructions below.  The deployment script will consistently deploy this to Workbench's configuration directory.  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.
  57
  58 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@.
  59
  60 h3. secret_token
  61
  62 This application needs a secret token. Generate a new secret:
  63
  64 <notextile>
  65 <pre><code>~$ <span class="userinput">ruby -e 'puts rand(2**400).to_s(36)'</span>
  66 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
  67 </code></pre>
  68 </notextile>
  69
  70 Then put that value in the @secret_token@ field.
  71
  72 h3. arvados_login_base and arvados_v1_base
  73
  74 Point @arvados_login_base@ and @arvados_v1_base@ at your "API server":install-api-server.html. For example like this:
  75
  76 <notextile>
  77 <pre><code>arvados_login_base: https://prefix_uuid.your.domain/login
  78 arvados_v1_base: https://prefix_uuid.your.domain/arvados/v1
  79 </code></pre>
  80 </notextile>
  81
  82 h3. site_name
  83
  84 @site_name@ can be set to any arbitrary string. It is used to identify this Workbench to people visiting it.
  85
  86 h3. arvados_insecure_https
  87
  88 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@.
  89
  90 h3. Other options
  91
  92 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@.
  93
  94 h2. Configure Piwik
  95
  96 In @/var/www/arvados-workbench/current/config@, copy @piwik.yml.example@ to @piwik.yml@ and edit to suit.
  97
  98 h2. Prepare the Workbench deployment
  99
 100 Now that all your configuration is in place, run @/usr/local/bin/arvados-workbench-upgrade.sh@.  This will install and check your configuration, and install necessary gems.
 101
 102 {% include 'notebox_begin' %}
 103 You can safely ignore the following error message you may see when installing gems:
 104 <notextile>
 105 <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.
 106 This prevents bundler from installing bins or native extensions, but that may not affect its functionality.
 107 The validation message from Rubygems was:
 108   duplicate dependency on rails (= 3.0.11, development), (>= 3.0.0) use:
 109     add_runtime_dependency 'rails', '= 3.0.11', '>= 3.0.0'
 110 Using themes_for_rails (0.5.1) from https://github.com/holtkampw/themes_for_rails (at 1fd2d78)
 111 </code></pre>
 112 </notextile>
 113 {% include 'notebox_end' %}
 114
 115 This command aborts when it encounters an error.  It's safe to rerun multiple times, so if there's a problem with your configuration, you can fix that and try again.
 116
 117 h2. Set up Web server
 118
 119 For best performance, we recommend you use Nginx as your Web server front-end, with a Passenger backend to serve Workbench.  To do that:
 120
 121 <notextile>
 122 <ol>
 123 <li>Install Nginx via your distribution or a backports repository.</li>
 124
 125 <li><a href="https://www.phusionpassenger.com/documentation/Users%20guide%20Nginx.html">Install Phusion Passenger for Nginx</a>.</li>
 126
 127 <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>
 128
 129 <pre><code>server {
 130   listen 127.0.0.1:9000;
 131   server_name localhost-workbench;
 132
 133   root /var/www/arvados-workbench/current/public;
 134   index  index.html index.htm index.php;
 135
 136   passenger_enabled on;
 137   # If you're using RVM, uncomment the line below.
 138   #passenger_ruby /usr/local/rvm/wrappers/default/ruby;
 139 }
 140
 141 upstream workbench {
 142   server     127.0.0.1:9000  fail_timeout=10s;
 143 }
 144
 145 proxy_http_version 1.1;
 146
 147 server {
 148   listen       <span class="userinput">[your public IP address]</span>:443 ssl;
 149   server_name  workbench.<span class="userinput">uuid-prefix.your.domain</span>;
 150
 151   ssl on;
 152
 153   index  index.html index.htm index.php;
 154
 155   location / {
 156     proxy_pass            http://workbench;
 157     proxy_redirect        off;
 158
 159     proxy_set_header      X-Forwarded-Proto https;
 160     proxy_set_header      Host $http_host;
 161     proxy_set_header      X-External-Client $external_client;
 162     proxy_set_header      X-Real-IP $remote_addr;
 163     proxy_set_header      X-Forwarded-For $proxy_add_x_forwarded_for;
 164   }
 165 }
 166 </code></pre>
 167 </li>
 168
 169 <li>Restart Nginx.</li>
 170
 171 </ol>
 172 </notextile>
 173
 174 h2. Trusted client setting
 175
 176 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.)
 177
 178 In the <strong>API server</strong> project root, start the rails console.  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:
 179
 180 <notextile><pre><code>/var/www/arvados-api/current$ <span class="userinput">RAILS_ENV=production bundle exec rails console</span>
 181 irb(main):001:0&gt; <span class="userinput">wb = ApiClient.all.last; [wb.url_prefix, wb.created_at]</span>
 182 =&gt; ["https://workbench.example.com/", Sat, 19 Apr 2014 03:35:12 UTC +00:00]
 183 irb(main):002:0&gt; <span class="userinput">include CurrentApiClient</span>
 184 =&gt; true
 185 irb(main):003:0&gt; <span class="userinput">act_as_system_user do wb.update_attributes!(is_trusted: true) end</span>
 186 =&gt; true
 187 </code></pre>
 188 </notextile>
 189
 190 h2(#admin-user). Add an admin user
 191
 192 Next, we're going to use the rails console on the <strong>API server</strong> to activate our own account and give yourself admin privileges:
 193
 194 <notextile>
 195 <pre><code>/var/www/arvados-api/current$ <span class="userinput">RAILS_ENV=production bundle exec rails console</span>
 196 irb(main):001:0&gt; <span class="userinput">Thread.current[:user] = User.all.select(&:identity_url).last</span>
 197 irb(main):002:0&gt; <span class="userinput">Thread.current[:user].is_admin = true</span>
 198 irb(main):003:0&gt; <span class="userinput">Thread.current[:user].update_attributes is_admin: true, is_active: true</span>
 199 irb(main):004:0&gt; <span class="userinput">User.where(is_admin: true).collect &:email</span>
 200 =&gt; ["root", "<b>your_address@example.com</b>"]
 201 </code></pre></notextile>
 202
 203 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.