Add support for Docker Compose

Author: aborderon

README.md

@@ -38,6 +38,7 @@ You have three options:
 - Run node-build-monitor [by downloading the standalone version](#run-the-standalone-version-easiest-way) <sub><sup>(easiest way to run it)</sup></sub>
 - Run node-build-monitor [manually with node](#run-it-manually-during-development) <sub><sup>(preferred during development)</sup></sub>
 - Run node-build-monitor [with Docker](#run-it-with-docker-in-production) <sub><sup>(preferred in production)</sup></sub>
+- Run node-build-monitor [with Docker Compose](#run-it-with-docker-compose-in-production) <sub><sup>(preferred in production)</sup></sub>
 
 ### Configuration
 
@@ -454,6 +455,94 @@ Ensure that you omit the `tfsProxyUrl` setting in your `config.json`, so that it
 
 Now open your browser and navigate to [http://localhost:12345](http://localhost:12345) to see your running or finished builds. Switch to fullscreen for the best experience.
 
+### Run it with Docker Compose (in production)
+
+You can try out or install the build monitor with [Docker Compose](https://docs.docker.com/compose/) easily.
+
+__TL;DR:__ Go to the [docker directory](docker/), edit the file `config.json` and run the following commands, which you need.
+
+Below, each commands is explained in detail.
+
+#### 1. Create configuration and set up the build monitor
+Place a file `config.json` next to the `docker-compose.*.yml` and configure the services:
+```json
+{
+  "monitor": {
+    "interval": 30000,
+    "numberOfBuilds": 12,
+    "latestBuildOnly": false,
+    "sortOrder": "date",
+    "debug": true
+  },
+  "services": [
+    {
+      "name": "Travis",
+      "configuration": {
+        "slug": "marcells/bloggy"
+      }
+    },
+    {
+      "name": "Travis",
+      "configuration": {
+        "slug": "marcells/node-build-monitor"
+      }
+    }
+  ]
+}
+```
+
+See the description of this file in the configuration section above.
+
+#### 2. Build your custom build monitor image
+
+Build your custom node-build-monitor docker image. This will also include your configuration from the previous step.
+
+#### 3. Run the container
+
+##### a. Without tfs-proxy
+
+Installing and running node-build-monitor in a docker container for use on the same machine is simple with the following commands:
+
+Run docker-compose from your custom `docker-compose.yml`
+```
+docker-compose build
+docker-compose -f docker-compose.yml up -d
+```
+You can now find your node-build-monitor instance running on localhost:3000.
+
+##### b. With tfs-proxy
+
+If you want to get access to the tfs-proxy, then you need a slighly different command, which allows the build monitor container to access the tfs-proxy container.
+
+Run docker-compose from your custom `docker-compose.with-tfs-proxy.yml`
+```
+docker-compose -f docker-compose.with-tfs-proxy.yml up -d --build
+```
+Ensure that you omit the `tfsProxyUrl` setting in your `config.json`, so that it can be determined automatically. [Here](https://docs.docker.com/userguide/dockerlinks/#container-linking) you'll get more information about container linking.
+
+You can now find your node-build-monitor instance running on localhost:3000.
+
+##### c. With self-signed-certs
+
+If you connect to services, which are using self signed certificates, run docker-compose from your custom `docker-compose.with-self-signed-certs.yml`
+```
+docker-compose build
+docker-compose.with-self-signed-certs.yml
+```
+You can now find your node-build-monitor instance running on localhost:3000.
+
+##### d. Access logs
+
+To see logs:
+``` 
+docker logs -f docker_node-build-monitor_1
+```
+View which dockers are running by executing docker ps.
+
+#### 5. Access it with your browser
+
+Now open your browser and navigate to [http://localhost:12345](http://localhost:12345) to see your running or finished builds. Switch to fullscreen for the best experience.
+
 ### Theming support
 
 Here you can check out the existing themes. Feel free to [add your own](#creating-a-new-theme) and make a pull request. It can be done very easy.

docker/docker-compose.with-self-signed-certs.yml

@@ -0,0 +1,12 @@
+version: '3'
+
+services:
+  node-build-monitor:
+    restart: unless-stopped
+    image: marcells/node-build-monitor
+    build: .
+    environment:
+      NODE_ENV: production
+      NODE_TLS_REJECT_UNAUTHORIZED: 0
+    ports:
+      - 3000:3000

docker/docker-compose.with-tfs-proxy.yml

@@ -0,0 +1,18 @@
+version: '3'
+
+services:
+  node-build-monitor:
+    restart: unless-stopped
+    image: marcells/node-build-monitor
+    build: .
+    links:
+      - tfs-proxy
+    environment:
+      NODE_ENV: production
+    ports:
+      - 3000:3000
+  
+  tfs-proxy:
+    restart: unless-stopped
+    image: marcells/tfs-proxy
+    build: .

docker/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3'
+
+services:
+  node-build-monitor:
+    restart: unless-stopped
+    image: marcells/node-build-monitor
+    build: .
+    environment:
+      NODE_ENV: production
+    ports:
+      - 3000:3000