X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/b30dca66a056bc6ee627bab5956dd8884a0e74aa..6da6b846097364da3abed2abad272e9607b15ca8:/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..e873ad1e73 100644
--- a/doc/install/install-workbench2-app.html.textile.liquid
+++ b/doc/install/install-workbench2-app.html.textile.liquid
@@ -9,43 +9,44 @@ 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.
{% 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 @/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
-~$ sudo apt-get install arvados-workbench2
+ Services:
+ Workbench2:
+ ExternalURL: "https://workbench2.ClustedID.example.com"
-On a Red Hat-based system, install the following package:
+h2. Vocabulary configuration (optional)
-
-~$ sudo yum install arvados-workbench2
-
-
-
-h2. Set up Web server
+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.
-For best performance, we recommend you use Nginx as your Web server to serve Workbench2. Workbench2 consists entirely of static files. To do that:
+h2(#update-nginx). Update Nginx configuration
-
-
-- Install Nginx
+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.
-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:
+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".
+
server {
listen [your public IP address]:443 ssl;
- server_name workbench2.uuid-prefix.your.domain;
+ server_name workbench2.ClusterID.example.com;
ssl on;
ssl_certificate /YOUR/PATH/TO/cert.pem;
@@ -55,7 +56,7 @@ For best performance, we recommend you use Nginx as your Web server to serve Wor
# Workbench2 uses a call to /config.json to bootstrap itself and talk to the desired API server
location /config.json {
- return 200 '{ "API_HOST": "uuid-prefix.your.domain" }';
+ return 200 '{ "API_HOST": "ClusterID.example.com" }';
}
location / {
@@ -68,23 +69,28 @@ For best performance, we recommend you use Nginx as your Web server to serve Wor
}
}
-
-Restart Nginx.
+{% assign arvados_component = 'arvados-workbench2' %}
-
-
+{% include 'install_packages' %}
+
+{% include 'restart_api' %}
+
+h2(#confirm-working). Confirm working installation
+
+Visit @https://workbench2.ClusterID.example.com@ in a browser. You should be able to log in using the login method you configured in the previous step. If @Users.AutoAdminFirstUser@ is true, you will be an admin user.
-h2. Trusted client setting
+h2(#trusted_client). Trusted client flag
-Log in to Workbench2 once to ensure that the Arvados API server has a record of the Workbench2 client.
+Log in to Workbench once to ensure that the Arvados API server has a record of the Workbench client. (It's OK if Workbench says your account hasn't been activated yet. We'll deal with that next.)
In the API server project root, start the Rails console. {% include 'install_rails_command' %}
-At the console, enter the following commands to locate the ApiClient record for your Workbench2 installation (typically, while you're setting this up, the @last@ one in the database is the one you want), then set the @is_trusted@ flag for the appropriate client record:
+At the console, enter the following commands to locate the ApiClient record for your Workbench installation (typically, while you're setting this up, the @last@ one in the database is the one you want), then set the @is_trusted@ flag for the appropriate client record:
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