Add workbench install instructions.
authorWard Vandewege <ward@clinicalfuture.com>
Tue, 11 Jun 2013 20:18:26 +0000 (16:18 -0400)
committerWard Vandewege <ward@clinicalfuture.com>
Tue, 11 Jun 2013 20:18:26 +0000 (16:18 -0400)
doc/install/index.md
doc/install/install-workbench-app.md [new file with mode: 0644]

index 2242b687972ab485dd3b2a006671ee04074245de..ea7dca8a1e1298e8399857cb7dd37019d331ff62 100644 (file)
@@ -11,6 +11,6 @@ navorder: 0
 
 1. Set up a cluster, or use Amazon
 1. Create and mount Keep volumes
-1. Create a controller VM and install the Arvados REST API server
-1. Create an administrator account
+1. [Install the Arvados REST API server](install-api-server.html)
+1. [Install the Arvados workbench application](install-workbench-app.html)
 1. Set up the Job manager
diff --git a/doc/install/install-workbench-app.md b/doc/install/install-workbench-app.md
new file mode 100644 (file)
index 0000000..2170fb3
--- /dev/null
@@ -0,0 +1,54 @@
+---
+layout: default
+navsection: installguide
+title: Install the API server
+navorder: 1
+---
+
+{% include alert-stub.html %}
+
+# Workbench setup
+
+## Prerequisites
+
+1. A GNU/linux (virtual) machine (can be shared with the API server)
+2. A hostname for your workbench application
+
+## Download the source tree
+
+Please follow the instructions on the [Download page](https://arvados.org/projects/arvados/wiki/Download) in the wiki.
+
+## Configure the Workbench application
+
+You need to update config/initializers/secret_token.rb. Generate a new secret with
+
+  rake secret
+
+and put it in config/initializers/secret_token.rb:
+
+  Server::Application.config.secret_token = 'your-new-secret-here'
+
+Then edit your
+
+    environments/production.rb
+
+file. 
+
+You will need to adjust the following fields 
+
+    config.arvados_login_base
+    config.arvados_v1_base
+    config.site_name
+
+The *config.site_name* can be set to the URL for your workbench install.
+
+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.
+
+## Apache/Passenger
+
+Set up Apache and Passenger. Point them to the apps/workbench directory in the source tree.
+
+