tweak daemontools scripts

[arvados.git] / doc / install / install-workbench-app.md

diff --git a/doc/install/install-workbench-app.md b/doc/install/install-workbench-app.md
index 2170fb30de5fd8883823605a774452eb85932770..468e161ef35c10ccaf66b7f0cd2f28adda10e598 100644 (file)
--- a/doc/install/install-workbench-app.md
+++ b/doc/install/install-workbench-app.md
@@ -1,8 +1,8 @@
 ---
 layout: default
 navsection: installguide
-title: Install the API server
-navorder: 1
+title: Install the Arvados workbench application
+navorder: 2
 ---
 
 {% include alert-stub.html %}
@@ -22,33 +22,38 @@ Please follow the instructions on the [Download page](https://arvados.org/projec
 
 You need to update config/initializers/secret_token.rb. Generate a new secret with
 
-  rake secret
+    rake secret
 
-and put it in config/initializers/secret_token.rb:
+and put it in `config/initializers/secret_token.rb`
 
-  Server::Application.config.secret_token = 'your-new-secret-here'
+    Server::Application.config.secret_token = 'your-new-secret-here'
 
-Then edit your
+Adjust the following fields in your `environments/production.rb` file.
 
-    environments/production.rb
+* `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. Use the example values as a guide.
+* If you choose not to use https, make sure to also set
+`config.force_ssl = false` in the API server's `production.rb` file.
 
-file. 
+## Apache/Passenger
 
-You will need to adjust the following fields 
+Set up Apache and Passenger. Point them to the apps/workbench directory in the source tree.
 
-    config.arvados_login_base
-    config.arvados_v1_base
-    config.site_name
+## "Trusted client" setting
 
-The *config.site_name* can be set to the URL for your workbench install.
+Log in to Workbench once (this ensures that the Arvados API server has
+a record of the Workbench client).
 
-The *config.arvados_login_base* and *config.arvados_v1_base* fields should point to
-your API server. Use the example values as a guide. If you choose not to use
-https, make sure to also set *config.force_ssl* to false in the API server
-production.rb.
+In the API server project root, start the rails console.
 
-## Apache/Passenger
+    RAILS_ENV=production bundle exec rails c
 
-Set up Apache and Passenger. Point them to the apps/workbench directory in the source tree.
+Locate the ApiClient record for your Workbench installation.
+
+    ApiClient.where('url_prefix like ?', '%workbench%')
+
+Set the `is_trusted` flag for the appropriate client record.
 
+    ApiClient.find(1234).update_attributes is_trusted: true