14366: Improve wording of "upgrading to containers API" section
[arvados.git] / doc / install / install-composer.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Install Composer
5 ...
6
7 Arvados Composer is a single-page javascript application for building Common Workflow Languge (CWL) Workflows.
8
9 h2. Prerequisites
10
11 In addition to Arvados core services, Composer requires "Arvados hosted git repositories":install-arv-git-httpd.html which are used for storing workflow files.
12
13 h2. Install
14
15 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.
16
17 On a Debian-based system, install the following package:
18
19 <notextile>
20 <pre><code>~$ <span class="userinput">sudo apt-get install arvados-composer</span>
21 </code></pre>
22 </notextile>
23
24 On a Red Hat-based system, install the following package:
25
26 <notextile>
27 <pre><code>~$ <span class="userinput">sudo yum install arvados-composer</span>
28 </code></pre>
29 </notextile>
30
31 h2. Configure
32
33 h3. composer.yml
34
35 Edit @/etc/arvados/composer/composer.yml@ and set @apiEndPoint@ to your API server:
36
37 <pre>
38 apiEndPoint: https://zzzzz.arvadosapi.com
39 </pre>
40
41 h3. Nginx
42
43 Add Composer to your Nginx configuration.  This example will host Composer at @/composer@.
44
45 <pre>
46 location /composer {
47   root   /var/www/arvados-composer
48   index  index.html
49 }
50 </pre>
51
52 h3. Workbench link to composer
53
54 Edit the workbench @application.yml@ and set @composer_url@ to the location from which it is served.
55
56 <pre>
57 production:
58   composer_url: 'https://workbench.zzzzz.arvadosapi.com/composer'
59 </pre>