Skip to content

Latest commit

 

History

History
55 lines (44 loc) · 2.91 KB

installation.md

File metadata and controls

55 lines (44 loc) · 2.91 KB

Installation

Heaven is a rails app that was designed to be hosted on heroku.

Process Management

You need redis for resque and as many workers as you think you'll need. I'd keep it at two until you start to notice queuing.

$ heroku ps:scale worker=2

Configuration

Everything should have been configured via the heroku template.

Environmental Variables
DATABASE_URL A uri for to connect to a postgresql database.
GITHUB_TOKEN A personal access token from your account settings, for API interaction.
GITHUB_CLIENT_ID The client id of the OAuth application.
GITHUB_CLIENT_SECRET The client secret of the OAuth application.
GITHUB_TEAM_ID A GitHub team id to restrict resque access to.
RAILS_SECRET_KEY_BASE The secret key for signing session cookies. This should be unique per domain.
OCTOKIT_API_ENDPOINT The full url to the GitHub API for enterprise installs. Optional. e.g. https://enterprise.myorg.com/api/v3
OCTOKIT_WEB_ENDPOINT The full url to the GitHub UI for enterprise installs. Optional. e.g. https://enterprise.myorg.com/

Optional Configuration

Environmental Variables
DEPLOYMENT_PRIVATE_KEY An ssh private key used to login to your remote servers via SSH. Put it all on one line with \n in it.
DEPLOYMENT_TIMEOUT A timeout in seconds that the deployment should take. Deployments are aborted if they exceed this value. Defaults to 300 seconds
HEROKU_API_KEY A direct authorization token from heroku
REDIS_PROVIDER If you use a different provider than OpenRedis, set this to the name of the env var with Redis' URL (e.g. REDISTOGO_URL)