X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/19ae770973482257117fe8ded5619c3018c4b60f..6d95130da47af9fd0290d3c8f80a0364faf74957:/doc/install/install-workbench-app.html.textile.liquid diff --git a/doc/install/install-workbench-app.html.textile.liquid b/doc/install/install-workbench-app.html.textile.liquid index 5a60ca5484..72a80fd834 100644 --- a/doc/install/install-workbench-app.html.textile.liquid +++ b/doc/install/install-workbench-app.html.textile.liquid @@ -3,6 +3,11 @@ layout: default navsection: installguide title: Install Workbench ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. + +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} h2. Install prerequisites @@ -16,7 +21,8 @@ h2(#install_workbench). Install Workbench and dependencies Workbench doesn't need its own database, so it does not need to have PostgreSQL installed. -{% include 'note_python27_sc' %} +{% assign rh_version = "7" %} +{% include 'note_python_sc' %} On a Debian-based system, install the following packages: @@ -28,17 +34,15 @@ On a Debian-based system, install the following packages: On a Red Hat-based system, install the following packages: -
~$ sudo yum install bison make automake gcc gcc-c++ graphviz git python27-python-arvados-python-client arvados-workbench
+
~$ sudo yum install bison make automake gcc gcc-c++ graphviz git python-arvados-python-client arvados-workbench
 
h2(#configure). Configure Workbench -Edit @/etc/arvados/workbench/application.yml@ following the instructions below. Workbench reads both @application.yml@ and its own @config/application.defaults.yml@ file. Values in @application.yml@ take precedence over the defaults that are defined in @config/application.defaults.yml@. The @config/application.yml.example@ file is not read by Workbench and is provided for installation convenience only. - -Consult @config/application.default.yml@ for a full list of configuration options. Always put your local configuration in @/etc/arvados/workbench/application.yml@—never edit @config/application.default.yml@. +Edit @/etc/arvados/config.yml@ to set the keys below. Only the most important configuration options are listed here. The full set of configuration options are in the "Workbench section of config.yml":{{site.baseurl}}/admin/config.html -h3. secret_token +h3. Workbench.SecretKeyBase This application needs a secret token. Generate a new secret: @@ -48,33 +52,57 @@ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
-Then put that value in the @secret_token@ field. +Then put that value in the @Workbench.SecretKeyBase@ field. -h3. arvados_login_base and arvados_v1_base + +
Cluster:
+  zzzzz:
+    Workbench:
+      SecretKeyBase: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+
+
-Point @arvados_login_base@ and @arvados_v1_base@ at your "API server":install-api-server.html. For example like this: +h3. Services.Controller.ExternalURL + +Ensure that @Services.Controller.ExternalURL@ is configured for "Arvados Controller":install-controller.html . For example like this: -
arvados_login_base: https://prefix_uuid.your.domain/login
-arvados_v1_base: https://prefix_uuid.your.domain/arvados/v1
+
Cluster:
+  zzzzz:
+    Services:
+      Controller:
+        ExternalURL: https://prefix_uuid.your.domain
 
-h3. site_name +h3. Workbench.SiteName + +@Workbench.SiteName@ can be set to any arbitrary string. It is used to identify this Workbench to people visiting it. -@site_name@ can be set to any arbitrary string. It is used to identify this Workbench to people visiting it. -h3. arvados_insecure_https + +
Cluster:
+  zzzzz:
+    Workbench:
+      SiteName: My Arvados
+
+
-If the SSL certificate you use for your API server isn't an official certificate signed by a CA, make sure @arvados_insecure_https@ is @true@. +h3. TLS.Insecure -h3. Other options +For testing only. Allows use of self-signed certificates. If true, workbench will not verify the TLS certificate of Arvados Controller. -Consult @application.default.yml@ for a full list of configuration options. Always put your local configuration in @application.yml@ instead of editing @application.default.yml@. + +
Cluster:
+  zzzzz:
+    TLS:
+      Insecure: false
+
+
-h2. Configure Piwik +h2. Configure Piwik (optional) -In @/var/www/arvados-workbench/current/config@, copy @piwik.yml.example@ to @piwik.yml@ and edit to suit. +Piwik can be used to gather usage analytics. In @/var/www/arvados-workbench/current/config@, copy @piwik.yml.example@ to @piwik.yml@ and edit to suit. h2. Set up Web server @@ -84,14 +112,6 @@ For best performance, we recommend you use Nginx as your Web server front-end, w
  1. Install Nginx and Phusion Passenger.
  2. -
  3. If you're deploying on an older Red Hat-based distribution and installed Pythyon 2.7 from Software Collections, configure Nginx to use it: - -
    ~$ sudo usermod --shell /bin/bash nginx
    -~$ sudo -u nginx sh -c 'echo "[[ -z \$PS1 ]] && source scl_source enable python27" >>~/.bash_profile'
    -
    - -
  4. -
  5. Edit the http section of your Nginx configuration to run the Passenger server, and act as a front-end for it. You might add a block like the following, adding SSL and logging parameters to taste:

    server {
    @@ -106,7 +126,7 @@ For best performance, we recommend you use Nginx as your Web server front-end, w
       #passenger_ruby /usr/local/rvm/wrappers/default/ruby;
     
       # `client_max_body_size` should match the corresponding setting in
    -  # the API server's Nginx configuration.
    +  # the API.MaxRequestSize and Controller's server's Nginx configuration.
       client_max_body_size 128m;
     }
     
    @@ -126,7 +146,7 @@ server {
     
       index  index.html index.htm index.php;
       # `client_max_body_size` should match the corresponding setting in
    -  # the API server's Nginx configuration.
    +  # the API.MaxRequestSize and Controller's server's Nginx configuration.
       client_max_body_size 128m;
     
       location / {