X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/829fd7e3d772182d322682505df2c99df4b2a9e2..a9335a762f70e30affdb259e2ff487f27963f1c8:/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 52a69f502b..c27e8c523b 100644 --- a/doc/install/install-workbench-app.html.textile.liquid +++ b/doc/install/install-workbench-app.html.textile.liquid @@ -6,7 +6,7 @@ title: Install Workbench h2. Install prerequisites -The Arvados package repository includes Workbench server package that can help automate much of the deployment. +The Arvados package repository includes a Workbench server package that can help automate much of the deployment. h3(#install_ruby_and_bundler). Install Ruby and Bundler @@ -16,6 +16,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' %} + On a Debian-based system, install the following packages: @@ -30,22 +32,9 @@ On a Red Hat-based system, install the following packages: -{% include 'note_python27_sc' %} - -h2. Set up configuration files +h2(#configure). Configure Workbench -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
-
-
- -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. +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@. @@ -93,9 +82,9 @@ For best performance, we recommend you use Nginx as your Web server front-end, w
    -
  1. Install Nginx and Phusion Passenger.
  2. +
  3. Install Nginx and Phusion Passenger.
  4. -
  5. If you're deploying on CentOS and using the python27 Software Collection, configure Nginx to use it: +
  6. 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'
    @@ -115,6 +104,10 @@ For best performance, we recommend you use Nginx as your Web server front-end, w
       passenger_enabled on;
       # If you're using RVM, uncomment the line below.
       #passenger_ruby /usr/local/rvm/wrappers/default/ruby;
    +
    +  # `client_max_body_size` should match the corresponding setting in
    +  # the API server's Nginx configuration.
    +  client_max_body_size 128m;
     }
     
     upstream workbench {
    @@ -132,6 +125,8 @@ server {
       ssl_certificate_key /YOUR/PATH/TO/cert.key;
     
       index  index.html index.htm index.php;
    +  # `client_max_body_size` should match the corresponding setting in
    +  # the API server's Nginx configuration.
       client_max_body_size 128m;
     
       location / {
    @@ -156,10 +151,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.
    @@ -171,16 +167,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
    @@ -191,11 +186,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"]