X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/102df19458ef2c97d1ef4ba0e571e3204d7073e6..9cc5ed8fb634fa4f22f7bbaed8de0e5052c89f87:/doc/install/install-workbench2-app.html.textile.liquid diff --git a/doc/install/install-workbench2-app.html.textile.liquid b/doc/install/install-workbench2-app.html.textile.liquid index e873ad1e73..6315961182 100644 --- a/doc/install/install-workbench2-app.html.textile.liquid +++ b/doc/install/install-workbench2-app.html.textile.liquid @@ -1,7 +1,7 @@ --- layout: default navsection: installguide -title: Install Workbench2 (beta) +title: Install Workbench 2 ... {% comment %} Copyright (C) The Arvados Authors. All rights reserved. @@ -19,42 +19,44 @@ SPDX-License-Identifier: CC-BY-SA-3.0 Workbench2 is the web-based user interface for Arvados. {% include 'notebox_begin' %} -Workbench2 is the replacement for Arvados Workbench. Workbench2 is currently in beta, it is not yet feature complete. +Workbench2 is the replacement for Arvados Workbench. Workbench2 is suitable for day-to-day use, but does not yet implement every feature of the traditional Workbench. {% include 'notebox_end' %} h2(#configure). Update config.yml -Edit @/etc/arvados/config.yml@ to set the keys below. The full set of configuration options are in the "Workbench section of config.yml":{{site.baseurl}}/admin/config.html +Edit @config.yml@ to set the keys below. The full set of configuration options are in the "Workbench section of config.yml":{{site.baseurl}}/admin/config.html
    Services:
       Workbench2:
-        ExternalURL: "https://workbench2.ClustedID.example.com"
+        ExternalURL: "https://workbench2.ClusterID.example.com"
 
-h2. Vocabulary configuration (optional) - -Workbench2 can load a vocabulary file which lists available metadata properties for groups and collections. To configure the property vocabulary definition, please visit the "Workbench2 Vocabulary Format":{{site.baseurl}}/admin/workbench2-vocabulary.html page in the Admin section. - h2(#update-nginx). Update Nginx configuration Workbench2 does not require its own database. It is a set of html, javascript and css files that are served as static files from Nginx. -Use a text editor to create a new file @/etc/nginx/conf.d/arvados-workbench2.conf@ with the following configuration. Options that need attention are marked with "TODO". +Use a text editor to create a new file @/etc/nginx/conf.d/arvados-workbench2.conf@ with the following configuration. Options that need attention are marked in red.
server {
-  listen       [your public IP address]:443 ssl;
+    listen       80;
+    server_name  workbench2.ClusterID.example.com;
+    return 301   https://workbench2.ClusterID.example.com$request_uri;
+}
+
+server {
+  listen       443 ssl;
   server_name  workbench2.ClusterID.example.com;
 
-  ssl on;
   ssl_certificate     /YOUR/PATH/TO/cert.pem;
   ssl_certificate_key /YOUR/PATH/TO/cert.key;
 
   index  index.html;
 
-  # Workbench2 uses a call to /config.json to bootstrap itself and talk to the desired API server
+  # Workbench2 uses a call to /config.json to bootstrap itself
+  # and find out where to contact the API server.
   location /config.json {
     return 200 '{ "API_HOST": "ClusterID.example.com" }';
   }
@@ -71,6 +73,10 @@ Use a text editor to create a new file @/etc/nginx/conf.d/arvados-workbench2.con
 
+h2. Vocabulary configuration + +Workbench2 will load, if available, a vocabulary definition which lists available metadata properties for groups and collections. To learn how to configure the property vocabulary definition, please visit the "Metadata Vocabulary Format":{{site.baseurl}}/admin/metadata-vocabulary.html page in the Admin section. + {% assign arvados_component = 'arvados-workbench2' %} {% include 'install_packages' %}