X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/4995783a3270e2f6d2d3b5226238fbbccf2864c1..7fb83a3380e62721801a4980c48ba78208c7b2e2:/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 be6a04de21..c9395c6ce7 100644 --- a/doc/install/install-workbench-app.html.textile.liquid +++ b/doc/install/install-workbench-app.html.textile.liquid @@ -9,11 +9,40 @@ h2. Prerequisites # A GNU/linux (virtual) machine (can be shared with the API server) # 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. + + +
~$ sudo apt-get install graphviz
+
+
+ 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 + + +
~$ 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 @@ -42,11 +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:
~/arvados/services/api$ RAILS_ENV=development bundle exec rails console
-irb(main):001:0> ApiClient.where('url_prefix like ?', '%workbench%')
-=> {:id => 1234}
-irb(main):002:0> ApiClient.find(1234).update_attributes is_trusted: true
+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
+=> true