X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/1d0a332825dfdb9f72c76eefacdca50f01bd67ed..dfff0d837f55f7880242c676dfe35369a057072c:/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..9f37f0e628 100644 --- a/doc/install/install-composer.html.textile.liquid +++ b/doc/install/install-composer.html.textile.liquid @@ -11,57 +11,51 @@ 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. 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 - -
~$ sudo apt-get install arvados-composer
-
-
- -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: -
~$ sudo yum install arvados-composer
-
+
    Services:
+      Composer:
+        ExternalURL: https://workbench.CusterID.example.com/composer
-h2. Configure +h2(#update-nginx). Update nginx configuration -h3. Nginx +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. -Add Composer to your Nginx configuration. This example will host Composer at @/composer@. +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". -
-location /composer {
+
+
location /composer {
   root   /var/www/arvados-composer
   index  index.html
 }
-
-h3. composer.yml +location /composer.yml { + return 200 '{ "API_HOST": "ClusterID.example.com" }'; +} +
+ -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.