15572: Documentation tweaks from experience installing dev cluster

[arvados.git] / doc / install / install-composer.html.textile.liquid

diff --git a/doc/install/install-composer.html.textile.liquid b/doc/install/install-composer.html.textile.liquid
index 9bd25ed790de08bd2e3c7e9946269e6ff5d87031..9f37f0e628495854f9256883dd2bff98ed6dd9da 100644 (file)
--- a/doc/install/install-composer.html.textile.liquid
+++ b/doc/install/install-composer.html.textile.liquid
@@ -3,57 +3,59 @@ layout: default
 navsection: installguide
 title: Install Composer
 ...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
 
-Arvados Composer is a single-page javascript application for building Common Workflow Languge (CWL) Workflows.
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
 
-h2. Prerequisites
+Arvados Composer is a web-based javascript application for building Common Workflow Languge (CWL) Workflows.
 
-In addition to Arvados core services, Composer requires "Arvados hosted git repositories":install-arv-git-httpd.html which are used for storing workflow files.
+# "Install dependencies":#dependencies
+# "Update config.yml":#update-config
+# "Update Nginx configuration":#update-nginx
+# "Install arvados-composer":#install-packages
+# "Restart the API server and controller":#restart-api
+# "Confirm working installation":#confirm-working
 
-h2. Install
+h2(#dependencies). Install dependencies
 
-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.
+In addition to Arvados core services, Composer requires "Arvados hosted git repositories":install-arv-git-httpd.html which are used for storing workflow files.
 
-On a Debian-based system, install the following package:
+h2(#configure). Update config.yml
 
-<notextile>
-<pre><code>~$ <span class="userinput">sudo apt-get install arvados-composer</span>
-</code></pre>
-</notextile>
-
-On a Red Hat-based system, install the following package:
+Edit @config.yml@ and set @Services.Composer.ExternalURL@ to the location from which it is served:
 
 <notextile>
-<pre><code>~$ <span class="userinput">sudo yum install arvados-composer</span>
-</code></pre>
+<pre><code>    Services:
+      Composer:
+        ExternalURL: <span class="userinput">https://workbench.CusterID.example.com/composer</span></code></pre>
 </notextile>
 
-h2. Configure
-
-h3. composer.yml
-
-Edit @/etc/arvados/composer/composer.yml@ and set @apiEndPoint@ to your API server:
+h2(#update-nginx). Update nginx configuration
 
-<pre>
-apiEndPoint: https://zzzzz.arvadosapi.com
-</pre>
+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.
 
-h3. Nginx
+Use a text editor to create a new file @/etc/nginx/conf.d/arvados-composer.conf@ with the following configuration.  Options that need attention are marked with "TODO".
 
-Add Composer to your Nginx configuration.  This example will host Composer at @/composer@.
-
-<pre>
-location /composer {
+<notextile>
+<pre><code>location /composer {
   root   /var/www/arvados-composer
   index  index.html
 }
-</pre>
 
-h3. Workbench link to composer
+location /composer.yml {
+  return 200 '{ "API_HOST": "<span class="userinput">ClusterID.example.com</span>" }';
+}
+</code></pre>
+</notextile>
+
+{% assign arvados_component = 'arvados-composer' %}
+
+{% include 'install_packages' %}
+
+{% include 'restart_api' %}
 
-Edit the workbench @application.yml@ and set @composer_url@ to the location from which it is served.
+h2(#confirm-working). Confirm working installation
 
-<pre>
-production:
-  composer_url: 'https://workbench.zzzzz.arvadosapi.com/composer'
-</pre>
+Visit @https://workbench.ClusterID.example.com/composer@ in a browser.  You should be able to log in using the login method you configured previously.