doc/install/install-workbench-app.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install the Arvados Workbench application
   5 ...
   6
   7 h2. Prerequisites
   8
   9 # A GNU/linux (virtual) machine (can be shared with the API server)
  10 # A hostname for your Workbench application
  11
  12 h2. Download the source tree
  13
  14 Please follow the instructions on the "Download page":https://arvados.org/projects/arvados/wiki/Download in the wiki.
  15
  16 The Workbench application is in @arvados/apps/workbench@.
  17
  18 h2. Configure the Workbench application
  19
  20 This application needs a secret token. Generate a new secret:
  21
  22 <notextile>
  23 <pre><code>~/arvados/apps/workbench$ <span class="userinput">rake secret</span>
  24 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
  25 </code></pre>
  26 </notextile>
  27
  28 Copy @config/application.yml.example@ to @config/application.yml@ and edit it appropriately for your environment.
  29
  30 * Set @secret_token@ to the string you generated with @rake secret@.
  31 * Point @arvados_login_base@ and @arvados_v1_base@ at your "API server":install-api-server.html
  32 * @site_name@ can be any string to identify this Workbench.
  33 * Assuming that the SSL certificate you use for development isn't signed by a CA, make sure @arvados_insecure_https@ is @true@.
  34
  35 Copy @config/piwik.yml.example@ to @config/piwik.yml@ and edit to suit.
  36
  37 h3. Apache/Passenger (optional)
  38
  39 Set up Apache and Passenger. Point them to the apps/workbench directory in the source tree.
  40
  41 h2. Trusted client setting
  42
  43 Log in to Workbench once (this ensures that the Arvados API server has a record of the Workbench client).
  44
  45 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:
  46
  47 <notextile><pre><code>~/arvados/services/api$ <span class="userinput">RAILS_ENV=development bundle exec rails console</span>
  48 irb(main):001:0&gt; <span class="userinput">ApiClient.where('url_prefix like ?', '%workbench%')</span>
  49 =&gt; {:id => 1234}
  50 irb(main):002:0&gt; <span class="userinput">ApiClient.find(1234).update_attributes is_trusted: true</span>
  51 </code></pre>
  52 </notextile>
  53
  54