doc/install/install-composer.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install Composer
   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 Arvados Composer is a web-based javascript application for building Common Workflow Languge (CWL) Workflows.
  13
  14 h2. Prerequisites
  15
  16 In addition to Arvados core services, Composer requires "Arvados hosted git repositories":install-arv-git-httpd.html which are used for storing workflow files.
  17
  18 h2. Install
  19
  20 Composer may be installed on the same host as Workbench, or on a different host.  Composer communicates directly with the Arvados API server.  It does not require its own backend and should be served as a static file.
  21
  22 On a Debian-based system, install the following package:
  23
  24 <notextile>
  25 <pre><code>~$ <span class="userinput">sudo apt-get install arvados-composer</span>
  26 </code></pre>
  27 </notextile>
  28
  29 On a Red Hat-based system, install the following package:
  30
  31 <notextile>
  32 <pre><code>~$ <span class="userinput">sudo yum install arvados-composer</span>
  33 </code></pre>
  34 </notextile>
  35
  36 h2. Configure
  37
  38 h3. Nginx
  39
  40 Add Composer to your Nginx configuration.  This example will host Composer at @/composer@.
  41
  42 <pre>
  43 location /composer {
  44   root   /var/www/arvados-composer
  45   index  index.html
  46 }
  47 </pre>
  48
  49 h3. composer.yml
  50
  51 Create @/var/www/arvados-composer/composer.yml@ and set @API_HOST@ to your API server:
  52
  53 <pre>
  54 API_HOST: zzzzz.arvadosapi.com
  55 </pre>
  56
  57 h3. Workbench link to composer
  58
  59 Edit @config.yml@ and set @Services.Composer.ExternalURL@ to the location from which it is served:
  60
  61 <notextile>
  62 <pre><code>Clusters:
  63   zzzzz:
  64     Services:
  65       Composer:
  66         ExternalURL: <span class="userinput">https://workbench.zzzzz.arvadosapi.com/composer</span></code></pre>
  67 </notextile>