X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/b91db14a4dced9d6ea124e86be3c796e6f2c8e8c..d8d9b01ba4a5f9cbc216c43f8af88af1413673d4:/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 eaf4edecdd..7ee8db92f1 100644
--- a/doc/install/install-workbench-app.html.textile.liquid
+++ b/doc/install/install-workbench-app.html.textile.liquid
@@ -1,102 +1,106 @@
---
layout: default
navsection: installguide
-title: Install the Arvados Workbench application
+title: Install Workbench
...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
-h2. Prerequisites
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
-# A GNU/linux (virtual) machine (can be shared with the API server)
-# A hostname for your Workbench application
+# "Install dependencies":#dependencies
+# "Update config.yml":#update-config
+# "Update Nginx configuration":#update-nginx
+# "Trusted client flag":#trusted_client
+# "Install arvados-workbench":#install-packages
+# "Restart the API server and controller":#restart-api
+# "Confirm working installation":#confirm-working
-h2. Install dependencies
+h2(#dependencies). Install dependencies
-If you haven't already installed the API server on the same host:
+# "Install Ruby and Bundler":ruby.html
+# "Install nginx":nginx.html
+# "Install Phusion Passenger":https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/nginx/oss/install_passenger_main.html
-* 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(#configure). Update config.yml
-Install graphviz.
+Edit @config.yml@ to set the keys below. The full set of configuration options are in the "Workbench section of config.yml":{{site.baseurl}}/admin/config.html
-~$ sudo apt-get install graphviz
+ Services:
+ Workbench1:
+ ExternalURL: "https://workbench.ClusterID.example.com"
+ Workbench:
+ SecretKeyBase: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+ Users:
+ AutoAdminFirstUser: true
-h2. Download the source tree
-
-
-~$ cd $HOME # (or wherever you want to install)
-~$ git clone https://github.com/curoverse/arvados.git
-
-
-See also: "Downloading the source code":https://arvados.org/projects/arvados/wiki/Download on the Arvados wiki.
-
-The Workbench application is in @apps/workbench@ in the source tree.
-
-h2. Install gem dependencies
-
-
-~$ cd arvados/apps/workbench
-~/arvados/apps/workbench$ bundle install
-
-
-
-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:
-
-
-~$ cd arvados/apps/workbench
-~/arvados/apps/workbench$ bundle install --path=vendor/bundle
-
-
-h2. Configure the Workbench application
-
This application needs a secret token. Generate a new secret:
-~/arvados/apps/workbench$ rake secret
+~$ ruby -e 'puts rand(2**400).to_s(36)'
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
-Copy @config/application.yml.example@ to @config/application.yml@ and edit it appropriately for your environment.
-
-* 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.
-* If the SSL certificate you use for development isn't signed by a CA, make sure @arvados_insecure_https@ is @true@.
+Then put that value in the @Workbench.SecretKeyBase@ field.
-Copy @config/piwik.yml.example@ to @config/piwik.yml@ and edit to suit.
+You probably want to enable @Users.AutoAdminFirstUser@ . The first user to log in when no other admin user exists will automatically be made an admin.
-h2. Start a standalone server
+h2(#update-nginx). Update nginx configuration
-For testing and development, the easiest way to get started is to run the web server that comes with Rails.
+Use a text editor to create a new file @/etc/nginx/conf.d/arvados-workbench.conf@ with the following configuration. Options that need attention are marked in red.
-~/arvados/apps/workbench$ bundle exec rails server --port=3031
+server {
+ listen 80;
+ server_name workbench.ClusterID.example.com;
+ return 301 https://workbench.ClusterID.example.com$request_uri;
+}
+
+server {
+ listen 443 ssl;
+ server_name workbench.ClusterID.example.com;
+
+ ssl_certificate /YOUR/PATH/TO/cert.pem;
+ ssl_certificate_key /YOUR/PATH/TO/cert.key;
+
+ root /var/www/arvados-workbench/current/public;
+ index index.html;
+
+ 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.MaxRequestSize and Controller's server's Nginx configuration.
+ client_max_body_size 128m;
+}
-Point your browser to http://your.host:3031/.
+h2(#trusted_client). Trusted client flag
-h2. Trusted client setting
+In the API server project root, start the Rails console. {% include 'install_rails_command' %}
-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.)
+Create an ApiClient record for your Workbench installation with the @is_trusted@ flag set.
-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:
-
-~/arvados/services/api$ bundle exec rails console
-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
-irb(main):003:0> act_as_system_user do wb.update_attributes!(is_trusted: true) end
+irb(main):001:0> include CurrentApiClient
=> true
+irb(main):002:0> act_as_system_user do ApiClient.create!(url_prefix: "https://workbench.ClusterID.example.com/", is_trusted: true) end
+=> #<ApiClient id: 2, uuid: "...", owner_uuid: "...", modified_by_client_uuid: nil, modified_by_user_uuid: "...", modified_at: "2019-12-16 14:19:10", name: nil, url_prefix: "https://workbench.ClusterID.example.com/", created_at: "2019-12-16 14:19:10", updated_at: "2019-12-16 14:19:10", is_trusted: true>
-h2. Activate your own account
+{% assign arvados_component = 'arvados-workbench' %}
+
+{% include 'install_packages' %}
+
+{% include 'restart_api' %}
-Unless you already activated your account when installing the API server, the first time you log in to Workbench you will see a message that your account is awaiting activation.
+h2(#confirm-working). Confirm working installation
-Activate your own account and give yourself administrator privileges by following the instructions in the "'Add an admin user' section of the API server install page":install-api-server.html#admin-user.
+Visit @https://workbench.ClusterID.example.com@ in a browser. You should be able to log in using the login method you configured in the previous step. If @Users.AutoAdminFirstUser@ is true, you will be an admin user.