X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/d0ecfaefd9ed9fab71e0cd8d62579a208f0eec5d..3ed6fab9c3ec7ca31133e4d4c750d546727b1847:/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 f0938e860d..58ba5d03a0 100644 --- a/doc/install/install-composer.html.textile.liquid +++ b/doc/install/install-composer.html.textile.liquid @@ -11,57 +11,55 @@ SPDX-License-Identifier: CC-BY-SA-3.0 Arvados Composer is a web-based javascript application for building Common Workflow Languge (CWL) Workflows. -h2. Prerequisites +# "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 -In addition to Arvados core services, Composer requires "Arvados hosted git repositories":install-arv-git-httpd.html which are used for storing workflow files. +h2(#dependencies). Install dependencies -h2. Install +In addition to Arvados core services, Composer requires "Arvados hosted git repositories":install-arv-git-httpd.html which are used for storing workflow files. -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. +h2(#configure). Update config.yml -On a Debian-based system, install the following package: +Edit @config.yml@ and set @Services.Composer.ExternalURL@ to the location from which it is served: -
~$ sudo apt-get install arvados-composer
-
+
    Services:
+      Composer:
+        ExternalURL: https://workbench.CusterID.example.com/composer
-On a Red Hat-based system, install the following package: +h2(#update-nginx). Update nginx configuration - -
~$ sudo yum install arvados-composer
-
-
+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. -h2. Configure +Add the following @location@ sections to @/etc/nginx/conf.d/arvados-workbench.conf@ . -h3. Nginx + +
server {
+  [...]
 
-Add Composer to your Nginx configuration.  This example will host Composer at @/composer@.
+  location /composer {
+    root   /var/www/arvados-composer;
+    index  index.html;
+  }
 
-
-location /composer {
-  root   /var/www/arvados-composer
-  index  index.html
+  location /composer/composer.yml {
+    return 200 '{ "API_HOST": "ClusterID.example.com" }';
+  }
 }
-
- -h3. composer.yml +
+
-Create @/var/www/arvados-composer/composer.yml@ and set @API_HOST@ to your API server: +{% assign arvados_component = 'arvados-composer' %} -
-API_HOST: zzzzz.arvadosapi.com
-
+{% include 'install_packages' %} -h3. Workbench link to composer +{% include 'restart_api' %} -Edit @config.yml@ and set @Services.Composer.ExternalURL@ to the location from which it is served: +h2(#confirm-working). Confirm working installation - -
Clusters:
-  zzzzz:
-    Services:
-      Composer:
-        ExternalURL: https://workbench.zzzzz.arvadosapi.com/composer
-
+Visit @https://workbench.ClusterID.example.com/composer@ in a browser. You should be able to log in using the login method you configured previously.