Skip to content

Latest commit

 

History

History
88 lines (70 loc) · 3.94 KB

installation.md

File metadata and controls

88 lines (70 loc) · 3.94 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)

Launch using Docker

# create a network
docker network create heaven

# create a postgres container
docker run --name heaven-postgres -d --net heaven -e POSTGRES_USER=heaven postgres:latest

# create a redis container
docker run --name heaven-redis -d --net heaven redis:latest

# create a list of environment variables
cat >env.list <<EOF
DATABASE_URL=postgres://heaven@heaven-postgres/heaven
GITHUB_TOKEN=xxx
GITHUB_CLIENT_ID=xxx
GITHUB_CLIENT_SECRET=xxx
GITHUB_TEAM_ID=xxx
REDIS_PROVIDER=REDIS_CONTAINER_URL
REDIS_CONTAINER_URL=redis://heaven-redis:6379
EOF

# migrate the database
docker run --rm --net heaven --env-file ./env.list emdentec/heaven "rake" "db:migrate"

# run the application container
docker run --name heaven --net heaven --env-file ./env.list -d emdentec/heaven
# run worker container
docker run --name heaven-worker-1 --net heaven --env-file ./env.list emdentec/heaven "rake" "resque:work" "QUEUE=*"
docker run --name heaven-worker-2 --net heaven --env-file ./env.list emdentec/heaven "rake" "resque:work" "QUEUE=*"