Skip to content

Latest commit

 

History

History
138 lines (109 loc) · 5.88 KB

deployment.md

File metadata and controls

138 lines (109 loc) · 5.88 KB
Raw

Deployment

Deploy with now

now is a great way to quickly deploy Node.js applications. Unfortunately, now is a read-only file system, so you must either run your app in memory or set an external CouchDB URL.

Add this script to your package.json and you are good to go:

  "now-start": "hoodie --inMemory",

Alternatively, you can also set environment variables. If you set hoodie_inMemory=true it will have the same effect as the "now-start" script above. To set a CouchDB URL, set hoodie_dbUrl=https://admin:secret@my-app.my-couchdb-host.com

Deploy with Docker

Start CouchDB

$ docker run -d --name my-couchdb \
    -v /data/couchdb:/usr/local/var/lib/couchdb \
    klaemo/couchdb:1.6.1
$ # create a admin user with the password `secret`
$ # of course you can use you own username/password
$ docker run -it --rm \
    --link my-couchdb:couchdb \
    yxdhde/alpine-curl-git curl -X PUT \
    couchdb:5984/_config/admins/admin -d '"secret"'
$ # login with the admin user
$ docker run -it --rm \
    --link my-couchdb:couchdb \
    yxdhde/alpine-curl-git curl -X POST \
    -H 'Content-Type: application/x-www-form-urlencoded' \
    couchdb:5984/_session -d 'name=admin&password=secret'

Build hoodie-app-tracker

$ docker build -t hoodie-app-tracker .
$ docker run -d -p 8080:8080 \
    --name my-app \
    --link my-couchdb:couchdb \
    hoodie-app-tracker
Or use the prebuilt Docker image
$ docker run -d -p 8080:8080 \
    --name my-app \
    --link my-couchdb:couchdb \
    -e hoodie_dbUrl=http://admin:secret@couchdb:5984/ \
    hoodiehq/hoodie-app-tracker

Continuous deployment with Docker Hub

$ docker run -d --name hub-webhook \
    -e VIRTUAL_HOST=webhook-deploy.my-domain.com \
    -e DEFAULT_PARAMS='--restart=always -p 8080:8080 --link my-couchdb:couchdb' \
    -e DEFAULT_TOKEN=my-webhook-token \
    -v /var/run/docker.sock:/var/run/docker.sock:ro \
    christophwitzko/docker-hub-webhook

Set up a webhook on Docker Hub with the URL http://deploy-webhook.my-domain.com/my-webhook-token.

Example with a reverse proxy

This example is deployed at tracker.hood.ie.

Reverse Proxy with Letsencrypt

The following two docker commands start a Nginx reverse proxy with automatic certificate creation and renewal.

$ docker run -d -p 80:80 -p 443:443 \
    --name nginx-proxy \
    -v /data/certs:/etc/nginx/certs:ro \
    -v /etc/nginx/vhost.d \
    -v /usr/share/nginx/html \
    -v /var/run/docker.sock:/tmp/docker.sock:ro \
    jwilder/nginx-proxy
$ docker run -d --name letsencrypt-companion \
    --volumes-from nginx-proxy \
    -v /data/certs:/etc/nginx/certs:rw \
    -v /var/run/docker.sock:/var/run/docker.sock:ro \
    jrcs/letsencrypt-nginx-proxy-companion

Start CouchDB

This step is equivalent to Start CouchDB.

Docker Hub webhook deployment

This starts the webhook server. If it receives a webhook it pulls the updated image and restarts the container. More info here.

$ docker run -d --name hub-webhook \
    -e VIRTUAL_HOST=webhook-deploy.hood.ie \
    -e LETSENCRYPT_HOST=webhook-deploy.hood.ie \
    -e LETSENCRYPT_EMAIL=your@email.com \
    -e DEFAULT_PARAMS='--restart=always -e hoodie_dbUrl=http://admin:secret@couchdb:5984/ -e VIRTUAL_HOST=tracker.hood.ie -e LETSENCRYPT_HOST=tracker.hood.ie -e LETSENCRYPT_EMAIL=your@email.com --link my-couchdb:couchdb' \
    -e DEFAULT_TOKEN=my-secret-token \
    -v /var/run/docker.sock:/var/run/docker.sock:ro \
    christophwitzko/docker-hub-webhook

Deploy with Bluemix

One Simple Step: Use the Deploy to Bluemix Button!

Deploy to Bluemix

Or Manually Configure IBM Bluemix (Instead of using the Deploy to Bluemix Button)

Complete these steps first (if you have not already:)

  1. Install the Cloud Foundry command line interface.
  2. Follow the instructions at the above link to connect to Bluemix.
  3. Follow the instructions at the above link to log in to Bluemix.

Create a Cloudant service within Bluemix if one has not already been created:

$ cf create-service cloudantNoSQLDB Lite hoodie-app-tracker-cloudant-service

Use the Standard plan for production deployments.

In order to connect your hoodie app to the provisioned CouchDB.

Deploying

To deploy to Bluemix, simply: $ cf push

Notes about Bluemix Deployment Requirements

We wouldn't normally need a Procfile for a simple application like this as without it Bluemix will automatically create one for you. However, for this application we need it to populate the value for the hoodie_dbUrl environment variable. The .cfignore file is another thing you can sometimes get away without including. However there are two big reason to include it here. First, you’d be deploying several files that should really just stay in your local development environment. Second, and probably the biggest reason, is that Bluemix won’t install your npm modules and instead will just ship whatever happens to be in the node_modules directory in your local development environment. Lastly, the manifest.yml file is a requirement to be able to include the easy "Deploy to Bluemix" button here on this page.

Without the manifest file we’d have to add two steps to the manual Bluemix deployment steps:

  1. Provide an application name on cf push

  2. Manually bind the hoodie-app-tracker-cloudant-service service