From 7029c854c0eaae4c56b0aa4db9a7c5c716cc6886 Mon Sep 17 00:00:00 2001
From: Ward Vandewege <ward@jhvc.com>
Date: Tue, 21 May 2013 16:21:24 -0400
Subject: [PATCH] Add (rudimentary) install instructions for the API server.

---
 doc/install/install-api-server.md | 63 +++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 doc/install/install-api-server.md

diff --git a/doc/install/install-api-server.md b/doc/install/install-api-server.md
new file mode 100644
index 0000000000..6c0f555871
--- /dev/null
+++ b/doc/install/install-api-server.md
@@ -0,0 +1,63 @@
+---
+layout: default
+navsection: installguide
+title: Install the API server
+navorder: 1
+---
+
+{% include alert-stub.html %}
+
+# API server setup
+
+## Prerequisites
+
+1. A GNU/linux (virtual) machine
+2. A domain name for your api server
+
+## Download the source tree
+
+Please follow the instructions on the [Download page](https://arvados.org/projects/arvados/wiki/Download) in the wiki.
+
+## Configure the API server
+
+First configure the database:
+
+    cp config/database.yml.sample config/database.yml
+
+Edit database.yml to your liking and make sure the database and db user exist.
+Then set up the database:
+ 
+    RAILS_ENV=production rake db:setup
+
+Then set up omniauth:
+
+    cp config/initializers/omniauth.rb.example config/initializers/omniauth.rb
+
+Edit config/initializers/omniauth.rb. Choose an APP_SECRET and APP_ID. Also set
+CUSTOM_PROVIDER_URL.
+
+Make sure your Omniauth provider knows about your APP_ID and APP_SECRET
+combination.
+
+Finally, edit your
+
+    environments/production.rb
+
+file. Specifically, you want to make sure that 
+
+    config.uuid_prefix
+
+is set to a unique 5-digit hex string. You can replace the 'cfi-aws-0' string
+with a string of your choice to make that happen.
+
+The config.uuid_prefix string is a unique identifier for your API server. It
+also serves as the first part of the hostname for your API server, for instance
+
+    9ujm1.orvosapi.com
+
+You should use your own domain instead of orvosapi.com
+
+## Apache/Passenger
+
+Set up Apache and Passenger. Point them to the services/api directory in the source tree.
+
-- 
2.30.2