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