---
layout: default
navsection: installguide
title: Install Composer
...
{% comment %}
Copyright (C) The Arvados Authors. All rights reserved.
SPDX-License-Identifier: CC-BY-SA-3.0
{% endcomment %}
Arvados Composer is a web-based javascript application for building Common Workflow Languge (CWL) Workflows.
# "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(#dependencies). Install dependencies
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(#configure). Update config.yml
Edit @config.yml@ and set @Services.Composer.ExternalURL@ to the location from which it is served:
Services:
Composer:
ExternalURL: https://workbench.CusterID.example.com/composer
h2(#update-nginx). Update nginx configuration
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.
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 {
root /var/www/arvados-composer
index index.html
}
location /composer.yml {
return 200 '{ "API_HOST": "ClusterID.example.com" }';
}
h2(#install-packages). Install arvados-composer
h3. Centos 7
# yum install arvados-composer
h3. Debian and Ubuntu
# apt-get --no-install-recommends install arvados-composer
h2(#restart-api). Restart the API server and controller
After adding Workbench to the Services section, make sure the cluster config file is up to date on the API server host, and restart the API server and controller processes to ensure the changes are applied.
# systemctl restart nginx arvados-controller
h2(#confirm-working). Confirm working installation
Visit @https://workbench.ClusterID.example.com/composer@ in a browser. You should be able to log in using the login method you configured previously.