Merge branch 'master' of git.curoverse.com:arvados into 2638-add-cache-age-disk-usage...

[arvados.git] / 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 68a408a09e6d70b1c8f2f2d653cdc7f35800484d..c9395c6ce736f1c51e9d84c47adee56766e0c28c 100644 (file)
--- a/doc/install/install-workbench-app.html.textile.liquid
+++ b/doc/install/install-workbench-app.html.textile.liquid
@@ -1,23 +1,52 @@
 ---
 layout: default
 navsection: installguide
-title: Install the Arvados workbench application
+title: Install the Arvados Workbench application
 ...
 
 h2. Prerequisites
 
 # A GNU/linux (virtual) machine (can be shared with the API server)
-# A hostname for your workbench application
+# A hostname for your Workbench application
+
+h2. Install dependencies
+
+If you haven't already installed the API server on the same host:
+
+* 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.
+
+Install graphviz.
+
+<notextile>
+<pre><code>~$ <span class="userinput">sudo apt-get install graphviz</span>
+</code></pre>
+</notextile>
 
 h2. Download the source tree
 
 Please follow the instructions on the "Download page":https://arvados.org/projects/arvados/wiki/Download in the wiki.
 
-The workbench application is in @arvados/apps/workbench@.
+The Workbench application is in @apps/workbench@ in the source tree.
+
+h2. Install gem dependencies
+
+<notextile>
+<pre><code>~$ <span class="userinput">cd arvados/apps/workbench</span>
+~/arvados/apps/workbench$ <span class="userinput">bundle install</span>
+</code></pre>
+</notextile>
+
+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:
+
+<notextile>
+<pre><code>~$ <span class="userinput">cd arvados/apps/workbench</span>
+~/arvados/apps/workbench$ <span class="userinput">bundle install --path=vendor/bundle</span>
+</code></pre></notextile>
 
 h2. Configure the Workbench application
 
-You need to update @config/initializers/secret_token.rb@. Generate a new secret:
+This application needs a secret token. Generate a new secret:
 
 <notextile>
 <pre><code>~/arvados/apps/workbench$ <span class="userinput">rake secret</span>
@@ -25,17 +54,12 @@ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 </code></pre>
 </notextile>
 
-and put it in @config/initializers/secret_token.rb@
+Copy @config/application.yml.example@ to @config/application.yml@ and edit it appropriately for your environment.
 
-<notextile><pre><code><span class="userinput">Server::Application.config.secret_token = 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
-</span></code></pre>
-</notextile>
-
-Adjust the following fields in your @environments/production.rb@ file.
-
-* @config.site_name@ can be the URL of your workbench install.
-* @config.arvados_login_base@ and @config.arvados_v1_base@ should point to your "API server":install-api-server.html 
-* If you choose not to use https, make sure to also set @config.force_ssl = false@ in the API server's @production.rb@ file.
+* 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@.
 
 Copy @config/piwik.yml.example@ to @config/piwik.yml@ and edit to suit.
 
@@ -47,13 +71,14 @@ h2. Trusted client setting
 
 Log in to Workbench once (this ensures that the Arvados API server has a record of the Workbench client).
 
-In the API server project root, start the rails console.  Locate the ApiClient record for your Workbench installation, then set the `is_trusted` flag for the appropriate client record:
+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:
 
 <notextile><pre><code>~/arvados/services/api$ <span class="userinput">RAILS_ENV=development bundle exec rails console</span>
-irb(main):001:0&gt; <span class="userinput">ApiClient.where('url_prefix like ?', '%workbench%')</span>
-=&gt; {:id => 1234}
-irb(main):002:0&gt; <span class="userinput">ApiClient.find(1234).update_attributes is_trusted: true</span>
+irb(main):001:0&gt; <span class="userinput">wb = ApiClient.all.last; [wb.url_prefix, wb.created_at]</span>
+=&gt; ["https://workbench.example.com/", Sat, 19 Apr 2014 03:35:12 UTC +00:00]
+irb(main):002:0&gt; <span class="userinput">include CurrentApiClient</span>
+=&gt; true
+irb(main):003:0&gt; <span class="userinput">act_as_system_user do wb.update_attributes!(is_trusted: true) end</span>
+=&gt; true
 </code></pre>
 </notextile>
-
-