X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/e6ddeacccea7b82fece9ad40414d949780cfa7f4..3af38eca348413c6f11f6526b2ee2ca7cb53e348:/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 7f504a919d..593e801892 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,24 +34,13 @@ 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
-
-
- -h2. Set up configuration files - -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: - - -
~$ 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
+
~$ 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. 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. +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@. @@ -95,14 +90,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 && -e /opt/rh/python27/enable ]] && source /opt/rh/python27/enable" >>~/.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 {
    @@ -162,10 +149,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,8 +165,6 @@ 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.)