X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/0f0a0cd26446403fb987121af58bec550f3cf681..2bbb460a29d6f76bc50aacdba466aa6262ed93a3:/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 d05d94daa1..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,6 +21,9 @@ h2(#install_workbench). Install Workbench and dependencies Workbench doesn't need its own database, so it does not need to have PostgreSQL installed. +{% assign rh_version = "7" %} +{% include 'note_python_sc' %} + On a Debian-based system, install the following packages: @@ -26,66 +34,75 @@ 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
 

 
 
-{% include 'note_python27_sc' %}
+h2(#configure). Configure Workbench
 
-h2. Set up configuration files
+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
 
-The Workbench server package uses configuration files that you write to @/etc/arvados/workbench@ and ensures they're consistently deployed.  Create this directory and copy the example configuration files to it:
+h3. Workbench.SecretKeyBase
+
+This application needs a secret token. Generate a new secret:
 
 
-
~$ sudo mkdir -p /etc/arvados/workbench
-~$ sudo chmod 700 /etc/arvados/workbench
-~$ sudo cp /var/www/arvados-workbench/current/config/application.yml.example /etc/arvados/workbench/application.yml
+
~$ ruby -e 'puts rand(2**400).to_s(36)'
+aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 

 
 
-h2. Configure Workbench
-
-Edit @/etc/arvados/workbench/application.yml@ following the instructions below.  The deployment script will consistently deploy this to Workbench's configuration directory.  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.
+Then put that value in the @Workbench.SecretKeyBase@ field.
 
-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@.
+
+
Cluster:
+  zzzzz:
+    Workbench:
+      SecretKeyBase: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+

+
 
-h3. secret_token
+h3. Services.Controller.ExternalURL
 
-This application needs a secret token. Generate a new secret:
+Ensure that @Services.Controller.ExternalURL@ is configured for "Arvados Controller":install-controller.html . For example like this:
 
 
-
~$ ruby -e 'puts rand(2**400).to_s(36)'
-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+
Cluster:
+  zzzzz:
+    Services:
+      Controller:
+        ExternalURL: https://prefix_uuid.your.domain
 

 
 
-Then put that value in the @secret_token@ field.
+h3. Workbench.SiteName
 
-h3. arvados_login_base and arvados_v1_base
+@Workbench.SiteName@ can be set to any arbitrary string. It is used to identify this Workbench to people visiting it.
 
-Point @arvados_login_base@ and @arvados_v1_base@ at your "API server":install-api-server.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:
+    Workbench:
+      SiteName: My Arvados
 

 
 
-h3. site_name
-
-@site_name@ can be set to any arbitrary string. It is used to identify this Workbench to people visiting it.
+h3. TLS.Insecure
 
-h3. arvados_insecure_https
+For testing only.  Allows use of self-signed certificates.  If true, workbench will not verify the TLS certificate of Arvados Controller.
 
-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. Other options
-
-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
 
@@ -95,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. 
 
-
  2. If you're deploying on CentOS and using the python27 Software Collection, configure Nginx to use it:
-
-
    ~$ sudo usermod --shell /bin/bash nginx
-~$ sudo -u nginx sh -c 'echo "[[ -z \$PS1 && -e /opt/rh/python27/enable ]] && source /opt/rh/python27/enable" >>~/.bash_profile'
-
    
-
-
    3. 
-
 
  3. 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 {
@@ -117,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;
 }
 
@@ -137,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 / {
@@ -162,10 +171,11 @@ server {
 
 h2. Prepare the Workbench deployment
 
-Now that all your configuration is in place, run @/usr/local/bin/arvados-workbench-upgrade.sh@.  This will install and check your configuration, and install necessary gems.
+{% assign railspkg = "arvados-workbench" %}
+{% include 'install_rails_reconfigure' %}
 
 {% include 'notebox_begin' %}
-You can safely ignore the following error message you may see when installing gems:
+You can safely ignore the following error message you may see when Ruby Gems are installed:
 
 
    themes_for_rails at /usr/local/rvm/gems/ruby-2.1.1/bundler/gems/themes_for_rails-1fd2d7897d75 did not have a valid gemspec.
 This prevents bundler from installing bins or native extensions, but that may not affect its functionality.
@@ -177,16 +187,15 @@ Using themes_for_rails (0.5.1) from https://github.com/holtkampw/themes_for_rail
 
 {% include 'notebox_end' %}
 
-This command aborts when it encounters an error.  It's safe to rerun multiple times, so if there's a problem with your configuration, you can fix that and try again.
-
 h2. Trusted client setting
 
 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.  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:
+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 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:
 
-
    /var/www/arvados-api/current$ RAILS_ENV=production bundle exec rails console
-irb(main):001:0> wb = ApiClient.all.last; [wb.url_prefix, wb.created_at]
+
    irb(main):001:0> wb = ApiClient.all.last; [wb.url_prefix, wb.created_at]
 => ["https://workbench.example.com/", Sat, 19 Apr 2014 03:35:12 UTC +00:00]
 irb(main):002:0> include CurrentApiClient
 => true
@@ -197,11 +206,12 @@ irb(main):003:0> act_as_system_user do wb.update_attr
 
 h2(#admin-user). Add an admin user
 
-Next, we're going to use the rails console on the API server to activate our own account and give yourself admin privileges:
+Next, we're going to use the Rails console on the API server to activate your account and give yourself admin privileges.  {% include 'install_rails_command' %}
+
+Enter the following commands at the console:
 
 
-
    /var/www/arvados-api/current$ RAILS_ENV=production bundle exec rails console
-irb(main):001:0> Thread.current[:user] = User.all.select(&:identity_url).last
+
    irb(main):001:0> Thread.current[:user] = User.all.select(&:identity_url).last
 irb(main):002:0> Thread.current[:user].update_attributes is_admin: true, is_active: true
 irb(main):003:0> User.where(is_admin: true).collect &:email
 => ["root", "your_address@example.com"]