From 6ae43acde6cd43c6383cd47e00f978ed339ea991 Mon Sep 17 00:00:00 2001 From: Azul Date: Sun, 7 Oct 2012 15:06:16 +0200 Subject: added basic documentation --- DEPLOY.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 DEPLOY.md (limited to 'DEPLOY.md') diff --git a/DEPLOY.md b/DEPLOY.md new file mode 100644 index 0000000..49d9fed --- /dev/null +++ b/DEPLOY.md @@ -0,0 +1,30 @@ +# Deployment # + +These instructions are targeting a Debian GNU/Linux system. You might need to change the commands to match your own needs. + +## Server Preperation ## + +### Dependencies ## + +The following packages need to be installed: + +* git +* ruby1.8 +* rubygems1.8 +* couchdb (if you want to use a local couch) + +### Setup Capistrano ### + +We use capistrano to deploy. +We ship an example deploy.rb in config/deploy.rb.example. Edit it to match your needs. + +run '''cap deploy:setup''' to create the directory structure. + +run '''cap deploy''' to deploy to the server. + +## Customized Files ## + +Please make sure your deploy includes the following files: + +* config/cert +* public/config/provider.json -- cgit v1.2.3