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 # "Install dependencies":#dependencies
  15 # "Update config.yml":#update-config
  16 # "Update Nginx configuration":#update-nginx
  17 # "Install arvados-composer":#install-packages
  18 # "Restart the API server and controller":#restart-api
  19 # "Confirm working installation":#confirm-working
  20
  21 h2(#dependencies). Install dependencies
  22
  23 In addition to Arvados core services, Composer requires "Arvados hosted git repositories":install-arv-git-httpd.html which are used for storing workflow files.
  24
  25 h2(#configure). Update config.yml
  26
  27 Edit @config.yml@ and set @Services.Composer.ExternalURL@ to the location from which it is served:
  28
  29 <notextile>
  30 <pre><code>    Services:
  31       Composer:
  32         ExternalURL: <span class="userinput">https://workbench.CusterID.example.com/composer</span></code></pre>
  33 </notextile>
  34
  35 h2(#update-nginx). Update nginx configuration
  36
  37 Composer may be served from the same host as Workbench.  Composer communicates directly with the Arvados API server.  It does not require its own backend and should be served as a static file.
  38
  39 Add the following @location@ sections to @/etc/nginx/conf.d/arvados-workbench.conf@ .
  40
  41 <notextile>
  42 <pre><code>server {
  43   [...]
  44
  45   location /composer {
  46     root   /var/www/arvados-composer;
  47     index  index.html;
  48   }
  49
  50   location /composer/composer.yml {
  51     return 200 '{ "API_HOST": "<span class="userinput">ClusterID.example.com</span>" }';
  52   }
  53 }
  54 </code></pre>
  55 </notextile>
  56
  57 {% assign arvados_component = 'arvados-composer' %}
  58
  59 {% include 'install_packages' %}
  60
  61 {% include 'restart_api' %}
  62
  63 h2(#confirm-working). Confirm working installation
  64
  65 Visit @https://workbench.ClusterID.example.com/composer@ in a browser.  You should be able to log in using the login method you configured previously.