X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/e537bd8dd1ac786164f192374e0d076bdc0327f3..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 c9395c6ce7..c27e8c523b 100644 --- a/doc/install/install-workbench-app.html.textile.liquid +++ b/doc/install/install-workbench-app.html.textile.liquid @@ -1,80 +1,181 @@ --- layout: default navsection: installguide -title: Install the Arvados Workbench application +title: Install Workbench ... -h2. Prerequisites +h2. Install prerequisites -# A GNU/linux (virtual) machine (can be shared with the API server) -# A hostname for your Workbench application +The Arvados package repository includes a Workbench server package that can help automate much of the deployment. -h2. Install dependencies +h3(#install_ruby_and_bundler). Install Ruby and Bundler -If you haven't already installed the API server on the same host: +{% include 'install_ruby_and_bundler' %} -* Install Ruby 2.1 and Bundler: see the "dependencies" and "Ruby" sections on the "API server installation page":install-api-server.html#dependencies for details. -* Omit postgresql. Workbench doesn't need its own database. +h2(#install_workbench). Install Workbench and dependencies -Install graphviz. +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: + + +
~$ sudo apt-get install bison build-essential graphviz git python-arvados-python-client arvados-workbench
+
+
+ +On a Red Hat-based system, install the following packages: -
~$ sudo apt-get install graphviz
+
~$ sudo yum install bison make automake gcc gcc-c++ graphviz git python27-python-arvados-python-client arvados-workbench
 
-h2. Download the source tree +h2(#configure). Configure Workbench -Please follow the instructions on the "Download page":https://arvados.org/projects/arvados/wiki/Download in the wiki. +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. -The Workbench application is in @apps/workbench@ in the source tree. +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@. -h2. Install gem dependencies +h3. secret_token + +This application needs a secret token. Generate a new secret: -
~$ cd arvados/apps/workbench
-~/arvados/apps/workbench$ bundle install
+
~$ ruby -e 'puts rand(2**400).to_s(36)'
+aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 
-Alternatively, if you don't have sudo/root privileges on the host, install the gems in your own directory instead of installing them system-wide: +Then put that value in the @secret_token@ field. + +h3. arvados_login_base and arvados_v1_base + +Point @arvados_login_base@ and @arvados_v1_base@ at your "API server":install-api-server.html. For example like this: -
~$ cd arvados/apps/workbench
-~/arvados/apps/workbench$ bundle install --path=vendor/bundle
-
+
arvados_login_base: https://prefix_uuid.your.domain/login
+arvados_v1_base: https://prefix_uuid.your.domain/arvados/v1
+
+ -h2. Configure the Workbench application +h3. site_name -This application needs a secret token. Generate a new secret: +@site_name@ can be set to any arbitrary string. It is used to identify this Workbench to people visiting it. + +h3. arvados_insecure_https + +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@. + +h2. Configure Piwik + +In @/var/www/arvados-workbench/current/config@, copy @piwik.yml.example@ to @piwik.yml@ and edit to suit. + +h2. Set up Web server + +For best performance, we recommend you use Nginx as your Web server front-end, with a Passenger backend to serve Workbench. To do that: -
~/arvados/apps/workbench$ rake secret
-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+
    +
  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'
     
    - -Copy @config/application.yml.example@ to @config/application.yml@ and edit it appropriately for your environment. +
  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 {
    +  listen 127.0.0.1:9000;
    +  server_name localhost-workbench;
    +
    +  root /var/www/arvados-workbench/current/public;
    +  index  index.html index.htm index.php;
    +
    +  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 {
    +  server     127.0.0.1:9000  fail_timeout=10s;
    +}
     
    -* Set @secret_token@ to the string you generated with @rake secret@.
    -* Point @arvados_login_base@ and @arvados_v1_base@ at your "API server":install-api-server.html
    -* @site_name@ can be any string to identify this Workbench.
    -* Assuming that the SSL certificate you use for development isn't signed by a CA, make sure @arvados_insecure_https@ is @true@.
    +proxy_http_version 1.1;
     
    -Copy @config/piwik.yml.example@ to @config/piwik.yml@ and edit to suit.
    +server {
    +  listen       [your public IP address]:443 ssl;
    +  server_name  workbench.uuid-prefix.your.domain;
     
    -h3. Apache/Passenger (optional)
    +  ssl on;
    +  ssl_certificate     /YOUR/PATH/TO/cert.pem;
    +  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 / {
    +    proxy_pass            http://workbench;
    +    proxy_redirect        off;
    +    proxy_connect_timeout 90s;
    +    proxy_read_timeout    300s;
    +
    +    proxy_set_header      X-Forwarded-Proto https;
    +    proxy_set_header      Host $http_host;
    +    proxy_set_header      X-Real-IP $remote_addr;
    +    proxy_set_header      X-Forwarded-For $proxy_add_x_forwarded_for;
    +  }
    +}
    +
    +
  6. + +
  7. Restart Nginx.
  8. + +
+ -Set up Apache and Passenger. Point them to the apps/workbench directory in the source tree. +h2. Prepare the Workbench deployment + +{% assign railspkg = "arvados-workbench" %} +{% include 'install_rails_reconfigure' %} + +{% include 'notebox_begin' %} +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.
+The validation message from Rubygems was:
+  duplicate dependency on rails (= 3.0.11, development), (>= 3.0.0) use:
+    add_runtime_dependency 'rails', '= 3.0.11', '>= 3.0.0'
+Using themes_for_rails (0.5.1) from https://github.com/holtkampw/themes_for_rails (at 1fd2d78)
+
+
+{% include 'notebox_end' %} h2. Trusted client setting -Log in to Workbench once (this ensures that the Arvados API server has a record of the Workbench 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' %} -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: +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: -
~/arvados/services/api$ RAILS_ENV=development 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
@@ -82,3 +183,18 @@ irb(main):003:0> act_as_system_user do wb.update_attr
 => true
 
+ +h2(#admin-user). Add an admin user + +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: + + +
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"]
+
+ +At this point, you should have a working Workbench login with administrator privileges. Revisit your Workbench URL in a browser and reload the page to access it.