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

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install Workbench 2
   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 # "Update config.yml":#update-config
  13 # "Update Nginx configuration":#update-nginx
  14 # "Install arvados-workbench2":#install-packages
  15 # "Restart the API server and controller":#restart-api
  16 # "Confirm working installation":#confirm-working
  17 # "Trusted client setting":#trusted_client
  18
  19 Workbench2 is the web-based user interface for Arvados.
  20
  21 {% include 'notebox_begin' %}
  22 Workbench2 is the replacement for Arvados Workbench. Workbench2 is suitable for day-to-day use, but does not yet implement every feature of the traditional Workbench.
  23 {% include 'notebox_end' %}
  24
  25 h2(#configure). Update config.yml
  26
  27 Edit @config.yml@ to set the keys below.  The full set of configuration options are in the "Workbench section of config.yml":{{site.baseurl}}/admin/config.html
  28
  29 <notextile>
  30 <pre><code>    Services:
  31       Workbench2:
  32         ExternalURL: <span class="userinput">"https://workbench2.ClusterID.example.com"</span>
  33 </code></pre>
  34 </notextile>
  35
  36 h2(#update-nginx). Update Nginx configuration
  37
  38 Workbench2 does not require its own database. It is a set of html, javascript and css files that are served as static files from Nginx.
  39
  40 Use a text editor to create a new file @/etc/nginx/conf.d/arvados-workbench2.conf@ with the following configuration.  Options that need attention are marked in <span class="userinput">red</span>.
  41
  42 <notextile>
  43 <pre><code>server {
  44     listen       80;
  45     server_name  workbench2.<span class="userinput">ClusterID.example.com</span>;
  46     return 301   https://workbench2.<span class="userinput">ClusterID.example.com</span>$request_uri;
  47 }
  48
  49 server {
  50   listen       *:443 ssl;
  51   server_name  workbench2.<span class="userinput">ClusterID.example.com</span>;
  52
  53   ssl on;
  54   ssl_certificate     <span class="userinput">/YOUR/PATH/TO/cert.pem</span>;
  55   ssl_certificate_key <span class="userinput">/YOUR/PATH/TO/cert.key</span>;
  56
  57   index  index.html;
  58
  59   # <span class="userinput">Workbench2 uses a call to /config.json to bootstrap itself</span>
  60   # <span class="userinput">and find out where to contact the API server.</span>
  61   location /config.json {
  62     return 200 '{ "API_HOST": "<span class="userinput">ClusterID.example.com</span>" }';
  63   }
  64
  65   location / {
  66     root      /var/www/arvados-workbench2/workbench2;
  67     index     index.html;
  68     try_files $uri $uri/ /index.html;
  69     if (-f $document_root/maintenance.html) {
  70       return 503;
  71     }
  72   }
  73 }
  74 </code></pre>
  75 </notextile>
  76
  77 h2. Vocabulary configuration (optional)
  78
  79 Workbench2 can load a vocabulary file which lists available metadata properties for groups and collections.  To configure the property vocabulary definition, please visit the "Workbench2 Vocabulary Format":{{site.baseurl}}/admin/workbench2-vocabulary.html page in the Admin section.
  80
  81 {% assign arvados_component = 'arvados-workbench2' %}
  82
  83 {% include 'install_packages' %}
  84
  85 {% include 'restart_api' %}
  86
  87 h2(#confirm-working). Confirm working installation
  88
  89 Visit @https://workbench2.ClusterID.example.com@ in a browser.  You should be able to log in using the login method you configured in the previous step.  If @Users.AutoAdminFirstUser@ is true, you will be an admin user.
  90
  91 h2(#trusted_client). Trusted client flag
  92
  93 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.)
  94
  95 In the <strong>API server</strong> project root, start the Rails console.  {% include 'install_rails_command' %}
  96
  97 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:
  98
  99 <notextile><pre><code>irb(main):001:0&gt; <span class="userinput">wb = ApiClient.all.last; [wb.url_prefix, wb.created_at]</span>
 100 =&gt; ["https://workbench.example.com/", Sat, 19 Apr 2014 03:35:12 UTC +00:00]
 101 irb(main):002:0&gt; <span class="userinput">include CurrentApiClient</span>
 102 =&gt; true
 103 irb(main):003:0&gt; <span class="userinput">act_as_system_user do wb.update_attributes!(is_trusted: true) end</span>
 104 =&gt; true
 105 </code></pre>
 106 </notextile>