Skip to content

Latest commit

 

History

History
65 lines (38 loc) · 2.66 KB

PROVISIONING.md

File metadata and controls

65 lines (38 loc) · 2.66 KB
Raw

How to provision a new environment for viim-core

This project uses the open source capistrano-mb set of tasks for capistrano to provision new environments. This document contains a quick overview of the provisioning process.

In capistrano terminology, stage refers to an environment like staging or production. These instructions will use the stage term for the remainder of the document.

In this document, provisioning refers to preparing a server for deployment, including the following steps:

  • Installing Nginx, Redis, and PostgreSQL
  • Compiling Ruby
  • Creating the database
  • Setting passwords and other configuration

Prerequisites

Capistrano runs on your local machine and uses SSH to perform the deployment on the remote server. Therefore:

  • The Capistrano gem must be installed (see README.md for project setup instructions).
  • You must have SSH access to the server.
  • Your SSH key must be installed on the server.
  • Your account on the server must have sudo access.
  • Your account must be able to run sudo without be prompted for a password. See How to run sudo command with no password?.

Furthermore, the server itself must meet the following requirements:

  • Ubuntu 14.04 LTS (64 bit).

1. Create a new stage (or edit an existing one)

Stages are defined as .rb files in the config/deploy/ directory. The name of the file becomes the name of the stage when executing capistrano commands. For example, the production stage is defined in config/deploy/production.rb.

Create a new stage (or modify an existing one to move that stage to a new server address, for example) using the existing stage files as examples. The stage file describes the IP address of the server and other stage-specific information.

2. Run the provision command

bundle exec cap <stage> provision:14_04

Replace <stage> with the name of the stage you wish to provision (e.g. production).

You will be prompted to choose passwords and enter other configuration values as the script runs.

It is safe to run the provision command multiple times on the same stage (the scripts are generally idempotent).

3. Install a custom SSL key and certificate (optional)

You can upload your SSL key and certificate to the following location:

/etc/ssl/viim_core.key
/etc/ssl/viim_core.crt

Make sure the files are owned by root with permissions 600.

Once uploaded, restart nginx using this command:

sudo service nginx restart

4. Deploy

Once provisioning is complete, deploy the application using the capistrano instructions in DEPLOYMENT.md.