X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/56de379ae4a118adf1dc314378decb9bc6675386..067a68b5e9dfa1c7d5e68fd64553e0ced89cad36:/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 6b94c8f2b3..f3a320b102 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.
@@ -9,53 +9,56 @@ Copyright (C) The Arvados Authors. All rights reserved.
SPDX-License-Identifier: CC-BY-SA-3.0
{% endcomment %}
+# "Update config.yml":#update-config
+# "Update Nginx configuration":#update-nginx
+# "Install arvados-workbench2":#install-packages
+# "Restart the API server and controller":#restart-api
+# "Confirm working installation":#confirm-working
+# "Trusted client setting":#trusted_client
+
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(#install_workbench). Install Workbench2 and dependencies
-
-Workbench2 does not require its own database. It is a set of html, javascript and css files that are served as static files from a web server like Nginx or Apache2.
+h2(#configure). Update config.yml
-On a Debian-based system, install the following package:
+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
Edit the http section of your Nginx configuration to serve Workbench2's files. You might add a block like the following, adding SSL and logging parameters to taste:~$ sudo apt-get install arvados-workbench2
+
Services:
+ Workbench2:
+ ExternalURL: "https://workbench2.ClusterID.example.com"
-~$ sudo yum install arvados-workbench2
-
-
-server {
- listen [your public IP address]:443 ssl;
- server_name workbench2.uuid-prefix.your.domain;
+ 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": "uuid-prefix.your.domain" }';
+ return 200 '{ "API_HOST": "ClusterID.example.com" }';
}
location / {
@@ -68,23 +71,32 @@ For best performance, we recommend you use Nginx as your Web server to serve Wor
}
}
irb(main):001:0> wb = ApiClient.all.last; [wb.url_prefix, wb.created_at]
-=> ["https://workbench2.uuid_prefix.your.domain/", Sat, 20 Apr 2019 01:23:45 UTC +00:00]
+=> ["https://workbench.example.com/", Sat, 19 Apr 2014 03:35:12 UTC +00:00]
irb(main):002:0> include CurrentApiClient
=> true
irb(main):003:0> act_as_system_user do wb.update_attributes!(is_trusted: true) end