diff --git a/.dockerignore b/.dockerignore
new file mode 100644
index 00000000..8bed3523
--- /dev/null
+++ b/.dockerignore
@@ -0,0 +1,4 @@
+docker-compose.yml
+Dockerfile
+docker
+node_modules
\ No newline at end of file
diff --git a/.eslintrc.js b/.eslintrc.js
new file mode 100644
index 00000000..577ddcf5
--- /dev/null
+++ b/.eslintrc.js
@@ -0,0 +1,37 @@
+module.exports = {
+ 'env': {
+ 'browser': true,
+ 'es6': true,
+ 'node': true
+ },
+ 'extends': 'eslint:recommended',
+ 'globals': {
+ 'Atomics': 'readonly',
+ 'SharedArrayBuffer': 'readonly'
+ },
+ 'parserOptions': {
+ 'ecmaVersion': 2018,
+ 'sourceType': 'module'
+ },
+ "plugins": [
+ "html"
+ ],
+ 'rules': {
+ 'indent': [
+ 'error',
+ 2
+ ],
+ 'linebreak-style': [
+ 'error',
+ 'unix'
+ ],
+ 'quotes': [
+ 'error',
+ 'single'
+ ],
+ 'semi': [
+ 'error',
+ 'always'
+ ]
+ }
+};
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 12ac6472..f78c1256 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,6 @@
node_modules/
-.DS_Store
\ No newline at end of file
+.DS_Store
+temp/
+reports/
+coverage/
+.nyc_output
\ No newline at end of file
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 00000000..fca5953c
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,25 @@
+language: node_js
+node_js:
+ - "10"
+
+# safelist
+branches:
+ only:
+ - master
+
+env:
+ - DOCKER_COMPOSE_VERSION=1.23.2
+
+before_install:
+ - sudo rm /usr/local/bin/docker-compose
+ - curl -L https://github.com/docker/compose/releases/download/${DOCKER_COMPOSE_VERSION}/docker-compose-`uname -s`-`uname -m` > docker-compose
+ - chmod +x docker-compose
+ - sudo mv docker-compose /usr/local/bin
+ - docker-compose build
+ - docker-compose up
+
+script:
+ - "npm test"
+
+after_script:
+ - docker-compose down
\ No newline at end of file
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 00000000..06cc4b91
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,39 @@
+FROM node:10
+
+# update apt-get
+RUN apt-get -y update && apt-get -y upgrade
+
+# install build-essential
+RUN apt-get -y install build-essential binutils debootstrap netcat
+
+# install mon
+RUN cd /tmp; git clone https://github.com/tj/mon; cd mon; make install
+
+# copy basic files
+# Only copy package.json first to help with cache
+ADD . /src
+WORKDIR /src
+
+RUN export USER=root && cd /src && rm -rf ./node_modules/ && npm install && npm link
+
+# disable install modules for now
+# RUN cd /src/modules && node install.js
+
+RUN addgroup workers
+RUN adduser --gid 1000 --disabled-password --gecos '' worker
+
+RUN mkdir -p /var/chroot/bin
+COPY ./bin /var/chroot/bin
+
+# fake ssl certificates
+RUN mkdir -p /etc/letsencrypt/live/hook.io
+COPY ./ssl/*.pem /etc/letsencrypt/live/hook.io/
+
+# COPY /bin/bash /var/chroot/bin/bash
+
+# RUN debootstrap --arch i386 wheezy /var/chroot http://httpredir.debian.org/debian
+
+# dns resolve is probably missing...
+# RUN mkdir -p /var/chroot/etc/
+# RUN echo 'nameserver 8.8.4.4' | tee -a /var/chroot/etc/resolv.conf
+
diff --git a/README.md b/README.md
index 195c75d2..8ae8db88 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,31 @@
-
+
## Open-Source Microservice Hosting Platform
### Build and deploy HTTP microservices in seconds
-To start using hook.io visit the website at [http://hook.io](http://hook.io). Here you will find many examples and documentation on how to use hook.io
-
-
-**Built with:** [Node.js](http://nodejs.org), [CouchDB](http://couchdb.com), and [Github Gist](http://gist.github.com). [Node Package Manager](http://npmjs.org) modules are fully supported.
+#### Supported Service Programming Languages
+
+ - c ( with `gcc` )
+ - java
+ - javascript ( first-class support )
+ - coffee-script
+ - common
+ - bash
+ - lua
+ - golang
+ - ocaml
+ - perl
+ - php
+ - python
+ - python3
+ - ruby
+ - rust
+ - r
+ - scheme
+ - smalltalk
+ - tcl
+
+To start using hook.io visit the website at [https://hook.io](https://hook.io). Here you will find many examples and documentation on how to use hook.io
Architectural details can be found a bit further down.
@@ -18,80 +37,53 @@ If you'd like, you can run the following Curl command to opt-in to our mailing l
Replace youremail@marak.com with your email address.
-## What is the purpose of hook.io?
+## Installing Local Hook.io Server
-hook.io is an open-source hosting platform for webhooks and microservices. The microservice architectural style is an approach to developing a single application as a suite of small services, each running in its own process and communicating with lightweight mechanisms. hook.io provides an easy way to create, host, and share microservices. Through developing many small re-usable microservices, you can reduce the complexity of your applications while improving stability.
+Before setting up a local hook.io server, you should try the free hosted version at [https://hook.io](https://hook.io)
+If you don't need a full hosting platform and only want to host microservices, we recommend using the [Microcule](https://github.com/stackvana/microcule) project.
+```bash
+git clone https://github.com/bigcompany/hook.io.git
+cd hook.io
+docker-compose build
+docker-compose up
+````
-## Why or how would I want to use hook.io?
+At this point you should be able to load hook.io locally at: `http://localhost:9999`
-You should want to use hook.io if it can make your life as a developer easier.
+## What is the purpose of hook.io?
+hook.io is an open-source hosting platform for webhooks and microservices. The microservice architectural style is an approach to developing a single application as a suite of small services, each running in its own process and communicating with lightweight mechanisms. hook.io provides an easy way to create, host, and share microservices. Through developing many small re-usable microservices, you can reduce the complexity of your applications while improving stability.
-The most *basic use-case* for hook.io is quick and free webhook hosting. You can instantly create a [simple hook](http://hook.io/Marak/echo) which parses the incoming parameters of an HTTP request and performs arbitrary actions on it. For instance: Send an SMS message every-time the Hook is requested as a webpage. Since NPM is supported, you can re-use any existing library from the extensive [NPM module repository](http://npmjs.org). You can also configure Hooks to be executed on a schedule using a [Cron pattern](http://hook.io/cron).
+## Why or how would I want to use hook.io?
+You should want to use hook.io if it can make your life as a developer easier.
+The most *basic use-case* for hook.io is quick and free webhook hosting. You can instantly create a [simple hook](https://hook.io/examples/echo) which parses the incoming parameters of an HTTP request and performs arbitrary actions on it. For instance: Send an SMS message every-time the Hook is requested as a webpage. Since NPM is supported, you can re-use any existing library from the extensive [NPM module repository](http://npmjs.org). You can also configure Hooks to be executed on a schedule using a [Cron pattern](https://hook.io/cron).
At this point, we will take note that Hooks are [fully streaming](https://github.com/substack/stream-handbook). Inside your Hook source code you have direct access to Node's [http.IncomingMessage](http://nodejs.org/api/http.html#http_http_incomingmessage) and [httpServer.ServerResponse](http://nodejs.org/api/http.html#http_class_http_serverresponse) request and response streams. This means you can treat the inside of a Hook the exact same way as if it were inside a streaming middleware in a regular node http server. Having direct access to these streams is extremely useful and I am unsure if any other microservice hosting providers currently offer this feature.
+More *advanced use-cases* for hook.io would be replacing individual parts of your application with microservices. Instead of adding a new route or module to your application , you could instead create a Hook responsible for only one unit of functionality and call it using a regular HTTP request from inside your existing application. One specific example could be building a Hook with a [custom theme](https://hook.io/themes) which acts perfectly as a stand-alone sign-up form. This sign-up form can then be loaded server-side in your application using one HTTP get request. It might sound complicated at first, but integrating microservices with your existing application is actually very easy. In the upcoming weeks we'll work on releasing specific guides for separating application functionalities into microservices.
-
-More *advanced use-cases* for hook.io would be replacing individual parts of your application with microservices. Instead of adding a new route or module to your application , you could instead create a Hook responsible for only one unit of functionality and call it using a regular HTTP request from inside your existing application. One specific example could be building a Hook with a [custom theme](http://hook.io/themes) which acts perfectly as a stand-alone sign-up form. This sign-up form can then be loaded server-side in your application using one HTTP get request. It might sound complicated at first, but integrating microservices with your existing application is actually very easy. In the upcoming weeks we'll work on releasing specific guides for separating application functionalities into microservices.
-
-
-
-An *even more advanced usage* would be building a suite of Hooks and composing them to create new and unique applications! Since every Hook understands Standard In and Standard Out and Hooks can [easily call other Hooks](http://hook.io/Marak/merge) from inside each other, there are an endless amount of combinations to be made. This composability enables the foundation for [Flow-based Programming](http://en.wikipedia.org/wiki/Flow-based_programming) without imposing any specific rules for composition. A specific example could be building a Hook ( called "tar" ) responsible for taking in STDIN and streaming out a compressed tar file. Once this Hook is created, you could easily pipe the results of another Hook ( such as an image downloader ) into the "tar" Hook. These Hooks don't exist yet, but I am certain someone will build them in the near future.
-
-
+An *even more advanced usage* would be building a suite of Hooks and composing them to create new and unique applications! Since every Hook understands Standard In and Standard Out and Hooks can [easily call other Hooks](https://hook.io/examples/javascript-stream-merge) from inside each other, there are an endless amount of combinations to be made. This composability enables the foundation for [Flow-based Programming](http://en.wikipedia.org/wiki/Flow-based_programming) without imposing any specific rules for composition. A specific example could be building a Hook ( called "tar" ) responsible for taking in STDIN and streaming out a compressed tar file. Once this Hook is created, you could easily pipe the results of another Hook ( such as an image downloader ) into the "tar" Hook. These Hooks don't exist yet, but I am certain someone will build them in the near future.
## Unix Pipes!
-hook.io is very friendly with Unix Pipes. Using STDOUT and STDIN you can connect hook.io to your existing Unix Tool chain. The best way to explain this concept is to review the [Curl examples](http://hook.io/curl).
-
-
-
-Here is one specific example of using hook.io to flip a cat upside-down with `cat` and `curl`. You will need to provide your own cat.png
-
-
-
-```
-cat cat.png | curl -F 'degrees=180' -F 'image=@-;type=image/png' http://hook.io/Marak/image/rotate > upsidedown-cat.png
-```
-
-
+hook.io is very friendly with Unix Pipes. Using STDOUT and STDIN you can connect hook.io to your existing Unix Tool chain. The best way to explain this concept is to review the [Curl examples](https://hook.io/curl).
## The Data!
If you noticed in the last example, hook.io is fully capable of streaming binary data. It also supports streaming file uploads, multipart form uploads, and will assist in parsing all incoming form fields, JSON, and query string data.
-
-
## Software Architecture
The core software architecture of hook.io is Resource-View-Presenter ( RVP ).
Resources are created using the npm [resource](http://npmjs.org/package/resource) module.
-View-Presenters are created using the npm [view](http://npmjs.org/package/view) module with regular HTML, CSS, and JavaScript. The same View-Presenter pattern is also used to implement custom theming for Hooks see: [hook.io/themes](http://hook.io/themes)
-
-
-## Dependency Tree
-
-hook.io itself is not a very large application. The majority of what powers hook.io is already MIT open-sourced and available for immediate download.
-
-Learning about the following dependencies is a great way to start understanding how hook.io works.
-
-[mschema](http://github.com/mschema/mschema) - Provides validation through-out the entire stack.
-
-[big](http://npmjs.org/package/big) - Small application framework. Provides [website](https://github.com/bigcompany/big/blob/master/apps/website/index.js) app which hook.io extends.
-
-[resource-http](http://github.com/bigcompany/http) - Provides core HTTP server API. Helps in configuring [Express](http://expressjs.com) with middlewares like [Passport](http://passportjs.org/)
-
-[resource-mesh](http://github.com/bigcompany/mesh) - Provides a distributed event emitter mesh using a [star network topography](http://en.wikipedia.org/wiki/Network_topology#Star). hook.io primarily uses this module as a monitoring agent to report status back to our monitoring [sink](https://github.com/bigcompany/big/blob/master/apps/sink/index.js).
-
-[resource-user](http://github.com/bigcompany/user) - Provides basic user API ( signups / logins / encrypted passwords / password resets / etc )
+View-Presenters are created using the npm [view](http://npmjs.org/package/view) module with regular HTML, CSS, and JavaScript. The same View-Presenter pattern is also used to implement custom theming for Hooks see: [hook.io/themes](https://hook.io/themes)
## Server Architecture
@@ -102,7 +94,7 @@ The front-facing server is responsible for serving static content, maintaining u
Workers are responsible for executing user-submitted source code and piping their responses through the front-facing server to the client.
-At this point, we will take note that communication between the Hook and client remains streaming throughout the entire architecture. This gives hook.io the ability to perform complex tasks like [transcoding large video streams](http://hook.io/Marak/transcodeVideo) without worrying about clogging up any parts of the system with large memory buffers.
+At this point, we will take note that communication between the Hook and client remains streaming throughout the entire architecture. This gives hook.io the ability to perform complex tasks like transcoding large video streams without worrying about clogging up any parts of the system with large memory buffers.
Hook Servers and Hook Workers are immutable and stateless to ensure stability of the platform. They are designed to fail fast and restart fast. [mon](http://github.com/tj/mon) is used as a process supervisor.
@@ -114,7 +106,7 @@ Source code for Hooks is currently stored on Github as Github Gists. I'd imagine
## Creating new Hooks
-It's very simple. Go to [http://hook.io/new](http://hook.io/new)
+It's very simple. Go to [https://hook.io/new](https://hook.io/new)
## Support
@@ -122,7 +114,7 @@ If you run into an issue, have a question, or have feedback with using hook.io y
## Adding new NPM Modules to hook.io
-The fastest way to get an additional NPM module added to the hook.io platform is to open up a Pull Request modifying [this file](https://github.com/bigcompany/hook.io/blob/master/modules/modules.js).
+NPM modules will automatically install if you attempt to require them in a Hook. The first time the Hook is run, hook.io will install the dependency. Re-run the hook a few moments later and it should just work.
If your module requires additional dependencies outside of what NPM can install, you can create a custom build script in [this folder](https://github.com/bigcompany/hook.io/tree/master/modules/builds). The hosting environment for hook.io is Ubuntu 14.04.1 LTS (Trusty Tahr) Bash scripts are recommended.
@@ -130,25 +122,22 @@ If your module requires additional dependencies outside of what NPM can install,
If you only need to test your Hook code, you can run `./bin/test-hook` without having to setup the full hook.io stack.
-## Setting up a private hook.io
-
-Before setting up a private hook.io server, you should try the free hosted version at [http://hook.io](http://hook.io)
-
-Setting up a private hook.io server is easy! You'll want to clone this repository, install the dependencies, and run the `start.sh` script. There currently are not detailed installation instructions and you will need to configure a few dependencies ( such as couchdb and github api ).
-
-If you want to run Hooks without any additional dependencies, try running `./bin/test-hook`.
-
## Workers
Hooks are executed on *stateless* isolated workers to help facilitate scaling and to ensure stability in the core application. These workers are responsible for running user-submitted Hook source code and piping their responses back to the main server. If running untrusted user-submitted code, you will need to isolate these workers.
see: `./bin/worker` and `./bin/test-worker`
-## User process isolation
+## i18n Internationalization
+
+[https://github.com/bigcompany/hook.io-i18n](https://github.com/bigcompany/hook.io-i18n)
-If you plan to run a hook.io server that allows user-submitted code, you will need to setup process isolation per user on every worker so that user-submitted Hooks will not potentially affect performance of other users or interact with parts of the system the user should not have permission to access.
-Docker is a great tool to start with.
+## Tests
+
+```bash
+npm test
+```
## Contributing
diff --git a/bin/cron b/bin/cron
deleted file mode 100644
index 32829745..00000000
--- a/bin/cron
+++ /dev/null
@@ -1,8 +0,0 @@
-var cron = require('../lib/resources/cron');
-
-cron.processAll(function(err, result){
- // wait 60 seconds and process again
- setTimeout(function(){
- process.exit(0);
- }, 60000)
-});
\ No newline at end of file
diff --git a/bin/crons/send-user-alerts b/bin/crons/send-user-alerts
new file mode 100644
index 00000000..3a89e1a2
--- /dev/null
+++ b/bin/crons/send-user-alerts
@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+var PAUSE_TIME = 60000;
+const alerts = require('../../lib/resources/alerts/alerts');
+
+alerts.sendAlerts({}, function(err, result){
+ console.log(err, result);
+ // TODO: set timeout
+ // wait 60 seconds and process again
+ setTimeout(function(){
+ // this script is intended to be run with a process monitor
+ // by calling process.exit, we close the script and let the process
+ // monitor restart the cron process
+ process.exit(0);
+ }, PAUSE_TIME);
+});
\ No newline at end of file
diff --git a/bin/docker/initialize b/bin/docker/initialize
new file mode 100755
index 00000000..c76bcb39
--- /dev/null
+++ b/bin/docker/initialize
@@ -0,0 +1,20 @@
+#!/bin/sh
+if [ ! -e "/src/.setup_done" ]
+then
+ echo "Creating admin..."
+ sh /src/config/couchdb/create_admin.sh
+ echo "Adding default users..."
+ /src/bin/docker/wait web -c node /src/scripts/install/add-default-users.js
+ echo "Adding default hooks..."
+ /src/bin/docker/wait web -c node /src/scripts/install/add-default-hooks.js
+ echo "Done adding default hooks..."
+ touch "/src/.setup_done"
+ echo
+ echo "================================================================"
+ echo " Load Balancer started locally: "
+ echo
+ echo " http://localhost:9999"
+ echo
+ echo
+ echo "================================================================"
+fi
diff --git a/bin/docker/wait b/bin/docker/wait
new file mode 100755
index 00000000..3e9a980c
--- /dev/null
+++ b/bin/docker/wait
@@ -0,0 +1,28 @@
+#!/bin/bash
+
+declare -A PORT
+PORT[redis]=6379
+PORT[couch]=5984
+PORT[balancer]=9999
+PORT[worker0]=10000
+PORT[web]=11000
+
+wait_for() {
+ local host=$1
+ local port=${PORT[$host]}
+
+ echo "Waiting for $host:$port..."
+ until $(nc -z $host $port); do
+ sleep 1
+ done
+}
+
+until [ "$1" == "-c" ]; do
+ wait_for $1
+ echo "$1 is up"
+ shift
+done
+
+shift
+echo "Executing $@"
+exec $@
diff --git a/bin/hpm-server b/bin/hpm-server
new file mode 100644
index 00000000..93efde95
--- /dev/null
+++ b/bin/hpm-server
@@ -0,0 +1,13 @@
+#!/usr/local/bin/node
+
+var hpm = require('hpm');
+
+hpm.onAny(function(data){
+ console.log('event');
+ console.log(this.event, data)
+});
+
+// TODO: move options to config
+hpm.server.start({ port: 8888, host: "localhost" }, function (err, app){
+ console.log(err, app.server.address())
+});
\ No newline at end of file
diff --git a/bin/npm-install b/bin/npm-install
new file mode 100755
index 00000000..bbdfbea6
--- /dev/null
+++ b/bin/npm-install
@@ -0,0 +1,26 @@
+#!/usr/local/bin/node
+
+// parse incoming command line arguments
+var argv = require('minimist')(process.argv.slice(2));
+
+if (typeof argv.p === "undefined" || argv.p.length === 0) {
+ console.log('Packages parameter required. Please pass in -p argument');
+ process.exit();
+}
+
+var packages;
+
+try {
+ packages = JSON.parse(argv.p);
+} catch (err) {
+ console.log('Invalid -p argument. Not JSON' + err.message);
+ process.exit();
+}
+
+var npm = require("../lib/resources/npm");
+
+npm.install("/Users/chroot/", { packages: packages }, function(err, res){
+ if (err) {
+ console.error(err.message)
+ }
+});
\ No newline at end of file
diff --git a/bin/server b/bin/server
deleted file mode 100644
index ef761c86..00000000
--- a/bin/server
+++ /dev/null
@@ -1,6 +0,0 @@
-var server = require('../lib/server');
-server.start({}, function(err){
- if (err) {
- throw err;
- }
-});
\ No newline at end of file
diff --git a/bin/services/broadcast b/bin/services/broadcast
new file mode 100755
index 00000000..bc0aecae
--- /dev/null
+++ b/bin/services/broadcast
@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+var broadcast = require('../../lib/broadcast/broadcast');
+broadcast.start({}, function (err, app) {
+ if (err) {
+ throw err;
+ }
+ console.log('web server started', app.server.address())
+});
\ No newline at end of file
diff --git a/bin/services/cron b/bin/services/cron
new file mode 100644
index 00000000..08b5a101
--- /dev/null
+++ b/bin/services/cron
@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+var cron = require('../../lib/resources/cron/cron');
+var PAUSE_TIME = 60000;
+
+cron.run(function(err, result){
+ if (err) {
+ throw err;
+ }
+ console.log('processed all crons', result)
+ // wait 60 seconds and process again
+ setTimeout(function(){
+ // this script is intended to be run with a process monitor
+ // by calling process.exit, we close the script and let the process
+ // monitor restart the cron process
+ process.exit(0);
+ }, PAUSE_TIME);
+});
\ No newline at end of file
diff --git a/bin/services/load-balancer b/bin/services/load-balancer
new file mode 100755
index 00000000..f2a9c971
--- /dev/null
+++ b/bin/services/load-balancer
@@ -0,0 +1,89 @@
+#!/usr/bin/env node
+var lb = require('../../lib/load-balancer/load-balancer');
+var cluster = require('cluster');
+var config = require('../../config');
+config.env = 'prod';
+if (config.env === 'dev') {
+ console.log('using dev mode, no cluster');
+ lb.start({}, function(err, app){
+ if (err) {
+ throw err;
+ }
+ console.log('lb started', app.server.address());
+ });
+} else {
+
+ // the master node is responsible for performing clustering logic
+ if (cluster.isMaster) {
+
+ // create a new worker for every available CPU
+ var numWorkers = require('os').cpus().length;
+
+ console.log('Master cluster setting up ' + numWorkers + ' workers...');
+
+ for(var i = 0; i < numWorkers; i++) {
+ cluster.fork();
+ }
+
+ cluster.on('exit', function (worker, code, signal) {
+ console.log('Worker ' + worker.process.pid + ' died with code: ' + code + ', and signal: ' + signal);
+ console.log('Starting a new worker');
+ // If the worker exited after disconnect, don't do anything. It should have already forked.
+ if (worker.exitedAfterDisconnect === true) {
+ console.log('exited after disconnect. probably performing rolling update');
+ } else {
+ // Else if the worker did not have disconnect event, assume it was a crash and fork() immediately
+ console.log('got exit event without disconnect, probably a process crash');
+ }
+ cluster.fork();
+ });
+
+ cluster.on('online', function(worker) {
+ console.log('Worker ' + worker.process.pid + ' is online');
+ worker.on('disconnect', function () {
+ var id = worker.id;
+ console.log('node got disconnect event', id);
+ // once disconnected, this node is no longer accepting incoming traffic from the cluster
+ // so immediately kill the worker node
+ worker.kill();
+ });
+
+ // message handler is used for worker to receieve messages from parent process
+ worker.on('message', function (message) {
+ if (message.event === 'restart') {
+ // disconnect one worker from the pool and wait
+ var workers = Object.keys(cluster.workers);
+ if (workers.length === 0) {
+ console.log('fatal error: cluster has exhausted all nodes');
+ return;
+ }
+ // performing rolling update here where we iterate through each stale node
+ var workerId = workers[0];
+ cluster.workers[workerId].disconnect();
+ }
+ if (message.event === 'query') {
+ var queryResponse = {};
+ for (var w in cluster.workers) {
+ queryResponse[w] = {
+ pid: cluster.workers[w].process.pid,
+ spawnfile: cluster.workers[w].process.spawnfile
+ };
+ // TODO: add uptime() or ctime
+ }
+ worker.send({ event: 'queryResponse', data: queryResponse });
+ }
+ });
+ });
+ cluster.on('listening', function (worker) {
+ console.log('Worker ' + worker.process.pid + ' is listening');
+ });
+ } else {
+ lb.start({}, function(err, app){
+ if (err) {
+ throw err;
+ }
+ // process.send({ event: 'load-balancer::listening' });
+ console.log('lb started', app.server.address());
+ });
+ }
+}
\ No newline at end of file
diff --git a/bin/services/microtail-front b/bin/services/microtail-front
new file mode 100644
index 00000000..1d6a26c0
--- /dev/null
+++ b/bin/services/microtail-front
@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+var colors = require('colors');
+var microtail = require('microtail');
+var path = require('path');
+var config = require('../../config');
+
+microtail.start({
+ http: {
+ port: 9980,
+ auth: {
+ basicAuth: config.tailAdmin
+ }
+ },
+ tails: [{
+ name: 'webserver logs',
+ path: path.resolve(__dirname + "/../../logs/web-logs.txt"),
+ lines: 10
+ },{
+ name: 'cron logs',
+ path: path.resolve(__dirname + "/../../logs/cron-logs.txt"),
+ lines: 10
+ },{
+ name: 'balancer logs',
+ path: path.resolve(__dirname + "/../../logs/balancer-logs.txt"),
+ lines: 10
+ }]
+}, function (err, app) {
+ if (err) {
+ console.log('microtail start error'.red);
+ throw err;
+ }
+ console.log('microtail server started'.blue, app.server());
+});
\ No newline at end of file
diff --git a/bin/services/microtail-workers b/bin/services/microtail-workers
new file mode 100644
index 00000000..bfdb632d
--- /dev/null
+++ b/bin/services/microtail-workers
@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+var colors = require('colors');
+var microtail = require('microtail');
+var path = require('path');
+
+microtail.start({
+ http: {
+ port: 9980,
+ auth: {
+ basicAuth: config.tailAdmin
+ }
+ },
+ tails: [{
+ name: 'worker logs',
+ path: path.resolve(__dirname + "/../../logs/worker-logs.txt"),
+ lines: 10
+ }]
+}, function (err, app) {
+ if (err) {
+ console.log('microtail start error'.red);
+ throw err;
+ }
+ console.log('microtail server started'.blue, app.server());
+});
\ No newline at end of file
diff --git a/bin/services/web b/bin/services/web
new file mode 100755
index 00000000..dc31e89f
--- /dev/null
+++ b/bin/services/web
@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+// front-facing web servers
+// currently handles static assets / views / and api endpoints
+var web = require('../../lib/web/web');
+web.start({}, function(err, app){
+ if (err) {
+ throw err;
+ }
+ console.log('web server started', app.server.address())
+});
\ No newline at end of file
diff --git a/bin/services/worker b/bin/services/worker
new file mode 100755
index 00000000..968a2c01
--- /dev/null
+++ b/bin/services/worker
@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+var colors = require('colors');
+var worker = require('../../lib/worker/worker');
+
+worker.start({}, function (err, app) {
+ if (err) {
+ console.log('worker error'.red);
+ throw err;
+ }
+ console.log('worker started'.blue, app.server.address());
+});
\ No newline at end of file
diff --git a/bin/test-hook b/bin/test-hook
deleted file mode 100644
index d1f9a17c..00000000
--- a/bin/test-hook
+++ /dev/null
@@ -1,46 +0,0 @@
-var hook = require('../lib/resources/hook');
-
-/*********************************************************/
- //
- // Put your hook code here
- //
-
- var exampleHook = function exampleHook (hook) {
- hook.res.end('Success!');
- }
-
-/*********************************************************/
- //
- // This code runs the hook locally
- //
-
- var http = require('resource-http');
- var request = require('request');
-
- http.listen({ port: 9999 }, function(err, app){
- app.get('/test', function(req, res){
- req.resource = {};
- // Set custom Hook.params here
- req.resource.params = {
- "foo": "bar"
- }
- req.hook = {};
- req.hook.env = {};
- hook.runUntrustedHook({ req: req, res: res, params: "format" } , exampleHook, function(err){
- if (err) {
- throw err;
- }
- });
- });
- request.get('http://localhost:9999/test', function(err, res, body){
- console.log(err, body);
- process.exit();
- });
- });
-
-/*********************************************************/
-
-//
-// TODO: move this code into a separate module
-// see: https://github.com/bigcompany/hook.io/issues/17
-//
\ No newline at end of file
diff --git a/bin/test-worker b/bin/test-worker
deleted file mode 100644
index 7329a56a..00000000
--- a/bin/test-worker
+++ /dev/null
@@ -1,12 +0,0 @@
-var request = require('hyperquest');
-var net = require('net');
-
-var http = require('http');
-
-var server = http.createServer(function(req, res){
- var _url = 'http://localhost:9999/runHook' + req.url;
- var stream = request.post(_url);
- req.pipe(stream).pipe(res);
-});
-
-server.listen(8888);
\ No newline at end of file
diff --git a/bin/worker b/bin/worker
deleted file mode 100644
index bda51ec2..00000000
--- a/bin/worker
+++ /dev/null
@@ -1,6 +0,0 @@
-var worker = require('../lib/worker');
-worker.start({}, function (err){
- if (err) {
- throw err;
- }
-});
\ No newline at end of file
diff --git a/config/couchdb/Dockerfile b/config/couchdb/Dockerfile
new file mode 100644
index 00000000..7292a6ff
--- /dev/null
+++ b/config/couchdb/Dockerfile
@@ -0,0 +1,3 @@
+FROM klaemo/couchdb
+
+COPY local.ini /usr/local/etc/couchdb/
diff --git a/config/couchdb/create_admin.sh b/config/couchdb/create_admin.sh
new file mode 100755
index 00000000..810bc1a4
--- /dev/null
+++ b/config/couchdb/create_admin.sh
@@ -0,0 +1,10 @@
+#!/bin/bash
+
+HOST=http://couch:5984
+
+curl -s -X PUT $HOST/_node/nonode@nohost/_config/admins/admin -d '"password"'
+curl -s -X PUT -u admin:password $HOST/_users
+curl -s -X PUT -u admin:password $HOST/_replicator
+curl -s -X PUT -u admin:password $HOST/_global_changes
+
+#curl -X PUT $HOST/_config/admins/admin -d '"password"'
diff --git a/config/dev/index.js b/config/dev/index.js
new file mode 100644
index 00000000..59e223eb
--- /dev/null
+++ b/config/dev/index.js
@@ -0,0 +1,183 @@
+const app = {
+ name: "hook.io",
+ // host: "https://hook.io",
+ url: "http://localhost:9999",
+ ws: "ws://localhost:9999",
+ //url: "https://hook.io",
+ domain: "localhost",
+ port: "9999",
+ logo: "http://localhost:9999/img/logo.png",
+ logoInverse: "http://localhost:9999/img/logo-inverse.png",
+ adminEmail: "hookmaster@hook.io"
+};
+
+const redis = {
+ port: 6379,
+ password: "password",
+ host: "0.0.0.0"
+};
+
+const couch = {
+ "username": "admin",
+ "password": "password",
+ "port": 5984,
+ "host": "0.0.0.0"
+};
+
+const cluster = {
+ registerWithLoadBalancer: true,
+ pools : {
+ // Note: All services will auto-port up based on the first available port after the starting port
+ // this allows us define ranges of ports of the elastic pool instead of pre-configuring the pool statically
+ web: [],
+ worker: [],
+ lb: []
+ }
+};
+
+const balancer = {
+ port: 9999,
+ host: "0.0.0.0",
+ https: false,
+ publicIP: "127.0.0.1",
+ roots: ["hookio", "0.0.0.0", "localhost", "hook.io", "www.hook.io", "couch"],
+ secret: "change secret",
+ redis: {
+ prefix: '/session/',
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ }
+};
+
+const broadcast = {
+ port: 9998,
+ host: "0.0.0.0",
+ https: false,
+ publicIP: "127.0.0.1",
+ roots: ["ws.hookio", "0.0.0.0", "localhost", "ws.hook.io"],
+ secret: "change secret",
+ redis: {
+ prefix: '/session/',
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ }
+};
+
+const web = {
+ port: 11000,
+ host: "app",
+ https: false,
+ registerWithLoadBalancer: cluster.registerWithLoadBalancer,
+ roots: ["hookio", "0.0.0.0", "localhost", "hook.io", "www.hook.io"],
+ secret: "change secret",
+ redis: {
+ prefix: '/session/',
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ }
+};
+
+const worker = {
+ host: '0.0.0.0',
+ startingPort: 10000,
+ registerWithLoadBalancer: cluster.registerWithLoadBalancer,
+ nproc: {
+ soft: 15000,
+ hard: 20000
+ },
+ //npmPath: __dirname + '/../../../../stackvana/microcule/' || "/Users/chroot/",
+ npmPath: "/var/chroot/root/microcule/",
+ publicIP: 'worker0',
+ chrootUser: 'worker',
+ useChroot: false,
+ useNSJAIL: false,
+ nsJailArgs: [ '-Mo', '--disable_clone_newnet', '--chroot', '/var/chroot/', '--user', '99999', '--group', '99999', '--rlimit_as', '9999', '--log', 'nsjail.log', '--rlimit_nproc', '1000' ,'--quiet', '--']
+};
+
+module['exports'] = {
+ usingDocker: true,
+ superadmin: {
+ "name": "superadmin",
+ "password": "footy",
+ "super_private_key": "1234"
+ },
+ tailAdmin: {
+ "username": "tails",
+ "password": "password"
+ },
+ // contains definitions for elastic server pools
+ pools : {
+ // Note: All services will auto-port up based on the first available port after the starting port
+ // this allows us define ranges of ports of the elastic pool instead of pre-configuring the pool statically
+ web: cluster.pools.web,
+ worker: cluster.pools.worker,
+ lb: cluster.pools.lb
+ },
+ web: web,
+ balancer: balancer,
+ broadcast: broadcast,
+ baseUrl: "http://localhost:9999",
+ couch: {
+ "database": "hook",
+ "type": "couch2",
+ "username": couch.username,
+ "password": couch.password,
+ "port": couch.port,
+ "host": couch.host
+ },
+ redisCache: {
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ },
+ redis: {
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ },
+ github: {
+ accessName: "",
+ accessToken: "",
+ // working github tokens are given
+ // these are dedicated for hook.io testing
+ // don't use these in production as they may be revoked and refeshed at anytime
+ CLIENT_ID: "321de11108ccdacf2279",
+ CLIENT_SECRET: "14ed41431983aaceef121d32f2f3f3087e0434ac",
+ OAUTH_CALLBACK: "http://localhost:9999/login/github/callback"
+ },
+ defaultTheme : "http://localhost:9999/themes/none/index.html", // should be https?
+ defaultPresenter : "http://localhost:9999/themes/none/index.js",
+ stripe: {
+ secretKey: "sk_test_ZXdJj4I3Db2iB9ZRm0gqyzDV",
+ publicKey: "pk_test_axAR0vF3Qam8zs09JE7t8ZIo"
+ },
+ email: {
+ "provider": "mock",
+ "api_user": "abc",
+ "api_key": "1234"
+ },
+ cacheView: false,
+ // tempDirectory: __dirname + "/../temp/",
+ tempDirectory: "/hook-temp/",
+ sslKeyDirectory: '/src/ssl/',
+ chrootDirectory: '/var/chroot',
+ //sslKeyDirectory: __dirname + '/../ssl/',
+ //chrootDirectory: '/Users/worker',
+ locales: {
+ locales: ['en', 'de']
+ },
+ worker: worker,
+ customDomains: false,
+ MAX_SERVICE_EXECUTIONS_PER_CYCLE: Infinity,
+ MAX_SERVICE_CONCURRENCY: 10,
+ UNTRUSTED_HOOK_TIMEOUT: 10000,
+ messages: {
+ childProcessSpawnError: require('../messages/childProcessSpawnError'),
+ serviceExecutionTimeout: require('../messages/serviceExecutionTimeout'),
+ unauthorizedRoleAccess: require('../messages/unauthorizedRoleAccess')
+ },
+ app: app
+};
diff --git a/config/docker/index.js b/config/docker/index.js
new file mode 100644
index 00000000..07268ad4
--- /dev/null
+++ b/config/docker/index.js
@@ -0,0 +1,183 @@
+const app = {
+ name: "hook.io",
+ // host: "https://hook.io",
+ url: "http://localhost:9999",
+ ws: "ws://localhost:9999",
+ //url: "https://hook.io",
+ domain: "localhost",
+ port: "9999",
+ logo: "http://localhost:9999/img/logo.png",
+ logoInverse: "http://localhost:9999/img/logo-inverse.png",
+ adminEmail: "hookmaster@hook.io"
+};
+
+const redis = {
+ port: 6379,
+ password: "password",
+ host: "redis"
+};
+
+const couch = {
+ "username": "admin",
+ "password": "password",
+ "port": 5984,
+ "host": "couch"
+};
+
+const cluster = {
+ registerWithLoadBalancer: true,
+ pools : {
+ // Note: All services will auto-port up based on the first available port after the starting port
+ // this allows us define ranges of ports of the elastic pool instead of pre-configuring the pool statically
+ web: [],
+ worker: [],
+ lb: []
+ }
+};
+
+const balancer = {
+ port: 9999,
+ host: "app",
+ https: false,
+ publicIP: "127.0.0.1",
+ roots: ["hookio", "0.0.0.0", "localhost", "hook.io", "www.hook.io", "couch"],
+ secret: "change secret",
+ redis: {
+ prefix: '/session/',
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ }
+};
+
+const broadcast = {
+ port: 9998,
+ host: "0.0.0.0",
+ https: false,
+ publicIP: "127.0.0.1",
+ roots: ["ws.hookio", "0.0.0.0", "localhost", "ws.hook.io"],
+ secret: "change secret",
+ redis: {
+ prefix: '/session/',
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ }
+};
+
+const web = {
+ port: 11000,
+ host: "app",
+ https: false,
+ registerWithLoadBalancer: cluster.registerWithLoadBalancer,
+ roots: ["hookio", "0.0.0.0", "localhost", "hook.io", "www.hook.io"],
+ secret: "change secret",
+ redis: {
+ prefix: '/session/',
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ }
+};
+
+const worker = {
+ host: 'worker0',
+ startingPort: 10000,
+ registerWithLoadBalancer: cluster.registerWithLoadBalancer,
+ nproc: {
+ soft: 15000,
+ hard: 20000
+ },
+ //npmPath: __dirname + '/../../../../stackvana/microcule/' || "/Users/chroot/",
+ npmPath: "/var/chroot/root/microcule/",
+ publicIP: 'worker0',
+ chrootUser: 'worker',
+ useChroot: false,
+ useNSJAIL: false,
+ nsJailArgs: [ '-Mo', '--disable_clone_newnet', '--chroot', '/var/chroot/', '--user', '99999', '--group', '99999', '--rlimit_as', '9999', '--log', 'nsjail.log', '--rlimit_nproc', '1000' ,'--quiet', '--']
+};
+
+module['exports'] = {
+ usingDocker: true,
+ superadmin: {
+ "name": "superadmin",
+ "password": "footy",
+ "super_private_key": "1234"
+ },
+ tailAdmin: {
+ "username": "tails",
+ "password": "password"
+ },
+ // contains definitions for elastic server pools
+ pools : {
+ // Note: All services will auto-port up based on the first available port after the starting port
+ // this allows us define ranges of ports of the elastic pool instead of pre-configuring the pool statically
+ web: cluster.pools.web,
+ worker: cluster.pools.worker,
+ lb: cluster.pools.lb
+ },
+ web: web,
+ balancer: balancer,
+ broadcast: broadcast,
+ baseUrl: "http://localhost:9999",
+ couch: {
+ "database": "hook",
+ "type": "couch2",
+ "username": couch.username,
+ "password": couch.password,
+ "port": couch.port,
+ "host": couch.host
+ },
+ redisCache: {
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ },
+ redis: {
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ },
+ github: {
+ accessName: "",
+ accessToken: "",
+ // working github tokens are given
+ // these are dedicated for hook.io testing
+ // don't use these in production as they may be revoked and refeshed at anytime
+ CLIENT_ID: "321de11108ccdacf2279",
+ CLIENT_SECRET: "14ed41431983aaceef121d32f2f3f3087e0434ac",
+ OAUTH_CALLBACK: "http://localhost:9999/login/github/callback"
+ },
+ defaultTheme : "http://localhost:9999/themes/none/index.html", // should be https?
+ defaultPresenter : "http://localhost:9999/themes/none/index.js",
+ stripe: {
+ secretKey: "",
+ publicKey: ""
+ },
+ email: {
+ "provider": "mock",
+ "api_user": "abc",
+ "api_key": "1234"
+ },
+ cacheView: false,
+ // tempDirectory: __dirname + "/../temp/",
+ tempDirectory: "/hook-temp/",
+ sslKeyDirectory: '/src/ssl/',
+ chrootDirectory: '/var/chroot',
+ //sslKeyDirectory: __dirname + '/../ssl/',
+ //chrootDirectory: '/Users/worker',
+ locales: {
+ locales: ['en', 'de']
+ },
+ worker: worker,
+ customDomains: false,
+ MAX_SERVICE_EXECUTIONS_PER_CYCLE: Infinity,
+ MAX_SERVICE_CONCURRENCY: 10,
+ UNTRUSTED_HOOK_TIMEOUT: 10000,
+ messages: {
+ childProcessSpawnError: require('../messages/childProcessSpawnError'),
+ serviceExecutionTimeout: require('../messages/serviceExecutionTimeout'),
+ unauthorizedRoleAccess: require('../messages/unauthorizedRoleAccess')
+ },
+ app: app
+};
diff --git a/config/index.js b/config/index.js
index b8e4bbeb..6ebf0850 100644
--- a/config/index.js
+++ b/config/index.js
@@ -1,24 +1,15 @@
-module['exports'] = {
- site: {
- port: 9999,
- https: false
- },
- couch: {
- "database": "hook",
- "type": "couchdb",
- "username": "admin",
- "password": "password",
- "port": 5984,
- "host": "localhost"
- },
- github: {
- // working github tokens are given
- // these are dedicated for hook.io testing
- // don't use these in production as they may be revoked and refeshed at anytime
- CLIENT_ID: "321de11108ccdacf2279",
- CLIENT_SECRET: "14ed41431983aaceef121d32f2f3f3087e0434ac",
- OAUTH_CALLBACK: "http://localhost:9999/login/callback"
- },
- defaultTheme : "http://localhost:9999/themes/debug/index.html",
- defaultPresenter : "http://localhost:9999/themes/debug/index.js",
-};
\ No newline at end of file
+const isDocker = require('is-docker');
+
+if (isDocker()) {
+ module.exports = require('./docker');
+ module.exports.env = "docker";
+} else {
+ module.exports = require('./dev');
+ module.exports.env = "dev";
+ if (process.env['NODE_ENV'] === 'production') {
+ module.exports = require('./production');
+ module.exports.env = "production";
+ }
+}
+
+// console.log('Info: Using env: ' + module.exports.env);
\ No newline at end of file
diff --git a/config/messages/README.md b/config/messages/README.md
new file mode 100644
index 00000000..838e8d79
--- /dev/null
+++ b/config/messages/README.md
@@ -0,0 +1,5 @@
+This directory contains messages which may be presented to the user.
+
+These messages are configurable, so we can adjust the copy of certain messages without having to touch any sensitive code paths.
+
+This is also useful if you intend to white-label this project.
\ No newline at end of file
diff --git a/config/messages/childProcessSpawnError.js b/config/messages/childProcessSpawnError.js
new file mode 100644
index 00000000..f97ed513
--- /dev/null
+++ b/config/messages/childProcessSpawnError.js
@@ -0,0 +1,8 @@
+module['exports'] = function childProcessSpawnErrorMessage (args) {
+ // TODO: use a template instead of str concat
+ var str = '';
+ str += 'Error in spawning child process. Error code: 1\n';
+ str += 'We attempted to run the following command: \n\n'
+ str += args.join(" ");
+ return str;
+}
\ No newline at end of file
diff --git a/config/messages/serviceExecutionTimeout.js b/config/messages/serviceExecutionTimeout.js
new file mode 100644
index 00000000..583950d5
--- /dev/null
+++ b/config/messages/serviceExecutionTimeout.js
@@ -0,0 +1,12 @@
+module['exports'] = function serviceExecutionTimeoutMessage (seconds) {
+ // TODO: use a template instead of str concat
+ var str = '';
+ str += 'Timeout Limit Hit. Request Aborted! \n\nHook source code took more than ';
+ str += seconds;
+ str += ' complete.\n\n';
+ str += 'A delay of this long may indicate there is an error in the source code for the Hook. \n\n';
+ str += 'If there are no errors and the Hook requires more than ';
+ str += seconds;
+ str += ' seconds to execute, you can upgrade to a paid account to increase your timeout limits.';
+ return str;
+}
\ No newline at end of file
diff --git a/config/messages/unauthorizedRoleAccess.js b/config/messages/unauthorizedRoleAccess.js
new file mode 100644
index 00000000..ec67a593
--- /dev/null
+++ b/config/messages/unauthorizedRoleAccess.js
@@ -0,0 +1,55 @@
+var config;
+process.nextTick(function(){
+ config = require('../');
+});
+
+module['exports'] = function unauthorizedRoleAccess (req, role) {
+ // TODO: use a template instead of str concat
+ var str = '',
+ errorType = "unauthorized-role-access";
+
+ // if no session, create temporary session scope for anonymous user error
+ if (typeof req.session === 'undefined') {
+ req.session = {};
+ }
+
+ if (typeof req.session.user === "undefined") {
+ req.session.user = "anonymous";
+ }
+
+ if (typeof req.resource.params.hook_private_key !== "undefined") {
+ // if key was provided but the role check failed ( since it reached here ) show specific error message
+ str += "A role access check was attempted but failed with key " + '"' + req.resource.params.hook_private_key + '"\n\n';
+ errorType = "unauthorized-role-access";
+ //str += "Try again with a diffirent `hook_private_key` value?\n\n";
+ }
+
+ if (typeof req.resource.keyName !== "undefined") {
+ str += ('"' + req.resource.keyName + '" does not have the role "' + role + '" which is required to access "' + req._parsedUrl.pathname + '"');
+ } else {
+ str += ('"' + req.session.user + '" does not have the role "' + role + '" which is required to access "' + req._parsedUrl.pathname + '"');
+ }
+
+ if (req.session.user === "anonymous") {
+ str += "\n\nIf you are the owner of this resource try logging in at https://" + config.app.domain + "/login";
+ }
+
+ if (typeof req.resource.params.hook_private_key !== "undefined") {
+ // do nothing
+ } else {
+ // provide instructions to provide keys
+ str += "\n\nIf any access keys have been created you can provide a `hook_private_key` parameter to access this URL.";
+ }
+
+ if (req.jsonResponse === true) {
+ str = JSON.stringify({
+ error: true,
+ message: str,
+ user: req.session.user,
+ role: role,
+ type: errorType
+ });
+ }
+
+ return str;
+}
\ No newline at end of file
diff --git a/config/redis/redis.conf b/config/redis/redis.conf
new file mode 100644
index 00000000..02579403
--- /dev/null
+++ b/config/redis/redis.conf
@@ -0,0 +1,938 @@
+# Redis configuration file example
+
+# Note on units: when memory size is needed, it is possible to specify
+# it in the usual form of 1k 5GB 4M and so forth:
+#
+# 1k => 1000 bytes
+# 1kb => 1024 bytes
+# 1m => 1000000 bytes
+# 1mb => 1024*1024 bytes
+# 1g => 1000000000 bytes
+# 1gb => 1024*1024*1024 bytes
+#
+# units are case insensitive so 1GB 1Gb 1gB are all the same.
+
+################################## INCLUDES ###################################
+
+# Include one or more other config files here. This is useful if you
+# have a standard template that goes to all Redis servers but also need
+# to customize a few per-server settings. Include files can include
+# other files, so use this wisely.
+#
+# Notice option "include" won't be rewritten by command "CONFIG REWRITE"
+# from admin or Redis Sentinel. Since Redis always uses the last processed
+# line as value of a configuration directive, you'd better put includes
+# at the beginning of this file to avoid overwriting config change at runtime.
+#
+# If instead you are interested in using includes to override configuration
+# options, it is better to use include as the last line.
+#
+# include /path/to/local.conf
+# include /path/to/other.conf
+
+################################ GENERAL #####################################
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /usr/local/var/run/redis.pid when daemonized.
+daemonize yes
+
+# When running daemonized, Redis writes a pid file in /usr/local/var/run/redis.pid by
+# default. You can specify a custom pid file location here.
+pidfile /usr/local/var/run/redis.pid
+
+# Accept connections on the specified port, default is 6379.
+# If port 0 is specified Redis will not listen on a TCP socket.
+port 6379
+
+# TCP listen() backlog.
+#
+# In high requests-per-second environments you need an high backlog in order
+# to avoid slow clients connections issues. Note that the Linux kernel
+# will silently truncate it to the value of /proc/sys/net/core/somaxconn so
+# make sure to raise both the value of somaxconn and tcp_max_syn_backlog
+# in order to get the desired effect.
+tcp-backlog 511
+
+# By default Redis listens for connections from all the network interfaces
+# available on the server. It is possible to listen to just one or multiple
+# interfaces using the "bind" configuration directive, followed by one or
+# more IP addresses.
+#
+# Examples:
+#
+# bind 192.168.1.100 10.0.0.1
+# bind 127.0.0.1
+
+# Specify the path for the Unix socket that will be used to listen for
+# incoming connections. There is no default, so Redis will not listen
+# on a unix socket when not specified.
+#
+# unixsocket /tmp/redis.sock
+# unixsocketperm 700
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 0
+
+# TCP keepalive.
+#
+# If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence
+# of communication. This is useful for two reasons:
+#
+# 1) Detect dead peers.
+# 2) Take the connection alive from the point of view of network
+# equipment in the middle.
+#
+# On Linux, the specified value (in seconds) is the period used to send ACKs.
+# Note that to close the connection the double of the time is needed.
+# On other kernels the period depends on the kernel configuration.
+#
+# A reasonable value for this option is 60 seconds.
+tcp-keepalive 0
+
+# Specify the server verbosity level.
+# This can be one of:
+# debug (a lot of information, useful for development/testing)
+# verbose (many rarely useful info, but not a mess like the debug level)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel notice
+
+# Specify the log file name. Also the empty string can be used to force
+# Redis to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile ""
+
+# To enable logging to the system logger, just set 'syslog-enabled' to yes,
+# and optionally update the other syslog parameters to suit your needs.
+# syslog-enabled no
+
+# Specify the syslog identity.
+# syslog-ident redis
+
+# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
+# syslog-facility local0
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+################################ SNAPSHOTTING ################################
+#
+# Save the DB on disk:
+#
+# save
+#
+# Will save the DB if both the given number of seconds and the given
+# number of write operations against the DB occurred.
+#
+# In the example below the behaviour will be to save:
+# after 900 sec (15 min) if at least 1 key changed
+# after 300 sec (5 min) if at least 10 keys changed
+# after 60 sec if at least 10000 keys changed
+#
+# Note: you can disable saving completely by commenting out all "save" lines.
+#
+# It is also possible to remove all the previously configured save
+# points by adding a save directive with a single empty string argument
+# like in the following example:
+#
+# save ""
+
+save 900 1
+save 300 10
+save 60 10000
+
+# By default Redis will stop accepting writes if RDB snapshots are enabled
+# (at least one save point) and the latest background save failed.
+# This will make the user aware (in a hard way) that data is not persisting
+# on disk properly, otherwise chances are that no one will notice and some
+# disaster will happen.
+#
+# If the background saving process will start working again Redis will
+# automatically allow writes again.
+#
+# However if you have setup your proper monitoring of the Redis server
+# and persistence, you may want to disable this feature so that Redis will
+# continue to work as usual even if there are problems with disk,
+# permissions, and so forth.
+stop-writes-on-bgsave-error yes
+
+# Compress string objects using LZF when dump .rdb databases?
+# For default that's set to 'yes' as it's almost always a win.
+# If you want to save some CPU in the saving child set it to 'no' but
+# the dataset will likely be bigger if you have compressible values or keys.
+rdbcompression yes
+
+# Since version 5 of RDB a CRC64 checksum is placed at the end of the file.
+# This makes the format more resistant to corruption but there is a performance
+# hit to pay (around 10%) when saving and loading RDB files, so you can disable it
+# for maximum performances.
+#
+# RDB files created with checksum disabled have a checksum of zero that will
+# tell the loading code to skip the check.
+rdbchecksum yes
+
+# The filename where to dump the DB
+dbfilename dump.rdb
+
+# The working directory.
+#
+# The DB will be written inside this directory, with the filename specified
+# above using the 'dbfilename' configuration directive.
+#
+# The Append Only File will also be created inside this directory.
+#
+# Note that you must specify a directory here, not a file name.
+dir /usr/local/var/db/redis/
+
+################################# REPLICATION #################################
+
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. A few things to understand ASAP about Redis replication.
+#
+# 1) Redis replication is asynchronous, but you can configure a master to
+# stop accepting writes if it appears to be not connected with at least
+# a given number of slaves.
+# 2) Redis slaves are able to perform a partial resynchronization with the
+# master if the replication link is lost for a relatively small amount of
+# time. You may want to configure the replication backlog size (see the next
+# sections of this file) with a sensible value depending on your needs.
+# 3) Replication is automatic and does not need user intervention. After a
+# network partition slaves automatically try to reconnect to masters
+# and resynchronize with them.
+#
+# slaveof
+
+# If the master is password protected (using the "requirepass" configuration
+# directive below) it is possible to tell the slave to authenticate before
+# starting the replication synchronization process, otherwise the master will
+# refuse the slave request.
+#
+masterauth password
+
+# When a slave loses its connection with the master, or when the replication
+# is still in progress, the slave can act in two different ways:
+#
+# 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
+# still reply to client requests, possibly with out of date data, or the
+# data set may just be empty if this is the first synchronization.
+#
+# 2) if slave-serve-stale-data is set to 'no' the slave will reply with
+# an error "SYNC with master in progress" to all the kind of commands
+# but to INFO and SLAVEOF.
+#
+slave-serve-stale-data yes
+
+# You can configure a slave instance to accept writes or not. Writing against
+# a slave instance may be useful to store some ephemeral data (because data
+# written on a slave will be easily deleted after resync with the master) but
+# may also cause problems if clients are writing to it because of a
+# misconfiguration.
+#
+# Since Redis 2.6 by default slaves are read-only.
+#
+# Note: read only slaves are not designed to be exposed to untrusted clients
+# on the internet. It's just a protection layer against misuse of the instance.
+# Still a read only slave exports by default all the administrative commands
+# such as CONFIG, DEBUG, and so forth. To a limited extent you can improve
+# security of read only slaves using 'rename-command' to shadow all the
+# administrative / dangerous commands.
+slave-read-only yes
+
+# Replication SYNC strategy: disk or socket.
+#
+# -------------------------------------------------------
+# WARNING: DISKLESS REPLICATION IS EXPERIMENTAL CURRENTLY
+# -------------------------------------------------------
+#
+# New slaves and reconnecting slaves that are not able to continue the replication
+# process just receiving differences, need to do what is called a "full
+# synchronization". An RDB file is transmitted from the master to the slaves.
+# The transmission can happen in two different ways:
+#
+# 1) Disk-backed: The Redis master creates a new process that writes the RDB
+# file on disk. Later the file is transferred by the parent
+# process to the slaves incrementally.
+# 2) Diskless: The Redis master creates a new process that directly writes the
+# RDB file to slave sockets, without touching the disk at all.
+#
+# With disk-backed replication, while the RDB file is generated, more slaves
+# can be queued and served with the RDB file as soon as the current child producing
+# the RDB file finishes its work. With diskless replication instead once
+# the transfer starts, new slaves arriving will be queued and a new transfer
+# will start when the current one terminates.
+#
+# When diskless replication is used, the master waits a configurable amount of
+# time (in seconds) before starting the transfer in the hope that multiple slaves
+# will arrive and the transfer can be parallelized.
+#
+# With slow disks and fast (large bandwidth) networks, diskless replication
+# works better.
+repl-diskless-sync no
+
+# When diskless replication is enabled, it is possible to configure the delay
+# the server waits in order to spawn the child that transfers the RDB via socket
+# to the slaves.
+#
+# This is important since once the transfer starts, it is not possible to serve
+# new slaves arriving, that will be queued for the next RDB transfer, so the server
+# waits a delay in order to let more slaves arrive.
+#
+# The delay is specified in seconds, and by default is 5 seconds. To disable
+# it entirely just set it to 0 seconds and the transfer will start ASAP.
+repl-diskless-sync-delay 5
+
+# Slaves send PINGs to server in a predefined interval. It's possible to change
+# this interval with the repl_ping_slave_period option. The default value is 10
+# seconds.
+#
+# repl-ping-slave-period 10
+
+# The following option sets the replication timeout for:
+#
+# 1) Bulk transfer I/O during SYNC, from the point of view of slave.
+# 2) Master timeout from the point of view of slaves (data, pings).
+# 3) Slave timeout from the point of view of masters (REPLCONF ACK pings).
+#
+# It is important to make sure that this value is greater than the value
+# specified for repl-ping-slave-period otherwise a timeout will be detected
+# every time there is low traffic between the master and the slave.
+#
+# repl-timeout 60
+
+# Disable TCP_NODELAY on the slave socket after SYNC?
+#
+# If you select "yes" Redis will use a smaller number of TCP packets and
+# less bandwidth to send data to slaves. But this can add a delay for
+# the data to appear on the slave side, up to 40 milliseconds with
+# Linux kernels using a default configuration.
+#
+# If you select "no" the delay for data to appear on the slave side will
+# be reduced but more bandwidth will be used for replication.
+#
+# By default we optimize for low latency, but in very high traffic conditions
+# or when the master and slaves are many hops away, turning this to "yes" may
+# be a good idea.
+repl-disable-tcp-nodelay no
+
+# Set the replication backlog size. The backlog is a buffer that accumulates
+# slave data when slaves are disconnected for some time, so that when a slave
+# wants to reconnect again, often a full resync is not needed, but a partial
+# resync is enough, just passing the portion of data the slave missed while
+# disconnected.
+#
+# The bigger the replication backlog, the longer the time the slave can be
+# disconnected and later be able to perform a partial resynchronization.
+#
+# The backlog is only allocated once there is at least a slave connected.
+#
+# repl-backlog-size 1mb
+
+# After a master has no longer connected slaves for some time, the backlog
+# will be freed. The following option configures the amount of seconds that
+# need to elapse, starting from the time the last slave disconnected, for
+# the backlog buffer to be freed.
+#
+# A value of 0 means to never release the backlog.
+#
+# repl-backlog-ttl 3600
+
+# The slave priority is an integer number published by Redis in the INFO output.
+# It is used by Redis Sentinel in order to select a slave to promote into a
+# master if the master is no longer working correctly.
+#
+# A slave with a low priority number is considered better for promotion, so
+# for instance if there are three slaves with priority 10, 100, 25 Sentinel will
+# pick the one with priority 10, that is the lowest.
+#
+# However a special priority of 0 marks the slave as not able to perform the
+# role of master, so a slave with priority of 0 will never be selected by
+# Redis Sentinel for promotion.
+#
+# By default the priority is 100.
+slave-priority 100
+
+# It is possible for a master to stop accepting writes if there are less than
+# N slaves connected, having a lag less or equal than M seconds.
+#
+# The N slaves need to be in "online" state.
+#
+# The lag in seconds, that must be <= the specified value, is calculated from
+# the last ping received from the slave, that is usually sent every second.
+#
+# This option does not GUARANTEE that N replicas will accept the write, but
+# will limit the window of exposure for lost writes in case not enough slaves
+# are available, to the specified number of seconds.
+#
+# For example to require at least 3 slaves with a lag <= 10 seconds use:
+#
+# min-slaves-to-write 3
+# min-slaves-max-lag 10
+#
+# Setting one or the other to 0 disables the feature.
+#
+# By default min-slaves-to-write is set to 0 (feature disabled) and
+# min-slaves-max-lag is set to 10.
+
+################################## SECURITY ###################################
+
+# Require clients to issue AUTH before processing any other
+# commands. This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+#
+# Warning: since Redis is pretty fast an outside user can try up to
+# 150k passwords per second against a good box. This means that you should
+# use a very strong password otherwise it will be very easy to break.
+#
+requirepass mypassword
+
+# Command renaming.
+#
+# It is possible to change the name of dangerous commands in a shared
+# environment. For instance the CONFIG command may be renamed into something
+# hard to guess so that it will still be available for internal-use tools
+# but not available for general clients.
+#
+# Example:
+#
+# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
+#
+# It is also possible to completely kill a command by renaming it into
+# an empty string:
+#
+# rename-command CONFIG ""
+#
+# Please note that changing the name of commands that are logged into the
+# AOF file or transmitted to slaves may cause problems.
+
+################################### LIMITS ####################################
+
+# Set the max number of connected clients at the same time. By default
+# this limit is set to 10000 clients, however if the Redis server is not
+# able to configure the process file limit to allow for the specified limit
+# the max number of allowed clients is set to the current file limit
+# minus 32 (as Redis reserves a few file descriptors for internal uses).
+#
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+#
+# maxclients 10000
+
+# Don't use more memory than the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys
+# according to the eviction policy selected (see maxmemory-policy).
+#
+# If Redis can't remove keys according to the policy, or if the policy is
+# set to 'noeviction', Redis will start to reply with errors to commands
+# that would use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to read-only commands like GET.
+#
+# This option is usually useful when using Redis as an LRU cache, or to set
+# a hard memory limit for an instance (using the 'noeviction' policy).
+#
+# WARNING: If you have slaves attached to an instance with maxmemory on,
+# the size of the output buffers needed to feed the slaves are subtracted
+# from the used memory count, so that network problems / resyncs will
+# not trigger a loop where keys are evicted, and in turn the output
+# buffer of slaves is full with DELs of keys evicted triggering the deletion
+# of more keys, and so forth until the database is completely emptied.
+#
+# In short... if you have slaves attached it is suggested that you set a lower
+# limit for maxmemory so that there is some free RAM on the system for slave
+# output buffers (but this is not needed if the policy is 'noeviction').
+#
+# maxmemory
+
+# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
+# is reached. You can select among five behaviors:
+#
+# volatile-lru -> remove the key with an expire set using an LRU algorithm
+# allkeys-lru -> remove any key according to the LRU algorithm
+# volatile-random -> remove a random key with an expire set
+# allkeys-random -> remove a random key, any key
+# volatile-ttl -> remove the key with the nearest expire time (minor TTL)
+# noeviction -> don't expire at all, just return an error on write operations
+#
+# Note: with any of the above policies, Redis will return an error on write
+# operations, when there are no suitable keys for eviction.
+#
+# At the date of writing these commands are: set setnx setex append
+# incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
+# sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
+# zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
+# getset mset msetnx exec sort
+#
+# The default is:
+#
+# maxmemory-policy noeviction
+
+# LRU and minimal TTL algorithms are not precise algorithms but approximated
+# algorithms (in order to save memory), so you can tune it for speed or
+# accuracy. For default Redis will check five keys and pick the one that was
+# used less recently, you can change the sample size using the following
+# configuration directive.
+#
+# The default of 5 produces good enough results. 10 Approximates very closely
+# true LRU but costs a bit more CPU. 3 is very fast but not very accurate.
+#
+# maxmemory-samples 5
+
+############################## APPEND ONLY MODE ###############################
+
+# By default Redis asynchronously dumps the dataset on disk. This mode is
+# good enough in many applications, but an issue with the Redis process or
+# a power outage may result into a few minutes of writes lost (depending on
+# the configured save points).
+#
+# The Append Only File is an alternative persistence mode that provides
+# much better durability. For instance using the default data fsync policy
+# (see later in the config file) Redis can lose just one second of writes in a
+# dramatic event like a server power outage, or a single write if something
+# wrong with the Redis process itself happens, but the operating system is
+# still running correctly.
+#
+# AOF and RDB persistence can be enabled at the same time without problems.
+# If the AOF is enabled on startup Redis will load the AOF, that is the file
+# with the better durability guarantees.
+#
+# Please check http://redis.io/topics/persistence for more information.
+
+appendonly no
+
+# The name of the append only file (default: "appendonly.aof")
+
+appendfilename "appendonly.aof"
+
+# The fsync() call tells the Operating System to actually write data on disk
+# instead of waiting for more data in the output buffer. Some OS will really flush
+# data on disk, some other OS will just try to do it ASAP.
+#
+# Redis supports three different modes:
+#
+# no: don't fsync, just let the OS flush the data when it wants. Faster.
+# always: fsync after every write to the append only log. Slow, Safest.
+# everysec: fsync only one time every second. Compromise.
+#
+# The default is "everysec", as that's usually the right compromise between
+# speed and data safety. It's up to you to understand if you can relax this to
+# "no" that will let the operating system flush the output buffer when
+# it wants, for better performances (but if you can live with the idea of
+# some data loss consider the default persistence mode that's snapshotting),
+# or on the contrary, use "always" that's very slow but a bit safer than
+# everysec.
+#
+# More details please check the following article:
+# http://antirez.com/post/redis-persistence-demystified.html
+#
+# If unsure, use "everysec".
+
+# appendfsync always
+appendfsync everysec
+# appendfsync no
+
+# When the AOF fsync policy is set to always or everysec, and a background
+# saving process (a background save or AOF log background rewriting) is
+# performing a lot of I/O against the disk, in some Linux configurations
+# Redis may block too long on the fsync() call. Note that there is no fix for
+# this currently, as even performing fsync in a different thread will block
+# our synchronous write(2) call.
+#
+# In order to mitigate this problem it's possible to use the following option
+# that will prevent fsync() from being called in the main process while a
+# BGSAVE or BGREWRITEAOF is in progress.
+#
+# This means that while another child is saving, the durability of Redis is
+# the same as "appendfsync none". In practical terms, this means that it is
+# possible to lose up to 30 seconds of log in the worst scenario (with the
+# default Linux settings).
+#
+# If you have latency problems turn this to "yes". Otherwise leave it as
+# "no" that is the safest pick from the point of view of durability.
+
+no-appendfsync-on-rewrite no
+
+# Automatic rewrite of the append only file.
+# Redis is able to automatically rewrite the log file implicitly calling
+# BGREWRITEAOF when the AOF log size grows by the specified percentage.
+#
+# This is how it works: Redis remembers the size of the AOF file after the
+# latest rewrite (if no rewrite has happened since the restart, the size of
+# the AOF at startup is used).
+#
+# This base size is compared to the current size. If the current size is
+# bigger than the specified percentage, the rewrite is triggered. Also
+# you need to specify a minimal size for the AOF file to be rewritten, this
+# is useful to avoid rewriting the AOF file even if the percentage increase
+# is reached but it is still pretty small.
+#
+# Specify a percentage of zero in order to disable the automatic AOF
+# rewrite feature.
+
+auto-aof-rewrite-percentage 100
+auto-aof-rewrite-min-size 64mb
+
+# An AOF file may be found to be truncated at the end during the Redis
+# startup process, when the AOF data gets loaded back into memory.
+# This may happen when the system where Redis is running
+# crashes, especially when an ext4 filesystem is mounted without the
+# data=ordered option (however this can't happen when Redis itself
+# crashes or aborts but the operating system still works correctly).
+#
+# Redis can either exit with an error when this happens, or load as much
+# data as possible (the default now) and start if the AOF file is found
+# to be truncated at the end. The following option controls this behavior.
+#
+# If aof-load-truncated is set to yes, a truncated AOF file is loaded and
+# the Redis server starts emitting a log to inform the user of the event.
+# Otherwise if the option is set to no, the server aborts with an error
+# and refuses to start. When the option is set to no, the user requires
+# to fix the AOF file using the "redis-check-aof" utility before to restart
+# the server.
+#
+# Note that if the AOF file will be found to be corrupted in the middle
+# the server will still exit with an error. This option only applies when
+# Redis will try to read more data from the AOF file but not enough bytes
+# will be found.
+aof-load-truncated yes
+
+################################ LUA SCRIPTING ###############################
+
+# Max execution time of a Lua script in milliseconds.
+#
+# If the maximum execution time is reached Redis will log that a script is
+# still in execution after the maximum allowed time and will start to
+# reply to queries with an error.
+#
+# When a long running script exceeds the maximum execution time only the
+# SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be
+# used to stop a script that did not yet called write commands. The second
+# is the only way to shut down the server in the case a write command was
+# already issued by the script but the user doesn't want to wait for the natural
+# termination of the script.
+#
+# Set it to 0 or a negative value for unlimited execution without warnings.
+lua-time-limit 5000
+
+################################ REDIS CLUSTER ###############################
+#
+# ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# WARNING EXPERIMENTAL: Redis Cluster is considered to be stable code, however
+# in order to mark it as "mature" we need to wait for a non trivial percentage
+# of users to deploy it in production.
+# ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+#
+# Normal Redis instances can't be part of a Redis Cluster; only nodes that are
+# started as cluster nodes can. In order to start a Redis instance as a
+# cluster node enable the cluster support uncommenting the following:
+#
+# cluster-enabled yes
+
+# Every cluster node has a cluster configuration file. This file is not
+# intended to be edited by hand. It is created and updated by Redis nodes.
+# Every Redis Cluster node requires a different cluster configuration file.
+# Make sure that instances running in the same system do not have
+# overlapping cluster configuration file names.
+#
+# cluster-config-file nodes-6379.conf
+
+# Cluster node timeout is the amount of milliseconds a node must be unreachable
+# for it to be considered in failure state.
+# Most other internal time limits are multiple of the node timeout.
+#
+# cluster-node-timeout 15000
+
+# A slave of a failing master will avoid to start a failover if its data
+# looks too old.
+#
+# There is no simple way for a slave to actually have a exact measure of
+# its "data age", so the following two checks are performed:
+#
+# 1) If there are multiple slaves able to failover, they exchange messages
+# in order to try to give an advantage to the slave with the best
+# replication offset (more data from the master processed).
+# Slaves will try to get their rank by offset, and apply to the start
+# of the failover a delay proportional to their rank.
+#
+# 2) Every single slave computes the time of the last interaction with
+# its master. This can be the last ping or command received (if the master
+# is still in the "connected" state), or the time that elapsed since the
+# disconnection with the master (if the replication link is currently down).
+# If the last interaction is too old, the slave will not try to failover
+# at all.
+#
+# The point "2" can be tuned by user. Specifically a slave will not perform
+# the failover if, since the last interaction with the master, the time
+# elapsed is greater than:
+#
+# (node-timeout * slave-validity-factor) + repl-ping-slave-period
+#
+# So for example if node-timeout is 30 seconds, and the slave-validity-factor
+# is 10, and assuming a default repl-ping-slave-period of 10 seconds, the
+# slave will not try to failover if it was not able to talk with the master
+# for longer than 310 seconds.
+#
+# A large slave-validity-factor may allow slaves with too old data to failover
+# a master, while a too small value may prevent the cluster from being able to
+# elect a slave at all.
+#
+# For maximum availability, it is possible to set the slave-validity-factor
+# to a value of 0, which means, that slaves will always try to failover the
+# master regardless of the last time they interacted with the master.
+# (However they'll always try to apply a delay proportional to their
+# offset rank).
+#
+# Zero is the only value able to guarantee that when all the partitions heal
+# the cluster will always be able to continue.
+#
+# cluster-slave-validity-factor 10
+
+# Cluster slaves are able to migrate to orphaned masters, that are masters
+# that are left without working slaves. This improves the cluster ability
+# to resist to failures as otherwise an orphaned master can't be failed over
+# in case of failure if it has no working slaves.
+#
+# Slaves migrate to orphaned masters only if there are still at least a
+# given number of other working slaves for their old master. This number
+# is the "migration barrier". A migration barrier of 1 means that a slave
+# will migrate only if there is at least 1 other working slave for its master
+# and so forth. It usually reflects the number of slaves you want for every
+# master in your cluster.
+#
+# Default is 1 (slaves migrate only if their masters remain with at least
+# one slave). To disable migration just set it to a very large value.
+# A value of 0 can be set but is useful only for debugging and dangerous
+# in production.
+#
+# cluster-migration-barrier 1
+
+# By default Redis Cluster nodes stop accepting queries if they detect there
+# is at least an hash slot uncovered (no available node is serving it).
+# This way if the cluster is partially down (for example a range of hash slots
+# are no longer covered) all the cluster becomes, eventually, unavailable.
+# It automatically returns available as soon as all the slots are covered again.
+#
+# However sometimes you want the subset of the cluster which is working,
+# to continue to accept queries for the part of the key space that is still
+# covered. In order to do so, just set the cluster-require-full-coverage
+# option to no.
+#
+# cluster-require-full-coverage yes
+
+# In order to setup your cluster make sure to read the documentation
+# available at http://redis.io web site.
+
+################################## SLOW LOG ###################################
+
+# The Redis Slow Log is a system to log queries that exceeded a specified
+# execution time. The execution time does not include the I/O operations
+# like talking with the client, sending the reply and so forth,
+# but just the time needed to actually execute the command (this is the only
+# stage of command execution where the thread is blocked and can not serve
+# other requests in the meantime).
+#
+# You can configure the slow log with two parameters: one tells Redis
+# what is the execution time, in microseconds, to exceed in order for the
+# command to get logged, and the other parameter is the length of the
+# slow log. When a new command is logged the oldest one is removed from the
+# queue of logged commands.
+
+# The following time is expressed in microseconds, so 1000000 is equivalent
+# to one second. Note that a negative number disables the slow log, while
+# a value of zero forces the logging of every command.
+slowlog-log-slower-than 10000
+
+# There is no limit to this length. Just be aware that it will consume memory.
+# You can reclaim memory used by the slow log with SLOWLOG RESET.
+slowlog-max-len 128
+
+################################ LATENCY MONITOR ##############################
+
+# The Redis latency monitoring subsystem samples different operations
+# at runtime in order to collect data related to possible sources of
+# latency of a Redis instance.
+#
+# Via the LATENCY command this information is available to the user that can
+# print graphs and obtain reports.
+#
+# The system only logs operations that were performed in a time equal or
+# greater than the amount of milliseconds specified via the
+# latency-monitor-threshold configuration directive. When its value is set
+# to zero, the latency monitor is turned off.
+#
+# By default latency monitoring is disabled since it is mostly not needed
+# if you don't have latency issues, and collecting data has a performance
+# impact, that while very small, can be measured under big load. Latency
+# monitoring can easily be enabled at runtime using the command
+# "CONFIG SET latency-monitor-threshold " if needed.
+latency-monitor-threshold 0
+
+############################# EVENT NOTIFICATION ##############################
+
+# Redis can notify Pub/Sub clients about events happening in the key space.
+# This feature is documented at http://redis.io/topics/notifications
+#
+# For instance if keyspace events notification is enabled, and a client
+# performs a DEL operation on key "foo" stored in the Database 0, two
+# messages will be published via Pub/Sub:
+#
+# PUBLISH __keyspace@0__:foo del
+# PUBLISH __keyevent@0__:del foo
+#
+# It is possible to select the events that Redis will notify among a set
+# of classes. Every class is identified by a single character:
+#
+# K Keyspace events, published with __keyspace@__ prefix.
+# E Keyevent events, published with __keyevent@__ prefix.
+# g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ...
+# $ String commands
+# l List commands
+# s Set commands
+# h Hash commands
+# z Sorted set commands
+# x Expired events (events generated every time a key expires)
+# e Evicted events (events generated when a key is evicted for maxmemory)
+# A Alias for g$lshzxe, so that the "AKE" string means all the events.
+#
+# The "notify-keyspace-events" takes as argument a string that is composed
+# of zero or multiple characters. The empty string means that notifications
+# are disabled.
+#
+# Example: to enable list and generic events, from the point of view of the
+# event name, use:
+#
+# notify-keyspace-events Elg
+#
+# Example 2: to get the stream of the expired keys subscribing to channel
+# name __keyevent@0__:expired use:
+#
+# notify-keyspace-events Ex
+#
+# By default all notifications are disabled because most users don't need
+# this feature and the feature has some overhead. Note that if you don't
+# specify at least one of K or E, no events will be delivered.
+notify-keyspace-events ""
+
+############################### ADVANCED CONFIG ###############################
+
+# Hashes are encoded using a memory efficient data structure when they have a
+# small number of entries, and the biggest entry does not exceed a given
+# threshold. These thresholds can be configured using the following directives.
+hash-max-ziplist-entries 512
+hash-max-ziplist-value 64
+
+# Similarly to hashes, small lists are also encoded in a special way in order
+# to save a lot of space. The special representation is only used when
+# you are under the following limits:
+list-max-ziplist-entries 512
+list-max-ziplist-value 64
+
+# Sets have a special encoding in just one case: when a set is composed
+# of just strings that happen to be integers in radix 10 in the range
+# of 64 bit signed integers.
+# The following configuration setting sets the limit in the size of the
+# set in order to use this special memory saving encoding.
+set-max-intset-entries 512
+
+# Similarly to hashes and lists, sorted sets are also specially encoded in
+# order to save a lot of space. This encoding is only used when the length and
+# elements of a sorted set are below the following limits:
+zset-max-ziplist-entries 128
+zset-max-ziplist-value 64
+
+# HyperLogLog sparse representation bytes limit. The limit includes the
+# 16 bytes header. When an HyperLogLog using the sparse representation crosses
+# this limit, it is converted into the dense representation.
+#
+# A value greater than 16000 is totally useless, since at that point the
+# dense representation is more memory efficient.
+#
+# The suggested value is ~ 3000 in order to have the benefits of
+# the space efficient encoding without slowing down too much PFADD,
+# which is O(N) with the sparse encoding. The value can be raised to
+# ~ 10000 when CPU is not a concern, but space is, and the data set is
+# composed of many HyperLogLogs with cardinality in the 0 - 15000 range.
+hll-sparse-max-bytes 3000
+
+# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
+# order to help rehashing the main Redis hash table (the one mapping top-level
+# keys to values). The hash table implementation Redis uses (see dict.c)
+# performs a lazy rehashing: the more operation you run into a hash table
+# that is rehashing, the more rehashing "steps" are performed, so if the
+# server is idle the rehashing is never complete and some more memory is used
+# by the hash table.
+#
+# The default is to use this millisecond 10 times every second in order to
+# actively rehash the main dictionaries, freeing memory when possible.
+#
+# If unsure:
+# use "activerehashing no" if you have hard latency requirements and it is
+# not a good thing in your environment that Redis can reply from time to time
+# to queries with 2 milliseconds delay.
+#
+# use "activerehashing yes" if you don't have such hard requirements but
+# want to free memory asap when possible.
+activerehashing yes
+
+# The client output buffer limits can be used to force disconnection of clients
+# that are not reading data from the server fast enough for some reason (a
+# common reason is that a Pub/Sub client can't consume messages as fast as the
+# publisher can produce them).
+#
+# The limit can be set differently for the three different classes of clients:
+#
+# normal -> normal clients including MONITOR clients
+# slave -> slave clients
+# pubsub -> clients subscribed to at least one pubsub channel or pattern
+#
+# The syntax of every client-output-buffer-limit directive is the following:
+#
+# client-output-buffer-limit
+#
+# A client is immediately disconnected once the hard limit is reached, or if
+# the soft limit is reached and remains reached for the specified number of
+# seconds (continuously).
+# So for instance if the hard limit is 32 megabytes and the soft limit is
+# 16 megabytes / 10 seconds, the client will get disconnected immediately
+# if the size of the output buffers reach 32 megabytes, but will also get
+# disconnected if the client reaches 16 megabytes and continuously overcomes
+# the limit for 10 seconds.
+#
+# By default normal clients are not limited because they don't receive data
+# without asking (in a push way), but just after a request, so only
+# asynchronous clients may create a scenario where data is requested faster
+# than it can read.
+#
+# Instead there is a default limit for pubsub and slave clients, since
+# subscribers and slaves receive data in a push fashion.
+#
+# Both the hard or the soft limit can be disabled by setting them to zero.
+client-output-buffer-limit normal 0 0 0
+client-output-buffer-limit slave 256mb 64mb 60
+client-output-buffer-limit pubsub 32mb 8mb 60
+
+# Redis calls an internal function to perform many background tasks, like
+# closing connections of clients in timeout, purging expired keys that are
+# never requested, and so forth.
+#
+# Not all tasks are performed with the same frequency, but Redis checks for
+# tasks to perform according to the specified "hz" value.
+#
+# By default "hz" is set to 10. Raising the value will use more CPU when
+# Redis is idle, but at the same time will make Redis more responsive when
+# there are many keys expiring at the same time, and timeouts may be
+# handled with more precision.
+#
+# The range is between 1 and 500, however a value over 100 is usually not
+# a good idea. Most users should use the default of 10 and raise this up to
+# 100 only in environments where very low latency is required.
+hz 10
+
+# When a child rewrites the AOF file, if the following option is enabled
+# the file will be fsync-ed every 32 MB of data generated. This is useful
+# in order to commit the file to the disk more incrementally and avoid
+# big latency spikes.
+aof-rewrite-incremental-fsync yes
diff --git a/docker-compose.yml b/docker-compose.yml
new file mode 100644
index 00000000..4beb1b72
--- /dev/null
+++ b/docker-compose.yml
@@ -0,0 +1,59 @@
+version: '2'
+services:
+ redis:
+ build: ./docker/redis
+
+ couch:
+ build: ./docker/couchdb
+ ports:
+ - "9998:5984"
+
+ app:
+ build: .
+ volumes:
+ - .:/src
+ - /src/node_modules
+ command: /src/bin/docker/wait redis couch worker0 balancer -c node /src/bin/services/web
+ depends_on:
+ - "redis"
+ - "couch"
+ ports:
+ - "11000:11000"
+
+ balancer:
+ #build: .
+ volumes:
+ - .:/src
+ - /src/node_modules
+ image: "hookio_app"
+ command: /src/bin/docker/wait redis -c node /src/bin/services/load-balancer
+ ports:
+ - "9999:9999"
+ depends_on:
+ - "app"
+ links:
+ - "app:web"
+
+ worker0:
+ #build: .
+ volumes:
+ - .:/src
+ - /src/node_modules
+ image: "hookio_app"
+ command: /src/bin/docker/wait redis couch -c node /src/bin/services/worker
+ privileged: true
+ ports:
+ - "10000:10000"
+ depends_on:
+ - "app"
+ links:
+ - "app:web"
+
+ setup:
+ image: "hookio_app"
+ command: /src/bin/docker/wait couch -c /src/bin/docker/initialize
+ depends_on:
+ - "app"
+ links:
+ - "app:web"
+
diff --git a/docker/couchdb/Dockerfile b/docker/couchdb/Dockerfile
new file mode 100644
index 00000000..2e5ea040
--- /dev/null
+++ b/docker/couchdb/Dockerfile
@@ -0,0 +1,4 @@
+FROM klaemo/couchdb:2.0.0
+
+# Require valid user
+COPY local.ini /usr/local/etc/couchdb/
diff --git a/docker/couchdb/local.ini b/docker/couchdb/local.ini
new file mode 100644
index 00000000..811a3bed
--- /dev/null
+++ b/docker/couchdb/local.ini
@@ -0,0 +1,100 @@
+; CouchDB Configuration Settings
+
+; Custom settings should be made in this file. They will override settings
+; in default.ini, but unlike changes made to default.ini, this file won't be
+; overwritten on server upgrade.
+
+[couchdb]
+;max_document_size = 4294967296 ; bytes
+uuid = b91491f15007724ce484335ac8e4e3aa
+
+[httpd]
+;port = 5984
+;bind_address = 127.0.0.1
+; Options for the MochiWeb HTTP server.
+;server_options = [{backlog, 128}, {acceptor_pool_size, 16}]
+; For more socket options, consult Erlang's module 'inet' man page.
+;socket_options = [{recbuf, 262144}, {sndbuf, 262144}, {nodelay, true}]
+
+; Uncomment next line to trigger basic-auth popup on unauthorized requests.
+;WWW-Authenticate = Basic realm="administrator"
+
+; Uncomment next line to set the configuration modification whitelist. Only
+; whitelisted values may be changed via the /_config URLs. To allow the admin
+; to change this value over HTTP, remember to include {httpd,config_whitelist}
+; itself. Excluding it from the list would require editing this file to update
+; the whitelist.
+;config_whitelist = [{httpd,config_whitelist}, {log,level}, {etc,etc}]
+
+[query_servers]
+;nodejs = /usr/local/bin/couchjs-node /path/to/couchdb/share/server/main.js
+
+
+[httpd_global_handlers]
+;_google = {couch_httpd_proxy, handle_proxy_req, <<"http://www.google.com">>}
+
+[couch_httpd_auth]
+; If you set this to true, you should also uncomment the WWW-Authenticate line
+; above. If you don't configure a WWW-Authenticate header, CouchDB will send
+; Basic realm="server" in order to prevent you getting logged out.
+; require_valid_user = false
+secret = ea37364d6ff204bbcf8ae40574dd9292
+
+[log]
+;level = debug
+
+[log_level_by_module]
+; In this section you can specify any of the four log levels 'none', 'info',
+; 'error' or 'debug' on a per-module basis. See src/*/*.erl for various
+; modules.
+;couch_httpd = error
+
+
+[os_daemons]
+; For any commands listed here, CouchDB will attempt to ensure that
+; the process remains alive. Daemons should monitor their environment
+; to know when to exit. This can most easily be accomplished by exiting
+; when stdin is closed.
+;foo = /path/to/command -with args
+
+[daemons]
+; enable SSL support by uncommenting the following line and supply the PEM's below.
+; the default ssl port CouchDB listens on is 6984
+; httpsd = {couch_httpd, start_link, [https]}
+
+[ssl]
+;cert_file = /full/path/to/server_cert.pem
+;key_file = /full/path/to/server_key.pem
+;password = somepassword
+; set to true to validate peer certificates
+verify_ssl_certificates = false
+; Path to file containing PEM encoded CA certificates (trusted
+; certificates used for verifying a peer certificate). May be omitted if
+; you do not want to verify the peer.
+;cacert_file = /full/path/to/cacertf
+; The verification fun (optional) if not specified, the default
+; verification fun will be used.
+;verify_fun = {Module, VerifyFun}
+; maximum peer certificate depth
+ssl_certificate_max_depth = 1
+
+; To enable Virtual Hosts in CouchDB, add a vhost = path directive. All requests to
+; the Virual Host will be redirected to the path. In the example below all requests
+; to http://example.com/ are redirected to /database.
+; If you run CouchDB on a specific port, include the port number in the vhost:
+; example.com:5984 = /database
+[vhosts]
+;example.com = /database/
+
+[update_notification]
+;unique notifier name=/full/path/to/exe -with "cmd line arg"
+
+; To create an admin account uncomment the '[admins]' section below and add a
+; line in the format 'username = password'. When you next start CouchDB, it
+; will change the password to a hash (so that your passwords don't linger
+; around in plain-text files). You can add more admin accounts with more
+; 'username = password' lines. Don't forget to restart CouchDB after
+; changing this.
+[admins]
+;admin = mysecretpassword
+admin = password
diff --git a/docker/redis/Dockerfile b/docker/redis/Dockerfile
new file mode 100644
index 00000000..b7abe64e
--- /dev/null
+++ b/docker/redis/Dockerfile
@@ -0,0 +1,6 @@
+FROM redis
+
+# Scripts use a password
+COPY redis.conf /usr/local/etc/redis/
+RUN mkdir -p /usr/local/var/db/redis
+CMD [ "redis-server", "/usr/local/etc/redis/redis.conf" ]
diff --git a/docker/redis/redis.conf b/docker/redis/redis.conf
new file mode 100644
index 00000000..6d68b90d
--- /dev/null
+++ b/docker/redis/redis.conf
@@ -0,0 +1,1293 @@
+# Redis configuration file example.
+#
+# Note that in order to read the configuration file, Redis must be
+# started with the file path as first argument:
+#
+# ./redis-server /path/to/redis.conf
+
+# Note on units: when memory size is needed, it is possible to specify
+# it in the usual form of 1k 5GB 4M and so forth:
+#
+# 1k => 1000 bytes
+# 1kb => 1024 bytes
+# 1m => 1000000 bytes
+# 1mb => 1024*1024 bytes
+# 1g => 1000000000 bytes
+# 1gb => 1024*1024*1024 bytes
+#
+# units are case insensitive so 1GB 1Gb 1gB are all the same.
+
+################################## INCLUDES ###################################
+
+# Include one or more other config files here. This is useful if you
+# have a standard template that goes to all Redis servers but also need
+# to customize a few per-server settings. Include files can include
+# other files, so use this wisely.
+#
+# Notice option "include" won't be rewritten by command "CONFIG REWRITE"
+# from admin or Redis Sentinel. Since Redis always uses the last processed
+# line as value of a configuration directive, you'd better put includes
+# at the beginning of this file to avoid overwriting config change at runtime.
+#
+# If instead you are interested in using includes to override configuration
+# options, it is better to use include as the last line.
+#
+# include /path/to/local.conf
+# include /path/to/other.conf
+
+################################## MODULES #####################################
+
+# Load modules at startup. If the server is not able to load modules
+# it will abort. It is possible to use multiple loadmodule directives.
+#
+# loadmodule /path/to/my_module.so
+# loadmodule /path/to/other_module.so
+
+################################## NETWORK #####################################
+
+# By default, if no "bind" configuration directive is specified, Redis listens
+# for connections from all the network interfaces available on the server.
+# It is possible to listen to just one or multiple selected interfaces using
+# the "bind" configuration directive, followed by one or more IP addresses.
+#
+# Examples:
+#
+# bind 192.168.1.100 10.0.0.1
+# bind 127.0.0.1 ::1
+#
+# ~~~ WARNING ~~~ If the computer running Redis is directly exposed to the
+# internet, binding to all the interfaces is dangerous and will expose the
+# instance to everybody on the internet. So by default we uncomment the
+# following bind directive, that will force Redis to listen only into
+# the IPv4 lookback interface address (this means Redis will be able to
+# accept connections only from clients running into the same computer it
+# is running).
+#
+# IF YOU ARE SURE YOU WANT YOUR INSTANCE TO LISTEN TO ALL THE INTERFACES
+# JUST COMMENT THE FOLLOWING LINE.
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+#bind 127.0.0.1
+
+# Protected mode is a layer of security protection, in order to avoid that
+# Redis instances left open on the internet are accessed and exploited.
+#
+# When protected mode is on and if:
+#
+# 1) The server is not binding explicitly to a set of addresses using the
+# "bind" directive.
+# 2) No password is configured.
+#
+# The server only accepts connections from clients connecting from the
+# IPv4 and IPv6 loopback addresses 127.0.0.1 and ::1, and from Unix domain
+# sockets.
+#
+# By default protected mode is enabled. You should disable it only if
+# you are sure you want clients from other hosts to connect to Redis
+# even if no authentication is configured, nor a specific set of interfaces
+# are explicitly listed using the "bind" directive.
+protected-mode yes
+
+# Accept connections on the specified port, default is 6379 (IANA #815344).
+# If port 0 is specified Redis will not listen on a TCP socket.
+port 6379
+
+# TCP listen() backlog.
+#
+# In high requests-per-second environments you need an high backlog in order
+# to avoid slow clients connections issues. Note that the Linux kernel
+# will silently truncate it to the value of /proc/sys/net/core/somaxconn so
+# make sure to raise both the value of somaxconn and tcp_max_syn_backlog
+# in order to get the desired effect.
+tcp-backlog 511
+
+# Unix socket.
+#
+# Specify the path for the Unix socket that will be used to listen for
+# incoming connections. There is no default, so Redis will not listen
+# on a unix socket when not specified.
+#
+# unixsocket /tmp/redis.sock
+# unixsocketperm 700
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 0
+
+# TCP keepalive.
+#
+# If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence
+# of communication. This is useful for two reasons:
+#
+# 1) Detect dead peers.
+# 2) Take the connection alive from the point of view of network
+# equipment in the middle.
+#
+# On Linux, the specified value (in seconds) is the period used to send ACKs.
+# Note that to close the connection the double of the time is needed.
+# On other kernels the period depends on the kernel configuration.
+#
+# A reasonable value for this option is 300 seconds, which is the new
+# Redis default starting with Redis 3.2.1.
+tcp-keepalive 300
+
+################################# GENERAL #####################################
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
+daemonize no
+
+# If you run Redis from upstart or systemd, Redis can interact with your
+# supervision tree. Options:
+# supervised no - no supervision interaction
+# supervised upstart - signal upstart by putting Redis into SIGSTOP mode
+# supervised systemd - signal systemd by writing READY=1 to $NOTIFY_SOCKET
+# supervised auto - detect upstart or systemd method based on
+# UPSTART_JOB or NOTIFY_SOCKET environment variables
+# Note: these supervision methods only signal "process is ready."
+# They do not enable continuous liveness pings back to your supervisor.
+supervised no
+
+# If a pid file is specified, Redis writes it where specified at startup
+# and removes it at exit.
+#
+# When the server runs non daemonized, no pid file is created if none is
+# specified in the configuration. When the server is daemonized, the pid file
+# is used even if not specified, defaulting to "/var/run/redis.pid".
+#
+# Creating a pid file is best effort: if Redis is not able to create it
+# nothing bad happens, the server will start and run normally.
+pidfile /var/run/redis_6379.pid
+
+# Specify the server verbosity level.
+# This can be one of:
+# debug (a lot of information, useful for development/testing)
+# verbose (many rarely useful info, but not a mess like the debug level)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel notice
+
+# Specify the log file name. Also the empty string can be used to force
+# Redis to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile ""
+
+# To enable logging to the system logger, just set 'syslog-enabled' to yes,
+# and optionally update the other syslog parameters to suit your needs.
+# syslog-enabled no
+
+# Specify the syslog identity.
+# syslog-ident redis
+
+# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
+# syslog-facility local0
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+# By default Redis shows an ASCII art logo only when started to log to the
+# standard output and if the standard output is a TTY. Basically this means
+# that normally a logo is displayed only in interactive sessions.
+#
+# However it is possible to force the pre-4.0 behavior and always show a
+# ASCII art logo in startup logs by setting the following option to yes.
+always-show-logo yes
+
+################################ SNAPSHOTTING ################################
+#
+# Save the DB on disk:
+#
+# save
+#
+# Will save the DB if both the given number of seconds and the given
+# number of write operations against the DB occurred.
+#
+# In the example below the behaviour will be to save:
+# after 900 sec (15 min) if at least 1 key changed
+# after 300 sec (5 min) if at least 10 keys changed
+# after 60 sec if at least 10000 keys changed
+#
+# Note: you can disable saving completely by commenting out all "save" lines.
+#
+# It is also possible to remove all the previously configured save
+# points by adding a save directive with a single empty string argument
+# like in the following example:
+#
+# save ""
+
+save 900 1
+save 300 10
+save 60 10000
+
+# By default Redis will stop accepting writes if RDB snapshots are enabled
+# (at least one save point) and the latest background save failed.
+# This will make the user aware (in a hard way) that data is not persisting
+# on disk properly, otherwise chances are that no one will notice and some
+# disaster will happen.
+#
+# If the background saving process will start working again Redis will
+# automatically allow writes again.
+#
+# However if you have setup your proper monitoring of the Redis server
+# and persistence, you may want to disable this feature so that Redis will
+# continue to work as usual even if there are problems with disk,
+# permissions, and so forth.
+stop-writes-on-bgsave-error yes
+
+# Compress string objects using LZF when dump .rdb databases?
+# For default that's set to 'yes' as it's almost always a win.
+# If you want to save some CPU in the saving child set it to 'no' but
+# the dataset will likely be bigger if you have compressible values or keys.
+rdbcompression yes
+
+# Since version 5 of RDB a CRC64 checksum is placed at the end of the file.
+# This makes the format more resistant to corruption but there is a performance
+# hit to pay (around 10%) when saving and loading RDB files, so you can disable it
+# for maximum performances.
+#
+# RDB files created with checksum disabled have a checksum of zero that will
+# tell the loading code to skip the check.
+rdbchecksum yes
+
+# The filename where to dump the DB
+dbfilename dump.rdb
+
+# The working directory.
+#
+# The DB will be written inside this directory, with the filename specified
+# above using the 'dbfilename' configuration directive.
+#
+# The Append Only File will also be created inside this directory.
+#
+# Note that you must specify a directory here, not a file name.
+dir ./
+
+################################# REPLICATION #################################
+
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. A few things to understand ASAP about Redis replication.
+#
+# 1) Redis replication is asynchronous, but you can configure a master to
+# stop accepting writes if it appears to be not connected with at least
+# a given number of slaves.
+# 2) Redis slaves are able to perform a partial resynchronization with the
+# master if the replication link is lost for a relatively small amount of
+# time. You may want to configure the replication backlog size (see the next
+# sections of this file) with a sensible value depending on your needs.
+# 3) Replication is automatic and does not need user intervention. After a
+# network partition slaves automatically try to reconnect to masters
+# and resynchronize with them.
+#
+# slaveof
+
+# If the master is password protected (using the "requirepass" configuration
+# directive below) it is possible to tell the slave to authenticate before
+# starting the replication synchronization process, otherwise the master will
+# refuse the slave request.
+#
+# masterauth
+
+# When a slave loses its connection with the master, or when the replication
+# is still in progress, the slave can act in two different ways:
+#
+# 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
+# still reply to client requests, possibly with out of date data, or the
+# data set may just be empty if this is the first synchronization.
+#
+# 2) if slave-serve-stale-data is set to 'no' the slave will reply with
+# an error "SYNC with master in progress" to all the kind of commands
+# but to INFO and SLAVEOF.
+#
+slave-serve-stale-data yes
+
+# You can configure a slave instance to accept writes or not. Writing against
+# a slave instance may be useful to store some ephemeral data (because data
+# written on a slave will be easily deleted after resync with the master) but
+# may also cause problems if clients are writing to it because of a
+# misconfiguration.
+#
+# Since Redis 2.6 by default slaves are read-only.
+#
+# Note: read only slaves are not designed to be exposed to untrusted clients
+# on the internet. It's just a protection layer against misuse of the instance.
+# Still a read only slave exports by default all the administrative commands
+# such as CONFIG, DEBUG, and so forth. To a limited extent you can improve
+# security of read only slaves using 'rename-command' to shadow all the
+# administrative / dangerous commands.
+slave-read-only yes
+
+# Replication SYNC strategy: disk or socket.
+#
+# -------------------------------------------------------
+# WARNING: DISKLESS REPLICATION IS EXPERIMENTAL CURRENTLY
+# -------------------------------------------------------
+#
+# New slaves and reconnecting slaves that are not able to continue the replication
+# process just receiving differences, need to do what is called a "full
+# synchronization". An RDB file is transmitted from the master to the slaves.
+# The transmission can happen in two different ways:
+#
+# 1) Disk-backed: The Redis master creates a new process that writes the RDB
+# file on disk. Later the file is transferred by the parent
+# process to the slaves incrementally.
+# 2) Diskless: The Redis master creates a new process that directly writes the
+# RDB file to slave sockets, without touching the disk at all.
+#
+# With disk-backed replication, while the RDB file is generated, more slaves
+# can be queued and served with the RDB file as soon as the current child producing
+# the RDB file finishes its work. With diskless replication instead once
+# the transfer starts, new slaves arriving will be queued and a new transfer
+# will start when the current one terminates.
+#
+# When diskless replication is used, the master waits a configurable amount of
+# time (in seconds) before starting the transfer in the hope that multiple slaves
+# will arrive and the transfer can be parallelized.
+#
+# With slow disks and fast (large bandwidth) networks, diskless replication
+# works better.
+repl-diskless-sync no
+
+# When diskless replication is enabled, it is possible to configure the delay
+# the server waits in order to spawn the child that transfers the RDB via socket
+# to the slaves.
+#
+# This is important since once the transfer starts, it is not possible to serve
+# new slaves arriving, that will be queued for the next RDB transfer, so the server
+# waits a delay in order to let more slaves arrive.
+#
+# The delay is specified in seconds, and by default is 5 seconds. To disable
+# it entirely just set it to 0 seconds and the transfer will start ASAP.
+repl-diskless-sync-delay 5
+
+# Slaves send PINGs to server in a predefined interval. It's possible to change
+# this interval with the repl_ping_slave_period option. The default value is 10
+# seconds.
+#
+# repl-ping-slave-period 10
+
+# The following option sets the replication timeout for:
+#
+# 1) Bulk transfer I/O during SYNC, from the point of view of slave.
+# 2) Master timeout from the point of view of slaves (data, pings).
+# 3) Slave timeout from the point of view of masters (REPLCONF ACK pings).
+#
+# It is important to make sure that this value is greater than the value
+# specified for repl-ping-slave-period otherwise a timeout will be detected
+# every time there is low traffic between the master and the slave.
+#
+# repl-timeout 60
+
+# Disable TCP_NODELAY on the slave socket after SYNC?
+#
+# If you select "yes" Redis will use a smaller number of TCP packets and
+# less bandwidth to send data to slaves. But this can add a delay for
+# the data to appear on the slave side, up to 40 milliseconds with
+# Linux kernels using a default configuration.
+#
+# If you select "no" the delay for data to appear on the slave side will
+# be reduced but more bandwidth will be used for replication.
+#
+# By default we optimize for low latency, but in very high traffic conditions
+# or when the master and slaves are many hops away, turning this to "yes" may
+# be a good idea.
+repl-disable-tcp-nodelay no
+
+# Set the replication backlog size. The backlog is a buffer that accumulates
+# slave data when slaves are disconnected for some time, so that when a slave
+# wants to reconnect again, often a full resync is not needed, but a partial
+# resync is enough, just passing the portion of data the slave missed while
+# disconnected.
+#
+# The bigger the replication backlog, the longer the time the slave can be
+# disconnected and later be able to perform a partial resynchronization.
+#
+# The backlog is only allocated once there is at least a slave connected.
+#
+# repl-backlog-size 1mb
+
+# After a master has no longer connected slaves for some time, the backlog
+# will be freed. The following option configures the amount of seconds that
+# need to elapse, starting from the time the last slave disconnected, for
+# the backlog buffer to be freed.
+#
+# Note that slaves never free the backlog for timeout, since they may be
+# promoted to masters later, and should be able to correctly "partially
+# resynchronize" with the slaves: hence they should always accumulate backlog.
+#
+# A value of 0 means to never release the backlog.
+#
+# repl-backlog-ttl 3600
+
+# The slave priority is an integer number published by Redis in the INFO output.
+# It is used by Redis Sentinel in order to select a slave to promote into a
+# master if the master is no longer working correctly.
+#
+# A slave with a low priority number is considered better for promotion, so
+# for instance if there are three slaves with priority 10, 100, 25 Sentinel will
+# pick the one with priority 10, that is the lowest.
+#
+# However a special priority of 0 marks the slave as not able to perform the
+# role of master, so a slave with priority of 0 will never be selected by
+# Redis Sentinel for promotion.
+#
+# By default the priority is 100.
+slave-priority 100
+
+# It is possible for a master to stop accepting writes if there are less than
+# N slaves connected, having a lag less or equal than M seconds.
+#
+# The N slaves need to be in "online" state.
+#
+# The lag in seconds, that must be <= the specified value, is calculated from
+# the last ping received from the slave, that is usually sent every second.
+#
+# This option does not GUARANTEE that N replicas will accept the write, but
+# will limit the window of exposure for lost writes in case not enough slaves
+# are available, to the specified number of seconds.
+#
+# For example to require at least 3 slaves with a lag <= 10 seconds use:
+#
+# min-slaves-to-write 3
+# min-slaves-max-lag 10
+#
+# Setting one or the other to 0 disables the feature.
+#
+# By default min-slaves-to-write is set to 0 (feature disabled) and
+# min-slaves-max-lag is set to 10.
+
+# A Redis master is able to list the address and port of the attached
+# slaves in different ways. For example the "INFO replication" section
+# offers this information, which is used, among other tools, by
+# Redis Sentinel in order to discover slave instances.
+# Another place where this info is available is in the output of the
+# "ROLE" command of a master.
+#
+# The listed IP and address normally reported by a slave is obtained
+# in the following way:
+#
+# IP: The address is auto detected by checking the peer address
+# of the socket used by the slave to connect with the master.
+#
+# Port: The port is communicated by the slave during the replication
+# handshake, and is normally the port that the slave is using to
+# list for connections.
+#
+# However when port forwarding or Network Address Translation (NAT) is
+# used, the slave may be actually reachable via different IP and port
+# pairs. The following two options can be used by a slave in order to
+# report to its master a specific set of IP and port, so that both INFO
+# and ROLE will report those values.
+#
+# There is no need to use both the options if you need to override just
+# the port or the IP address.
+#
+# slave-announce-ip 5.5.5.5
+# slave-announce-port 1234
+
+################################## SECURITY ###################################
+
+# Require clients to issue AUTH before processing any other
+# commands. This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+#
+# Warning: since Redis is pretty fast an outside user can try up to
+# 150k passwords per second against a good box. This means that you should
+# use a very strong password otherwise it will be very easy to break.
+#
+requirepass password
+
+# Command renaming.
+#
+# It is possible to change the name of dangerous commands in a shared
+# environment. For instance the CONFIG command may be renamed into something
+# hard to guess so that it will still be available for internal-use tools
+# but not available for general clients.
+#
+# Example:
+#
+# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
+#
+# It is also possible to completely kill a command by renaming it into
+# an empty string:
+#
+# rename-command CONFIG ""
+#
+# Please note that changing the name of commands that are logged into the
+# AOF file or transmitted to slaves may cause problems.
+
+################################### CLIENTS ####################################
+
+# Set the max number of connected clients at the same time. By default
+# this limit is set to 10000 clients, however if the Redis server is not
+# able to configure the process file limit to allow for the specified limit
+# the max number of allowed clients is set to the current file limit
+# minus 32 (as Redis reserves a few file descriptors for internal uses).
+#
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+#
+# maxclients 10000
+
+############################## MEMORY MANAGEMENT ################################
+
+# Set a memory usage limit to the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys
+# according to the eviction policy selected (see maxmemory-policy).
+#
+# If Redis can't remove keys according to the policy, or if the policy is
+# set to 'noeviction', Redis will start to reply with errors to commands
+# that would use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to read-only commands like GET.
+#
+# This option is usually useful when using Redis as an LRU or LFU cache, or to
+# set a hard memory limit for an instance (using the 'noeviction' policy).
+#
+# WARNING: If you have slaves attached to an instance with maxmemory on,
+# the size of the output buffers needed to feed the slaves are subtracted
+# from the used memory count, so that network problems / resyncs will
+# not trigger a loop where keys are evicted, and in turn the output
+# buffer of slaves is full with DELs of keys evicted triggering the deletion
+# of more keys, and so forth until the database is completely emptied.
+#
+# In short... if you have slaves attached it is suggested that you set a lower
+# limit for maxmemory so that there is some free RAM on the system for slave
+# output buffers (but this is not needed if the policy is 'noeviction').
+#
+# maxmemory
+
+# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
+# is reached. You can select among five behaviors:
+#
+# volatile-lru -> Evict using approximated LRU among the keys with an expire set.
+# allkeys-lru -> Evict any key using approximated LRU.
+# volatile-lfu -> Evict using approximated LFU among the keys with an expire set.
+# allkeys-lfu -> Evict any key using approximated LFU.
+# volatile-random -> Remove a random key among the ones with an expire set.
+# allkeys-random -> Remove a random key, any key.
+# volatile-ttl -> Remove the key with the nearest expire time (minor TTL)
+# noeviction -> Don't evict anything, just return an error on write operations.
+#
+# LRU means Least Recently Used
+# LFU means Least Frequently Used
+#
+# Both LRU, LFU and volatile-ttl are implemented using approximated
+# randomized algorithms.
+#
+# Note: with any of the above policies, Redis will return an error on write
+# operations, when there are no suitable keys for eviction.
+#
+# At the date of writing these commands are: set setnx setex append
+# incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
+# sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
+# zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
+# getset mset msetnx exec sort
+#
+# The default is:
+#
+# maxmemory-policy noeviction
+
+# LRU, LFU and minimal TTL algorithms are not precise algorithms but approximated
+# algorithms (in order to save memory), so you can tune it for speed or
+# accuracy. For default Redis will check five keys and pick the one that was
+# used less recently, you can change the sample size using the following
+# configuration directive.
+#
+# The default of 5 produces good enough results. 10 Approximates very closely
+# true LRU but costs more CPU. 3 is faster but not very accurate.
+#
+# maxmemory-samples 5
+
+############################# LAZY FREEING ####################################
+
+# Redis has two primitives to delete keys. One is called DEL and is a blocking
+# deletion of the object. It means that the server stops processing new commands
+# in order to reclaim all the memory associated with an object in a synchronous
+# way. If the key deleted is associated with a small object, the time needed
+# in order to execute the DEL command is very small and comparable to most other
+# O(1) or O(log_N) commands in Redis. However if the key is associated with an
+# aggregated value containing millions of elements, the server can block for
+# a long time (even seconds) in order to complete the operation.
+#
+# For the above reasons Redis also offers non blocking deletion primitives
+# such as UNLINK (non blocking DEL) and the ASYNC option of FLUSHALL and
+# FLUSHDB commands, in order to reclaim memory in background. Those commands
+# are executed in constant time. Another thread will incrementally free the
+# object in the background as fast as possible.
+#
+# DEL, UNLINK and ASYNC option of FLUSHALL and FLUSHDB are user-controlled.
+# It's up to the design of the application to understand when it is a good
+# idea to use one or the other. However the Redis server sometimes has to
+# delete keys or flush the whole database as a side effect of other operations.
+# Specifically Redis deletes objects independently of a user call in the
+# following scenarios:
+#
+# 1) On eviction, because of the maxmemory and maxmemory policy configurations,
+# in order to make room for new data, without going over the specified
+# memory limit.
+# 2) Because of expire: when a key with an associated time to live (see the
+# EXPIRE command) must be deleted from memory.
+# 3) Because of a side effect of a command that stores data on a key that may
+# already exist. For example the RENAME command may delete the old key
+# content when it is replaced with another one. Similarly SUNIONSTORE
+# or SORT with STORE option may delete existing keys. The SET command
+# itself removes any old content of the specified key in order to replace
+# it with the specified string.
+# 4) During replication, when a slave performs a full resynchronization with
+# its master, the content of the whole database is removed in order to
+# load the RDB file just transfered.
+#
+# In all the above cases the default is to delete objects in a blocking way,
+# like if DEL was called. However you can configure each case specifically
+# in order to instead release memory in a non-blocking way like if UNLINK
+# was called, using the following configuration directives:
+
+lazyfree-lazy-eviction no
+lazyfree-lazy-expire no
+lazyfree-lazy-server-del no
+slave-lazy-flush no
+
+############################## APPEND ONLY MODE ###############################
+
+# By default Redis asynchronously dumps the dataset on disk. This mode is
+# good enough in many applications, but an issue with the Redis process or
+# a power outage may result into a few minutes of writes lost (depending on
+# the configured save points).
+#
+# The Append Only File is an alternative persistence mode that provides
+# much better durability. For instance using the default data fsync policy
+# (see later in the config file) Redis can lose just one second of writes in a
+# dramatic event like a server power outage, or a single write if something
+# wrong with the Redis process itself happens, but the operating system is
+# still running correctly.
+#
+# AOF and RDB persistence can be enabled at the same time without problems.
+# If the AOF is enabled on startup Redis will load the AOF, that is the file
+# with the better durability guarantees.
+#
+# Please check http://redis.io/topics/persistence for more information.
+
+appendonly no
+
+# The name of the append only file (default: "appendonly.aof")
+
+appendfilename "appendonly.aof"
+
+# The fsync() call tells the Operating System to actually write data on disk
+# instead of waiting for more data in the output buffer. Some OS will really flush
+# data on disk, some other OS will just try to do it ASAP.
+#
+# Redis supports three different modes:
+#
+# no: don't fsync, just let the OS flush the data when it wants. Faster.
+# always: fsync after every write to the append only log. Slow, Safest.
+# everysec: fsync only one time every second. Compromise.
+#
+# The default is "everysec", as that's usually the right compromise between
+# speed and data safety. It's up to you to understand if you can relax this to
+# "no" that will let the operating system flush the output buffer when
+# it wants, for better performances (but if you can live with the idea of
+# some data loss consider the default persistence mode that's snapshotting),
+# or on the contrary, use "always" that's very slow but a bit safer than
+# everysec.
+#
+# More details please check the following article:
+# http://antirez.com/post/redis-persistence-demystified.html
+#
+# If unsure, use "everysec".
+
+# appendfsync always
+appendfsync everysec
+# appendfsync no
+
+# When the AOF fsync policy is set to always or everysec, and a background
+# saving process (a background save or AOF log background rewriting) is
+# performing a lot of I/O against the disk, in some Linux configurations
+# Redis may block too long on the fsync() call. Note that there is no fix for
+# this currently, as even performing fsync in a different thread will block
+# our synchronous write(2) call.
+#
+# In order to mitigate this problem it's possible to use the following option
+# that will prevent fsync() from being called in the main process while a
+# BGSAVE or BGREWRITEAOF is in progress.
+#
+# This means that while another child is saving, the durability of Redis is
+# the same as "appendfsync none". In practical terms, this means that it is
+# possible to lose up to 30 seconds of log in the worst scenario (with the
+# default Linux settings).
+#
+# If you have latency problems turn this to "yes". Otherwise leave it as
+# "no" that is the safest pick from the point of view of durability.
+
+no-appendfsync-on-rewrite no
+
+# Automatic rewrite of the append only file.
+# Redis is able to automatically rewrite the log file implicitly calling
+# BGREWRITEAOF when the AOF log size grows by the specified percentage.
+#
+# This is how it works: Redis remembers the size of the AOF file after the
+# latest rewrite (if no rewrite has happened since the restart, the size of
+# the AOF at startup is used).
+#
+# This base size is compared to the current size. If the current size is
+# bigger than the specified percentage, the rewrite is triggered. Also
+# you need to specify a minimal size for the AOF file to be rewritten, this
+# is useful to avoid rewriting the AOF file even if the percentage increase
+# is reached but it is still pretty small.
+#
+# Specify a percentage of zero in order to disable the automatic AOF
+# rewrite feature.
+
+auto-aof-rewrite-percentage 100
+auto-aof-rewrite-min-size 64mb
+
+# An AOF file may be found to be truncated at the end during the Redis
+# startup process, when the AOF data gets loaded back into memory.
+# This may happen when the system where Redis is running
+# crashes, especially when an ext4 filesystem is mounted without the
+# data=ordered option (however this can't happen when Redis itself
+# crashes or aborts but the operating system still works correctly).
+#
+# Redis can either exit with an error when this happens, or load as much
+# data as possible (the default now) and start if the AOF file is found
+# to be truncated at the end. The following option controls this behavior.
+#
+# If aof-load-truncated is set to yes, a truncated AOF file is loaded and
+# the Redis server starts emitting a log to inform the user of the event.
+# Otherwise if the option is set to no, the server aborts with an error
+# and refuses to start. When the option is set to no, the user requires
+# to fix the AOF file using the "redis-check-aof" utility before to restart
+# the server.
+#
+# Note that if the AOF file will be found to be corrupted in the middle
+# the server will still exit with an error. This option only applies when
+# Redis will try to read more data from the AOF file but not enough bytes
+# will be found.
+aof-load-truncated yes
+
+# When rewriting the AOF file, Redis is able to use an RDB preamble in the
+# AOF file for faster rewrites and recoveries. When this option is turned
+# on the rewritten AOF file is composed of two different stanzas:
+#
+# [RDB file][AOF tail]
+#
+# When loading Redis recognizes that the AOF file starts with the "REDIS"
+# string and loads the prefixed RDB file, and continues loading the AOF
+# tail.
+#
+# This is currently turned off by default in order to avoid the surprise
+# of a format change, but will at some point be used as the default.
+aof-use-rdb-preamble no
+
+################################ LUA SCRIPTING ###############################
+
+# Max execution time of a Lua script in milliseconds.
+#
+# If the maximum execution time is reached Redis will log that a script is
+# still in execution after the maximum allowed time and will start to
+# reply to queries with an error.
+#
+# When a long running script exceeds the maximum execution time only the
+# SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be
+# used to stop a script that did not yet called write commands. The second
+# is the only way to shut down the server in the case a write command was
+# already issued by the script but the user doesn't want to wait for the natural
+# termination of the script.
+#
+# Set it to 0 or a negative value for unlimited execution without warnings.
+lua-time-limit 5000
+
+################################ REDIS CLUSTER ###############################
+#
+# ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# WARNING EXPERIMENTAL: Redis Cluster is considered to be stable code, however
+# in order to mark it as "mature" we need to wait for a non trivial percentage
+# of users to deploy it in production.
+# ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+#
+# Normal Redis instances can't be part of a Redis Cluster; only nodes that are
+# started as cluster nodes can. In order to start a Redis instance as a
+# cluster node enable the cluster support uncommenting the following:
+#
+# cluster-enabled yes
+
+# Every cluster node has a cluster configuration file. This file is not
+# intended to be edited by hand. It is created and updated by Redis nodes.
+# Every Redis Cluster node requires a different cluster configuration file.
+# Make sure that instances running in the same system do not have
+# overlapping cluster configuration file names.
+#
+# cluster-config-file nodes-6379.conf
+
+# Cluster node timeout is the amount of milliseconds a node must be unreachable
+# for it to be considered in failure state.
+# Most other internal time limits are multiple of the node timeout.
+#
+# cluster-node-timeout 15000
+
+# A slave of a failing master will avoid to start a failover if its data
+# looks too old.
+#
+# There is no simple way for a slave to actually have an exact measure of
+# its "data age", so the following two checks are performed:
+#
+# 1) If there are multiple slaves able to failover, they exchange messages
+# in order to try to give an advantage to the slave with the best
+# replication offset (more data from the master processed).
+# Slaves will try to get their rank by offset, and apply to the start
+# of the failover a delay proportional to their rank.
+#
+# 2) Every single slave computes the time of the last interaction with
+# its master. This can be the last ping or command received (if the master
+# is still in the "connected" state), or the time that elapsed since the
+# disconnection with the master (if the replication link is currently down).
+# If the last interaction is too old, the slave will not try to failover
+# at all.
+#
+# The point "2" can be tuned by user. Specifically a slave will not perform
+# the failover if, since the last interaction with the master, the time
+# elapsed is greater than:
+#
+# (node-timeout * slave-validity-factor) + repl-ping-slave-period
+#
+# So for example if node-timeout is 30 seconds, and the slave-validity-factor
+# is 10, and assuming a default repl-ping-slave-period of 10 seconds, the
+# slave will not try to failover if it was not able to talk with the master
+# for longer than 310 seconds.
+#
+# A large slave-validity-factor may allow slaves with too old data to failover
+# a master, while a too small value may prevent the cluster from being able to
+# elect a slave at all.
+#
+# For maximum availability, it is possible to set the slave-validity-factor
+# to a value of 0, which means, that slaves will always try to failover the
+# master regardless of the last time they interacted with the master.
+# (However they'll always try to apply a delay proportional to their
+# offset rank).
+#
+# Zero is the only value able to guarantee that when all the partitions heal
+# the cluster will always be able to continue.
+#
+# cluster-slave-validity-factor 10
+
+# Cluster slaves are able to migrate to orphaned masters, that are masters
+# that are left without working slaves. This improves the cluster ability
+# to resist to failures as otherwise an orphaned master can't be failed over
+# in case of failure if it has no working slaves.
+#
+# Slaves migrate to orphaned masters only if there are still at least a
+# given number of other working slaves for their old master. This number
+# is the "migration barrier". A migration barrier of 1 means that a slave
+# will migrate only if there is at least 1 other working slave for its master
+# and so forth. It usually reflects the number of slaves you want for every
+# master in your cluster.
+#
+# Default is 1 (slaves migrate only if their masters remain with at least
+# one slave). To disable migration just set it to a very large value.
+# A value of 0 can be set but is useful only for debugging and dangerous
+# in production.
+#
+# cluster-migration-barrier 1
+
+# By default Redis Cluster nodes stop accepting queries if they detect there
+# is at least an hash slot uncovered (no available node is serving it).
+# This way if the cluster is partially down (for example a range of hash slots
+# are no longer covered) all the cluster becomes, eventually, unavailable.
+# It automatically returns available as soon as all the slots are covered again.
+#
+# However sometimes you want the subset of the cluster which is working,
+# to continue to accept queries for the part of the key space that is still
+# covered. In order to do so, just set the cluster-require-full-coverage
+# option to no.
+#
+# cluster-require-full-coverage yes
+
+# In order to setup your cluster make sure to read the documentation
+# available at http://redis.io web site.
+
+########################## CLUSTER DOCKER/NAT support ########################
+
+# In certain deployments, Redis Cluster nodes address discovery fails, because
+# addresses are NAT-ted or because ports are forwarded (the typical case is
+# Docker and other containers).
+#
+# In order to make Redis Cluster working in such environments, a static
+# configuration where each node knows its public address is needed. The
+# following two options are used for this scope, and are:
+#
+# * cluster-announce-ip
+# * cluster-announce-port
+# * cluster-announce-bus-port
+#
+# Each instruct the node about its address, client port, and cluster message
+# bus port. The information is then published in the header of the bus packets
+# so that other nodes will be able to correctly map the address of the node
+# publishing the information.
+#
+# If the above options are not used, the normal Redis Cluster auto-detection
+# will be used instead.
+#
+# Note that when remapped, the bus port may not be at the fixed offset of
+# clients port + 10000, so you can specify any port and bus-port depending
+# on how they get remapped. If the bus-port is not set, a fixed offset of
+# 10000 will be used as usually.
+#
+# Example:
+#
+# cluster-announce-ip 10.1.1.5
+# cluster-announce-port 6379
+# cluster-announce-bus-port 6380
+
+################################## SLOW LOG ###################################
+
+# The Redis Slow Log is a system to log queries that exceeded a specified
+# execution time. The execution time does not include the I/O operations
+# like talking with the client, sending the reply and so forth,
+# but just the time needed to actually execute the command (this is the only
+# stage of command execution where the thread is blocked and can not serve
+# other requests in the meantime).
+#
+# You can configure the slow log with two parameters: one tells Redis
+# what is the execution time, in microseconds, to exceed in order for the
+# command to get logged, and the other parameter is the length of the
+# slow log. When a new command is logged the oldest one is removed from the
+# queue of logged commands.
+
+# The following time is expressed in microseconds, so 1000000 is equivalent
+# to one second. Note that a negative number disables the slow log, while
+# a value of zero forces the logging of every command.
+slowlog-log-slower-than 10000
+
+# There is no limit to this length. Just be aware that it will consume memory.
+# You can reclaim memory used by the slow log with SLOWLOG RESET.
+slowlog-max-len 128
+
+################################ LATENCY MONITOR ##############################
+
+# The Redis latency monitoring subsystem samples different operations
+# at runtime in order to collect data related to possible sources of
+# latency of a Redis instance.
+#
+# Via the LATENCY command this information is available to the user that can
+# print graphs and obtain reports.
+#
+# The system only logs operations that were performed in a time equal or
+# greater than the amount of milliseconds specified via the
+# latency-monitor-threshold configuration directive. When its value is set
+# to zero, the latency monitor is turned off.
+#
+# By default latency monitoring is disabled since it is mostly not needed
+# if you don't have latency issues, and collecting data has a performance
+# impact, that while very small, can be measured under big load. Latency
+# monitoring can easily be enabled at runtime using the command
+# "CONFIG SET latency-monitor-threshold " if needed.
+latency-monitor-threshold 0
+
+############################# EVENT NOTIFICATION ##############################
+
+# Redis can notify Pub/Sub clients about events happening in the key space.
+# This feature is documented at http://redis.io/topics/notifications
+#
+# For instance if keyspace events notification is enabled, and a client
+# performs a DEL operation on key "foo" stored in the Database 0, two
+# messages will be published via Pub/Sub:
+#
+# PUBLISH __keyspace@0__:foo del
+# PUBLISH __keyevent@0__:del foo
+#
+# It is possible to select the events that Redis will notify among a set
+# of classes. Every class is identified by a single character:
+#
+# K Keyspace events, published with __keyspace@__ prefix.
+# E Keyevent events, published with __keyevent@__ prefix.
+# g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ...
+# $ String commands
+# l List commands
+# s Set commands
+# h Hash commands
+# z Sorted set commands
+# x Expired events (events generated every time a key expires)
+# e Evicted events (events generated when a key is evicted for maxmemory)
+# A Alias for g$lshzxe, so that the "AKE" string means all the events.
+#
+# The "notify-keyspace-events" takes as argument a string that is composed
+# of zero or multiple characters. The empty string means that notifications
+# are disabled.
+#
+# Example: to enable list and generic events, from the point of view of the
+# event name, use:
+#
+# notify-keyspace-events Elg
+#
+# Example 2: to get the stream of the expired keys subscribing to channel
+# name __keyevent@0__:expired use:
+#
+# notify-keyspace-events Ex
+#
+# By default all notifications are disabled because most users don't need
+# this feature and the feature has some overhead. Note that if you don't
+# specify at least one of K or E, no events will be delivered.
+notify-keyspace-events ""
+
+############################### ADVANCED CONFIG ###############################
+
+# Hashes are encoded using a memory efficient data structure when they have a
+# small number of entries, and the biggest entry does not exceed a given
+# threshold. These thresholds can be configured using the following directives.
+hash-max-ziplist-entries 512
+hash-max-ziplist-value 64
+
+# Lists are also encoded in a special way to save a lot of space.
+# The number of entries allowed per internal list node can be specified
+# as a fixed maximum size or a maximum number of elements.
+# For a fixed maximum size, use -5 through -1, meaning:
+# -5: max size: 64 Kb <-- not recommended for normal workloads
+# -4: max size: 32 Kb <-- not recommended
+# -3: max size: 16 Kb <-- probably not recommended
+# -2: max size: 8 Kb <-- good
+# -1: max size: 4 Kb <-- good
+# Positive numbers mean store up to _exactly_ that number of elements
+# per list node.
+# The highest performing option is usually -2 (8 Kb size) or -1 (4 Kb size),
+# but if your use case is unique, adjust the settings as necessary.
+list-max-ziplist-size -2
+
+# Lists may also be compressed.
+# Compress depth is the number of quicklist ziplist nodes from *each* side of
+# the list to *exclude* from compression. The head and tail of the list
+# are always uncompressed for fast push/pop operations. Settings are:
+# 0: disable all list compression
+# 1: depth 1 means "don't start compressing until after 1 node into the list,
+# going from either the head or tail"
+# So: [head]->node->node->...->node->[tail]
+# [head], [tail] will always be uncompressed; inner nodes will compress.
+# 2: [head]->[next]->node->node->...->node->[prev]->[tail]
+# 2 here means: don't compress head or head->next or tail->prev or tail,
+# but compress all nodes between them.
+# 3: [head]->[next]->[next]->node->node->...->node->[prev]->[prev]->[tail]
+# etc.
+list-compress-depth 0
+
+# Sets have a special encoding in just one case: when a set is composed
+# of just strings that happen to be integers in radix 10 in the range
+# of 64 bit signed integers.
+# The following configuration setting sets the limit in the size of the
+# set in order to use this special memory saving encoding.
+set-max-intset-entries 512
+
+# Similarly to hashes and lists, sorted sets are also specially encoded in
+# order to save a lot of space. This encoding is only used when the length and
+# elements of a sorted set are below the following limits:
+zset-max-ziplist-entries 128
+zset-max-ziplist-value 64
+
+# HyperLogLog sparse representation bytes limit. The limit includes the
+# 16 bytes header. When an HyperLogLog using the sparse representation crosses
+# this limit, it is converted into the dense representation.
+#
+# A value greater than 16000 is totally useless, since at that point the
+# dense representation is more memory efficient.
+#
+# The suggested value is ~ 3000 in order to have the benefits of
+# the space efficient encoding without slowing down too much PFADD,
+# which is O(N) with the sparse encoding. The value can be raised to
+# ~ 10000 when CPU is not a concern, but space is, and the data set is
+# composed of many HyperLogLogs with cardinality in the 0 - 15000 range.
+hll-sparse-max-bytes 3000
+
+# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
+# order to help rehashing the main Redis hash table (the one mapping top-level
+# keys to values). The hash table implementation Redis uses (see dict.c)
+# performs a lazy rehashing: the more operation you run into a hash table
+# that is rehashing, the more rehashing "steps" are performed, so if the
+# server is idle the rehashing is never complete and some more memory is used
+# by the hash table.
+#
+# The default is to use this millisecond 10 times every second in order to
+# actively rehash the main dictionaries, freeing memory when possible.
+#
+# If unsure:
+# use "activerehashing no" if you have hard latency requirements and it is
+# not a good thing in your environment that Redis can reply from time to time
+# to queries with 2 milliseconds delay.
+#
+# use "activerehashing yes" if you don't have such hard requirements but
+# want to free memory asap when possible.
+activerehashing yes
+
+# The client output buffer limits can be used to force disconnection of clients
+# that are not reading data from the server fast enough for some reason (a
+# common reason is that a Pub/Sub client can't consume messages as fast as the
+# publisher can produce them).
+#
+# The limit can be set differently for the three different classes of clients:
+#
+# normal -> normal clients including MONITOR clients
+# slave -> slave clients
+# pubsub -> clients subscribed to at least one pubsub channel or pattern
+#
+# The syntax of every client-output-buffer-limit directive is the following:
+#
+# client-output-buffer-limit
+#
+# A client is immediately disconnected once the hard limit is reached, or if
+# the soft limit is reached and remains reached for the specified number of
+# seconds (continuously).
+# So for instance if the hard limit is 32 megabytes and the soft limit is
+# 16 megabytes / 10 seconds, the client will get disconnected immediately
+# if the size of the output buffers reach 32 megabytes, but will also get
+# disconnected if the client reaches 16 megabytes and continuously overcomes
+# the limit for 10 seconds.
+#
+# By default normal clients are not limited because they don't receive data
+# without asking (in a push way), but just after a request, so only
+# asynchronous clients may create a scenario where data is requested faster
+# than it can read.
+#
+# Instead there is a default limit for pubsub and slave clients, since
+# subscribers and slaves receive data in a push fashion.
+#
+# Both the hard or the soft limit can be disabled by setting them to zero.
+client-output-buffer-limit normal 0 0 0
+client-output-buffer-limit slave 256mb 64mb 60
+client-output-buffer-limit pubsub 32mb 8mb 60
+
+# Redis calls an internal function to perform many background tasks, like
+# closing connections of clients in timeout, purging expired keys that are
+# never requested, and so forth.
+#
+# Not all tasks are performed with the same frequency, but Redis checks for
+# tasks to perform according to the specified "hz" value.
+#
+# By default "hz" is set to 10. Raising the value will use more CPU when
+# Redis is idle, but at the same time will make Redis more responsive when
+# there are many keys expiring at the same time, and timeouts may be
+# handled with more precision.
+#
+# The range is between 1 and 500, however a value over 100 is usually not
+# a good idea. Most users should use the default of 10 and raise this up to
+# 100 only in environments where very low latency is required.
+hz 10
+
+# When a child rewrites the AOF file, if the following option is enabled
+# the file will be fsync-ed every 32 MB of data generated. This is useful
+# in order to commit the file to the disk more incrementally and avoid
+# big latency spikes.
+aof-rewrite-incremental-fsync yes
+
+# Redis LFU eviction (see maxmemory setting) can be tuned. However it is a good
+# idea to start with the default settings and only change them after investigating
+# how to improve the performances and how the keys LFU change over time, which
+# is possible to inspect via the OBJECT FREQ command.
+#
+# There are two tunable parameters in the Redis LFU implementation: the
+# counter logarithm factor and the counter decay time. It is important to
+# understand what the two parameters mean before changing them.
+#
+# The LFU counter is just 8 bits per key, it's maximum value is 255, so Redis
+# uses a probabilistic increment with logarithmic behavior. Given the value
+# of the old counter, when a key is accessed, the counter is incremented in
+# this way:
+#
+# 1. A random number R between 0 and 1 is extracted.
+# 2. A probability P is calculated as 1/(old_value*lfu_log_factor+1).
+# 3. The counter is incremented only if R < P.
+#
+# The default lfu-log-factor is 10. This is a table of how the frequency
+# counter changes with a different number of accesses with different
+# logarithmic factors:
+#
+# +--------+------------+------------+------------+------------+------------+
+# | factor | 100 hits | 1000 hits | 100K hits | 1M hits | 10M hits |
+# +--------+------------+------------+------------+------------+------------+
+# | 0 | 104 | 255 | 255 | 255 | 255 |
+# +--------+------------+------------+------------+------------+------------+
+# | 1 | 18 | 49 | 255 | 255 | 255 |
+# +--------+------------+------------+------------+------------+------------+
+# | 10 | 10 | 18 | 142 | 255 | 255 |
+# +--------+------------+------------+------------+------------+------------+
+# | 100 | 8 | 11 | 49 | 143 | 255 |
+# +--------+------------+------------+------------+------------+------------+
+#
+# NOTE: The above table was obtained by running the following commands:
+#
+# redis-benchmark -n 1000000 incr foo
+# redis-cli object freq foo
+#
+# NOTE 2: The counter initial value is 5 in order to give new objects a chance
+# to accumulate hits.
+#
+# The counter decay time is the time, in minutes, that must elapse in order
+# for the key counter to be divided by two (or decremented if it has a value
+# less <= 10).
+#
+# The default value for the lfu-decay-time is 1. A Special value of 0 means to
+# decay the counter every time it happens to be scanned.
+#
+# lfu-log-factor 10
+# lfu-decay-time 1
+
+########################### ACTIVE DEFRAGMENTATION #######################
+#
+# WARNING THIS FEATURE IS EXPERIMENTAL. However it was stress tested
+# even in production and manually tested by multiple engineers for some
+# time.
+#
+# What is active defragmentation?
+# -------------------------------
+#
+# Active (online) defragmentation allows a Redis server to compact the
+# spaces left between small allocations and deallocations of data in memory,
+# thus allowing to reclaim back memory.
+#
+# Fragmentation is a natural process that happens with every allocator (but
+# less so with Jemalloc, fortunately) and certain workloads. Normally a server
+# restart is needed in order to lower the fragmentation, or at least to flush
+# away all the data and create it again. However thanks to this feature
+# implemented by Oran Agra for Redis 4.0 this process can happen at runtime
+# in an "hot" way, while the server is running.
+#
+# Basically when the fragmentation is over a certain level (see the
+# configuration options below) Redis will start to create new copies of the
+# values in contiguous memory regions by exploiting certain specific Jemalloc
+# features (in order to understand if an allocation is causing fragmentation
+# and to allocate it in a better place), and at the same time, will release the
+# old copies of the data. This process, repeated incrementally for all the keys
+# will cause the fragmentation to drop back to normal values.
+#
+# Important things to understand:
+#
+# 1. This feature is disabled by default, and only works if you compiled Redis
+# to use the copy of Jemalloc we ship with the source code of Redis.
+# This is the default with Linux builds.
+#
+# 2. You never need to enable this feature if you don't have fragmentation
+# issues.
+#
+# 3. Once you experience fragmentation, you can enable this feature when
+# needed with the command "CONFIG SET activedefrag yes".
+#
+# The configuration parameters are able to fine tune the behavior of the
+# defragmentation process. If you are not sure about what they mean it is
+# a good idea to leave the defaults untouched.
+
+# Enabled active defragmentation
+# activedefrag yes
+
+# Minimum amount of fragmentation waste to start active defrag
+# active-defrag-ignore-bytes 100mb
+
+# Minimum percentage of fragmentation to start active defrag
+# active-defrag-threshold-lower 10
+
+# Maximum percentage of fragmentation at which we use maximum effort
+# active-defrag-threshold-upper 100
+
+# Minimal effort for defrag in CPU percentage
+# active-defrag-cycle-min 25
+
+# Maximal effort for defrag in CPU percentage
+# active-defrag-cycle-max 75
+
diff --git a/docs/Docker.md b/docs/Docker.md
new file mode 100644
index 00000000..cf528fe7
--- /dev/null
+++ b/docs/Docker.md
@@ -0,0 +1,59 @@
+
+Running a local development instance of hook.io is simple.
+
+First, you'll need to install [Docker](https://docs.docker.com/engine/installation/).
+
+### Docker???
+
+It's important to note that hook.io is only using Docker for helping developers get setup with a local development instance. We are not using Docker in production and do not recommend using our Docker image and default configurations in production ( as there will be almost no service isolation ).
+
+### Installing hook.io
+
+You may directly use your computer with Docker, or use `docker-machine`:
+
+```bash
+docker-machine create hook.io
+eval $(docker-machine env hook.io)
+```
+
+Once `docker-machine` is installed and running, perform the following commands:
+
+``` bash
+git clone https://github.com/bigcompany/hook.io
+cd hook.io
+docker-compose build
+docker-compose up
+```
+
+This should start the following services:
+
+ - 1 hook.io front-end
+ - 1 hook.io load balancer
+ - 1 hook.io worker
+ - 1 couchdb server
+ - 1 redis server
+
+*Note: The `cron` and `hpm` services are not currently included in our docker image. If you require using these services locally they should be easy to add.*
+
+### Configure the local running hook.io instance
+
+Once the services are started, you'll still need to run one more command.
+
+To find the current address of the Docker machine run: `docker-machine ip hook.io`.
+
+```bash
+curl http://{{your_docker_machine_ip}}/_admin?setBase=1
+```
+
+If directly running from your computer, just use `localhost` for `{{your_docker_machine_ip}}`.
+
+You should see something like:
+
+```
+set baseUrl to: http://{{your_docker_machine_ip}}:80
+```
+
+Without running this last line, site formatting (CSS), most HTTP redirects, and AJAX gateways in the system will not work.
+
+You may now browse to `http://{{your_docker_machine_ip}}` to access your local hook.io instance.
+
diff --git a/lib/broadcast/broadcast.js b/lib/broadcast/broadcast.js
new file mode 100644
index 00000000..885d9740
--- /dev/null
+++ b/lib/broadcast/broadcast.js
@@ -0,0 +1,359 @@
+/*
+
+ broadcast/broadcast.js
+
+ front-facing event broadcasting service for hook.io
+ responsible for handling broadcast events to websockets clients and vice versa
+ acts a bridge between hook.io webhooks input and connected websocket output
+ exists as separate service from load-balancer to ensure scalibity
+
+*/
+
+var resource = require('resource');
+resource.setMaxListeners(999);
+process.setMaxListeners(999);
+
+var secrets = {};
+var config = require('../../config');
+
+if (process.platform === "darwin") {
+ config.sslKeyDirectory = __dirname + '/../../ssl/';
+ config.chrootDirectory = '/Users/chroot';
+ config.redis.host = "0.0.0.0";
+ config.couch.host = "0.0.0.0";
+}
+
+var request = require("hyperquest");
+var rrequest = require('request');
+var http = require('resource-http');
+var colors = require('colors');
+var fs = require('fs');
+
+var server = {};
+module['exports'] = server;
+
+var sslKeyDirectory = config.sslKeyDirectory;
+
+server.start = function start (opts, cb) {
+
+ var sslPath, key, cert, ca;
+ if (process.platform === "darwin") {
+ /* Removed, migrated to godaddy to letsencrypt */
+ key = fs.readFileSync(sslKeyDirectory + "server.key").toString();
+ cert = fs.readFileSync(sslKeyDirectory + "server.crt").toString();
+ ca = [fs.readFileSync(sslKeyDirectory + 'gd1.crt').toString(), fs.readFileSync(sslKeyDirectory + 'gd2.crt').toString(), fs.readFileSync(sslKeyDirectory + 'gd3.crt').toString()]
+ } else {
+ sslPath = '/etc/letsencrypt/live/hook.io/';
+ key = fs.readFileSync(sslPath + "privkey.pem").toString();
+ cert = fs.readFileSync(sslPath + "fullchain.pem").toString();
+ }
+
+ // sometimes in development you might mix and match a common ssl for projects
+ // comment this line out for production usage
+ process.env.NODE_TLS_REJECT_UNAUTHORIZED = 0
+
+ var secretConfig;
+
+ var defaultConfig = {
+ "port": 9998,
+ "proxyPort": 9998,
+ "host": "0.0.0.0",
+ "https": true,
+ "roots": [
+ "ws.hookio",
+ "0.0.0.0",
+ "localhost",
+ "ws.hook.io",
+ ],
+ noSession: true,
+ port: config.broadcast.port,
+ wss: true, // enables websocket server
+ enableUploads: false,
+ // host: config.balancer.host,
+ roots: config.broadcast.roots,
+ // passport: true,
+ // port: config.balancer.port,
+ // https: config.balancer.https,
+ https: false,
+ cert: cert,
+ key: key,
+ // ca: ca,
+ /*
+ session: config.web.session,
+ redis: config.balancer.redis,
+ */
+ cacheView: config.cacheView,
+ sslRequired: false // will not force ssl connections on custom domains / subdomains
+ };
+
+ startServer();
+ /*
+ // get remote configuration for server from oys
+ client.secret.get(['dev-load-balancer', 'dev-pool-webs'], function (err, _secrets) {
+ if (err) {
+ console.log('balancer: Remote secrets were not fetched, using default static configuration.');
+ secrets = config;
+ } else {
+ // use discovered secrets as config
+ secrets = _secrets;
+ secretConfig = secrets['dev-load-balancer'];
+ //websPool = secrets['dev-pool-webs'];
+ // merge secretConfig over default config
+ for (var p in secretConfig) {
+ defaultConfig[p] = secretConfig[p];
+ }
+ }
+ startServer();
+ });
+ */
+
+ function startServer () {
+ // TODO: Need to not start listening server in resource-http
+ // resource-http should return server and app instance to modify,
+ // after additional routes are added, then we can start listening.
+ // This is important due to cluster module thinking nodes are online and ready, but they are still adding new routes
+ // Until fixed, this could cause potential issue with zero-downtime updates of load balancer ( since nodes are coming online before additional routes are ready )
+ http.listen(defaultConfig, function (err, app) {
+
+ if (err) {
+ // any errors starting the load-balancer should result in process crash / do not start server
+ throw err;
+ }
+
+ server.app = app;
+
+ if (app.wss) {
+ app.wss.on('error', function errorHandler(err) {
+ console.log('warning wss.error emitted', err.message)
+ })
+
+ app.wss.on('connection', function connection (ws) {
+
+ // verify or reject connection based on auth
+ var target = ws.upgradeReq.url;
+
+ // console.log('incoming connection ->', target)
+ ws.on('error', function errorHandler (error) {
+ console.log('warning ws.error emitted', error.message)
+ proxyWebsocketMessage(ws, target, message) // is this a mistake? should it be error that is passed? message is going to be undefined everytime?
+ });
+ ws.on('message', function incoming(message) {
+ console.log('incoming data stream'.green, message)
+ proxyWebsocketMessage(ws, target, message)
+ });
+ });
+ }
+
+ if (app.secureWss) {
+ app.secureWss.on('error', function errorHandler (err) {
+ console.log('warning wss.error emitted', err.message)
+ })
+
+ app.secureWss.on('connection', function connection(ws) {
+ var target = ws.upgradeReq.url;
+ // console.log('incoming secure connection ->', target)
+ ws.on('error', function errorHandler(error) {
+ console.log('warning ws.error emitted', error.message)
+ proxyWebsocketMessage(ws, target, message)
+ });
+ ws.on('message', function incoming(message) {
+ // console.log('incoming secure data stream', message)
+ proxyWebsocketMessage(ws, target, message)
+ });
+ });
+ }
+
+ var request = require('request');
+
+ function proxyWebsocketMessage (ws, target, message) {
+ // send message out to all connected clients
+
+ /* */
+ // Broadcast to all.
+ /*
+ wss.broadcast = function broadcast(data) {
+ wss.clients.forEach(function each(client) {
+ if (client.readyState === WebSocket.OPEN) {
+ client.send(data);
+ }
+ });
+ };
+ */
+
+ // Broadcast to everyone else.
+ app.wss.clients.forEach(function each(client) {
+ // do not send to self, only send to ready clients
+ if (client !== ws && client.readyState === "WebSocket.OPEN") {
+ console.log('SENDING THE MESSAGE', data);
+ client.send(message);
+ }
+ client.send(message);
+
+ });
+
+ console.log('attenotubg ti broadcast message', message)
+ return;
+ try {
+ // attempt to parse message as JSON
+ message = JSON.parse(message);
+ } catch (err) {
+ // if the JSON parse fails, create new object and store string as `body` property
+ // note: this is somewhat hacky, but it does provide a functional api...feedback would be appreciated
+ message = { body: message };
+ }
+ var w = config.pools.worker.pop();
+ config.pools.worker.unshift(w);
+ var _url = 'http://' + w.host + ':' + w.port + target;
+ // console.log(new Date().toString() + ' - about to use worker', _url);
+ rrequest.post(_url, { json: message }, function (err, res, body) {
+ if (err) {
+ try {
+ ws.send(JSON.stringify({ "status": "error", "message": err.message }, true, 2));
+ } catch (err) {
+ console.log('warning ws.send failed', err.message)
+ }
+ } else {
+ try {
+ ws.send(JSON.stringify(body, true, 2));
+ } catch (err) {
+ console.log('warning ws.send failed', err.message)
+ }
+ }
+ });
+ };
+
+ // Note: Due to the structure of the application, certain API / Web routes need to be registered here ( in the load-balancer ) to short-circuit the processing of the request
+ // If these routes are not registered, the requests will be passed to the worker pool as a microservice request ( with extra url paramters )
+ // These special routes are reserved words used for helping manage certain properties / methods on the service by using a reserved url path
+ // Without this lookup table, we'd have to take a performance hit somewhere to redirect ( such as redirecting inside worker).
+ // This look-up table will minimize request processing time
+ var webRoutes = [
+ '/account/:section',
+ '/auth/qrcode',
+ '/blog/:article',
+ '/files',
+ '/files/:method',
+// '/api-gateway',
+// '/api-gateway/:method',
+ '/keys/:method',
+ '/gateway/logs',
+ '/packages/:provider',
+ '/packages/:provider/:method',
+ '/login/:provider',
+ '/login/:provider/:callback',
+ '/datastore/:method',
+ '/:owner/:hook/admin',
+ '/:owner/:hook/_admin',
+ '/:owner/:hook/fork',
+ '/:owner/:hook/_fork',
+ '/:owner/events',
+ '/:owner/:hook/_rev',
+ '/:owner/:hook/_rev/:revision',
+ '/:owner/:hook/_src',
+ '/:owner/:hook/source',
+ '/:owner/:hook/view',
+ '/:owner/:hook/presenter',
+ '/:owner/:hook/_presenter',
+ '/:owner/:hook/logs',
+ '/:owner/:hook/package',
+ '/:owner/:hook/resource',
+ '/:owner/:hook/delete',
+ // '/:owner/:hook/refresh',
+ '/metrics/:owner/:metric',
+ '/metrics/:owner/:hook/:metric',
+ '/components/:component',
+ '/editor/:page',
+ '/emails/:email',
+ ];
+
+ webRoutes.forEach(function (r) {
+ app.all(r, server.handle404);
+ });
+
+ var hookHandler = require('../server/routeHandlers/hook');
+
+ function hookHandler (req, res) {
+ req.params.owner = req.params.owner.toLowerCase();
+ req.params.hook = req.params.hook.toLowerCase();
+ hookHandler(req, res);
+ };
+
+ app.all('/:owner/:hook', function (req, res){
+ req.params.owner = req.params.owner.toLowerCase();
+ req.params.hook = req.params.hook.toLowerCase();
+ hookHandler(req, res)
+ });
+
+ app.all('/:owner/:hook/*', function (req, res){
+ req.params.owner = req.params.owner.toLowerCase();
+ req.params.hook = req.params.hook.toLowerCase();
+ hookHandler(req, res);
+ });
+
+ app.get('/_cluster', function (req, res) {
+ if (typeof process.send !== 'function') {
+ return res.json({ error: true, message: 'process.send function not detected. is cluster mode enabled?'})
+ }
+ if (req.resource.params.super_private_key === config.superadmin.super_private_key) {
+ var clusterQuery = {};
+ process.once('message', function(message) {
+ clusterQuery = message;
+ return res.json(message);
+ });
+ process.send({ event: 'query' });
+ } else {
+ res.end('invalid credentials');
+ }
+ });
+
+ app.get('/_restart', function (req, res) {
+ if (typeof process.send !== 'function') {
+ return res.json({ error: true, message: 'process.send function not detected. is cluster mode enabled?'})
+ }
+ if (req.resource.params.super_private_key === config.superadmin.super_private_key) {
+ process.send({ event: 'restart' })
+ res.end('restart nodes');
+ } else {
+ res.end('invalid credentials');
+ }
+ });
+
+ app.use(server.handle404);
+ cb(err, app);
+ });
+ }
+
+};
+
+server.handle404 = function handle404 (req, res) {
+ // console.log('falling back to 404'.blue, req.url, req.host);
+ // Remark: Available secrets should now automatically merge into config scope
+ // var remoteHandler = require('run-remote-service')({ pool: secrets['dev-pool-webs'] });
+ var remoteHandler = require('run-remote-service')({
+ pool: config.pools.web,
+ errorHandler: function (err, req, res) {
+ var errStr = 'Error communicating with ' + req.url + '\n\n';
+ errStr += 'The streaming connection errored in recieving data.\n\n';
+ errStr += 'Please copy and paste this entire error message to: ' + config.app.adminEmail + '.\n\n';
+ if (req.jsonResponse) {
+ return res.json({
+ error: true,
+ message: errStr,
+ result: {
+ url: req.url,
+ host: req.host,
+ time: new Date()
+ }
+ });
+ } else {
+ res.write(errStr);
+ res.end(err.stack)
+ }
+ }
+ });
+
+ remoteHandler(req, res, function(){
+ // console.log('complete');
+ // next callback is not needed as response should have ended
+ });
+};
\ No newline at end of file
diff --git a/lib/helpers/numberWithCommas.js b/lib/helpers/numberWithCommas.js
new file mode 100644
index 00000000..3af578ae
--- /dev/null
+++ b/lib/helpers/numberWithCommas.js
@@ -0,0 +1,5 @@
+function numberWithCommas (x) {
+ return x.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ",");
+}
+
+module.exports = numberWithCommas;
\ No newline at end of file
diff --git a/lib/load-balancer/load-balancer.js b/lib/load-balancer/load-balancer.js
new file mode 100644
index 00000000..46c58313
--- /dev/null
+++ b/lib/load-balancer/load-balancer.js
@@ -0,0 +1,461 @@
+/*
+
+ load-balancer/index.js
+
+ front-facing load-balancer service for hook.io
+ responsible for routing requests to either `web` or `worker` instances
+ handles no direct logic for response processing, only routing
+
+*/
+
+var big = require('big');
+// application has a lot of listeners
+big.resource.setMaxListeners(999);
+process.setMaxListeners(999);
+big.mode = "Online";
+var secrets = {};
+var config = require('../../config');
+var websPool = {};
+
+if (process.platform === "darwin") {
+ config.sslKeyDirectory = __dirname + '/../../ssl/';
+ config.chrootDirectory = '/Users/chroot';
+ config.redis.host = "0.0.0.0";
+ config.couch.host = "0.0.0.0";
+ config.worker.publicIP = "0.0.0.0";
+ config.web.host = "0.0.0.0";
+}
+
+var request = require("hyperquest");
+var rrequest = require('request');
+var http = require('resource-http');
+var domain = require('../resources/domain');
+var cache = require('../resources/cache');
+var alerts = require('../resources/alerts/alerts');
+
+var colors = require('colors');
+var fs = require('fs');
+var pool = config.pools.worker;
+
+var server = {};
+module['exports'] = server;
+
+var sslKeyDirectory = config.sslKeyDirectory;
+
+server.start = function start (opts, cb) {
+
+ var sslPath, key, cert, ca;
+ if (process.platform === "darwin") {
+ /* Removed, migrated to godaddy to letsencrypt */
+ key = fs.readFileSync(sslKeyDirectory + "localhost.key").toString();
+ cert = fs.readFileSync(sslKeyDirectory + "localhost.crt").toString();
+ //ca = [fs.readFileSync(sslKeyDirectory + 'gd1.crt').toString(), fs.readFileSync(sslKeyDirectory + 'gd2.crt').toString(), fs.readFileSync(sslKeyDirectory + 'gd3.crt').toString()]
+ } else {
+ sslPath = '/etc/letsencrypt/live/hook.io/';
+ key = fs.readFileSync(sslPath + "privkey.pem").toString();
+ cert = fs.readFileSync(sslPath + "fullchain.pem").toString();
+ }
+
+ // sometimes in development you might mix and match a common ssl for projects
+ // comment this line out for production usage
+ process.env.NODE_TLS_REJECT_UNAUTHORIZED = 0
+
+ domain.persist(config.couch);
+
+ var secretConfig;
+
+ var defaultConfig = {
+ "port": 9999,
+ "proxyPort": 9999,
+ "host": "0.0.0.0",
+ "https": true,
+ "roots": [
+ "hookio",
+ "0.0.0.0",
+ "localhost",
+ "hook.io",
+ "www.hook.io"
+ ],
+ noSession: true,
+ port: config.balancer.port,
+ wss: true, // enables websocket server
+ enableUploads: false,
+ // host: config.balancer.host,
+ roots: config.balancer.roots,
+ passport: true,
+ // port: config.balancer.port,
+ https: config.balancer.https,
+ cert: cert,
+ key: key,
+ // ca: ca,
+ /*
+ session: config.web.session,
+ redis: config.balancer.redis,
+ */
+ cacheView: config.cacheView,
+ customDomains: true,
+ sslRequired: false // will not force ssl connections on custom domains / subdomains
+ };
+
+ startServer();
+ /*
+ // get remote configuration for server from oys
+ client.secret.get(['dev-load-balancer', 'dev-pool-webs'], function (err, _secrets) {
+ if (err) {
+ console.log('balancer: Remote secrets were not fetched, using default static configuration.');
+ secrets = config;
+ } else {
+ // use discovered secrets as config
+ secrets = _secrets;
+ secretConfig = secrets['dev-load-balancer'];
+ //websPool = secrets['dev-pool-webs'];
+ // merge secretConfig over default config
+ for (var p in secretConfig) {
+ defaultConfig[p] = secretConfig[p];
+ }
+ }
+ startServer();
+ });
+ */
+
+ function startServer () {
+ // TODO: Need to not start listening server in resource-http
+ // resource-http should return server and app instance to modify,
+ // after additional routes are added, then we can start listening.
+ // This is important due to cluster module thinking nodes are online and ready, but they are still adding new routes
+ // Until fixed, this could cause potential issue with zero-downtime updates of load balancer ( since nodes are coming online before additional routes are ready )
+ http.listen(defaultConfig, function (err, app) {
+
+ if (err) {
+ // any errors starting the load-balancer should result in process crash / do not start server
+ throw err;
+ }
+
+ server.app = app;
+ big.server = server;
+ if (app.wss) {
+ app.wss.on('error', function errorHandler(err) {
+ console.log('warning wss.error emitted', err.message)
+ })
+
+ app.wss.on('connection', function connection(ws) {
+ var target = ws.upgradeReq.url;
+ // console.log('incoming connection ->', target)
+ ws.on('error', function errorHandler(error) {
+ console.log('warning ws.error emitted', error.message)
+ proxyWebsocketMessage(ws, target, message)
+ });
+ ws.on('message', function incoming(message) {
+ // console.log('incoming data stream', message)
+ proxyWebsocketMessage(ws, target, message)
+ });
+ });
+ }
+
+ if (app.secureWss) {
+ app.secureWss.on('error', function errorHandler(err) {
+ console.log('warning wss.error emitted', err.message)
+ })
+
+ app.secureWss.on('connection', function connection(ws) {
+ var target = ws.upgradeReq.url;
+ // console.log('incoming secure connection ->', target)
+ ws.on('error', function errorHandler(error) {
+ console.log('warning ws.error emitted', error.message)
+ proxyWebsocketMessage(ws, target, message)
+ });
+ ws.on('message', function incoming(message) {
+ // console.log('incoming secure data stream', message)
+ proxyWebsocketMessage(ws, target, message)
+ });
+ });
+ }
+
+ var request = require('request');
+
+ function proxyWebsocketMessage (ws, target, message) {
+ try {
+ // attempt to parse message as JSON
+ message = JSON.parse(message);
+ } catch (err) {
+ // if the JSON parse fails, create new object and store string as `body` property
+ // note: this is somewhat hacky, but it does provide a functional api...feedback would be appreciated
+ message = { body: message };
+ }
+ var w = config.pools.worker.pop();
+ config.pools.worker.unshift(w);
+ var _url = 'http://' + w.host + ':' + w.port + target;
+ // console.log(new Date().toString() + ' - about to use worker', _url);
+ rrequest.post(_url, { json: message }, function (err, res, body) {
+ if (err) {
+ try {
+ ws.send(JSON.stringify({ "status": "error", "message": err.message }, true, 2));
+ } catch (err) {
+ console.log('warning ws.send failed', err.message)
+ }
+ } else {
+ try {
+ ws.send(JSON.stringify(body, true, 2));
+ } catch (err) {
+ console.log('warning ws.send failed', err.message)
+ }
+ }
+ });
+ };
+
+ // Note: Due to the structure of the application, certain API / Web routes need to be registered here ( in the load-balancer ) to short-circuit the processing of the request
+ // If these routes are not registered, the requests will be passed to the worker pool as a microservice request ( with extra url paramters )
+ // These special routes are reserved words used for helping manage certain properties / methods on the service by using a reserved url path
+ // Without this lookup table, we'd have to take a performance hit somewhere to redirect ( such as redirecting inside worker).
+ // This look-up table will minimize request processing time
+ var webRoutes = [
+ '/account/:section',
+ '/account/billing/:section',
+ '/blog/:article',
+ '/files',
+ '/files/:method',
+// '/api-gateway',
+// '/api-gateway/:method',
+ '/keys/:method',
+ '/cron/:method',
+ '/cron/:owner/:name',
+ '/cron/:owner/:name/:method',
+ '/gateway/logs',
+ '/packages/:provider',
+ '/packages/:provider/:method',
+ '/login/:provider',
+ '/stripe/webhook',
+ '/login/:provider/:callback',
+ '/datastore/:method',
+ '/:owner/:hook/admin',
+ '/:owner/:hook/_admin',
+ '/:owner/:hook/fork',
+ '/:owner/:hook/_fork',
+ '/:owner/events',
+ '/:owner/:hook/_rev',
+ '/:owner/:hook/_rev/:revision',
+ '/:owner/:hook/_src',
+ '/:owner/:hook/source',
+ '/:owner/:hook/view',
+ '/:owner/:hook/presenter',
+ '/:owner/:hook/_presenter',
+ '/:owner/:hook/logs',
+ '/:owner/:hook/package',
+ '/:owner/:hook/resource',
+ '/:owner/:hook/delete',
+ // '/:owner/:hook/refresh',
+ '/metrics/:owner/:metric',
+ '/metrics/:owner/:hook/:metric',
+ '/components/:component',
+ '/editor/:page',
+ '/emails/:email',
+ ];
+
+ webRoutes.forEach(function (r) {
+ app.all(r, server.handle404);
+ });
+
+ var hookHandler = require('../server/routeHandlers/hook');
+
+ function hookHandler (req, res) {
+ req.params.owner = req.params.owner.toLowerCase();
+ req.params.hook = req.params.hook.toLowerCase();
+ hookHandler(req, res);
+ };
+
+ app.all('/:owner/:hook', function (req, res){
+ req.params.owner = req.params.owner.toLowerCase();
+ req.params.hook = req.params.hook.toLowerCase();
+ hookHandler(req, res)
+ });
+
+ app.all('/:owner/:hook/*', function (req, res){
+ req.params.owner = req.params.owner.toLowerCase();
+ req.params.hook = req.params.hook.toLowerCase();
+ hookHandler(req, res);
+ });
+
+ app.get('/_cluster', function (req, res) {
+ if (typeof process.send !== 'function') {
+ return res.json({ error: true, message: 'process.send function not detected. is cluster mode enabled?'})
+ }
+ if (req.resource.params.super_private_key === config.superadmin.super_private_key) {
+ var clusterQuery = {};
+ process.once('message', function(message) {
+ clusterQuery = message;
+ return res.json(message);
+ });
+ process.send({ event: 'query' });
+ } else {
+ res.end('invalid credentials');
+ }
+ });
+
+ app.get('/_restart', function (req, res) {
+ if (typeof process.send !== 'function') {
+ return res.json({ error: true, message: 'process.send function not detected. is cluster mode enabled?'})
+ }
+ if (req.resource.params.super_private_key === config.superadmin.super_private_key) {
+ process.send({ event: 'restart' })
+ res.end('restart nodes');
+ } else {
+ res.end('invalid credentials');
+ }
+ });
+ app.use(server.handle404);
+ updateBalancingTable(function (err) {
+ // setTimeout to update the balancing table every 20 seconds
+ loopUpdates();
+ cb(err, app);
+ });
+ });
+ }
+
+};
+
+function loopUpdates () {
+ setTimeout(function () {
+ updateBalancingTable(function(err){
+ if (err) {
+ console.log('error updating balancing table', err)
+ }
+ loopUpdates();
+ })
+ }, 1000);
+};
+
+function updateBalancingTable (cb) {
+ // get latest config from redis cache
+ cache.smembers('pools.web', function (err, webs) {
+ if (err) {
+ console.log('cant fetch pools.web', err);
+ return cb(err);
+ }
+ // console.log('got pools.web', webs.length);
+ if (webs !== null && typeof webs === "object") {
+ // if the pool is empty, simply assign the current webs
+ if (config.pools.web.length === 0) {
+ config.pools.web = webs;
+ } else {
+ // if the pool already contains web instances,
+ // for every existing web node...
+ config.pools.web.forEach(function(oldWeb, i){
+ var found = false;
+ // check to see if it exists in the incoming table
+ webs.forEach(function(newWeb){
+ if (newWeb && oldWeb && oldWeb.host === newWeb.host && oldWeb.port === newWeb.port) {
+ // we found a matching web already in the load balancer pool
+ found = true;
+ } else {
+ }
+ });
+ if (!found) {
+ // if we didn't find a match, assume it's expired and remove it
+ console.log('remove web node from pool', oldWeb);
+ config.pools.web.splice(i, 1);
+ }
+ });
+ // for every incoming web node
+ webs.forEach(function(newWeb){
+ var found = false;
+ // check against all existing webs
+ config.pools.web.forEach(function(oldWeb, i){
+ // console.log(newWeb, oldWeb)
+ if (newWeb && oldWeb && oldWeb.host === newWeb.host && oldWeb.port === newWeb.port) {
+ // we found a matching web already in the load balancer pool
+ found = true;
+ }
+ });
+ if (!found) {
+ // if we didn't find a match, assume it's a new web and put it in the end
+ config.pools.web.unshift(newWeb);
+ }
+ });
+ }
+ }
+
+ cache.smembers('pools.worker', function (err, workers) {
+ if (err) {
+ console.log('cant fetch pools.worker', err);
+ return cb(err);
+ }
+ // console.log('got pools.worker', workers.length);
+ if (workers !== null && typeof workers === "object") {
+ var found = false;
+ // only update workers if they are new, add them to the end of the list
+ if (config.pools.worker.length === 0) {
+ config.pools.worker = workers;
+ return cb(null);
+ }
+
+ // for every existing worker node
+ config.pools.worker.forEach(function(oldWorker, i){
+ var found = false;
+ // check to see if it exists in the incoming table
+ workers.forEach(function(newWorker){
+ if (newWorker && oldWorker && oldWorker.host === newWorker.host && oldWorker.port === newWorker.port) {
+ // we found a matching web already in the load balancer pool
+ found = true;
+ }
+ });
+ if (!found) {
+ // if we didn't find a match, assume it's expired and remove it
+ console.log('remove worker node from pool', oldWorker);
+ config.pools.worker.splice(i, 1);
+ //config.pools.worker.splice(i, 0);
+ }
+ });
+
+ // for every incoming worker
+ workers.forEach(function(newWorker){
+ var found = false;
+ // check against all existing workers
+ config.pools.worker.forEach(function(oldWorker){
+ // console.log(newWorker, oldWorker)
+ if (newWorker && oldWorker && oldWorker.host === newWorker.host && oldWorker.port === newWorker.port) {
+ // we found a matching worker already in the load balancer pool
+ found = true;
+ }
+ });
+ if (!found) {
+ // if we didn't find a match, assume it's a new worker and put it in the end
+ config.pools.worker.unshift(newWorker);
+ }
+ });
+ }
+ cb(null);
+ });
+ });
+}
+
+server.handle404 = function handle404 (req, res) {
+ // console.log('falling back to 404'.blue, req.url, req.host);
+ // Remark: Available secrets should now automatically merge into config scope
+ // var remoteHandler = require('run-remote-service')({ pool: secrets['dev-pool-webs'] });
+ var remoteHandler = require('run-remote-service')({
+ pool: config.pools.web,
+ errorHandler: function (err, req, res) {
+ var errStr = 'Error communicating with ' + req.url + '\n\n';
+ errStr += 'The streaming connection errored in recieving data.\n\n';
+ errStr += 'Please copy and paste this entire error message to: ' + config.app.adminEmail + '.\n\n';
+ if (req.jsonResponse) {
+ return res.json({
+ error: true,
+ message: errStr,
+ result: {
+ url: req.url,
+ host: req.host,
+ time: new Date()
+ }
+ });
+ } else {
+ res.write(errStr);
+ res.end(err.stack)
+ }
+ }
+ });
+ remoteHandler(req, res, function(){
+ // console.log('complete');
+ // next callback is not needed as response should have ended
+ });
+};
\ No newline at end of file
diff --git a/lib/resources/alerts/alerts.js b/lib/resources/alerts/alerts.js
new file mode 100644
index 00000000..d4ce5d01
--- /dev/null
+++ b/lib/resources/alerts/alerts.js
@@ -0,0 +1,142 @@
+var resource = require('resource');
+var colors = require('colors');
+var cache = require('../cache');
+var metric = require('../metric');
+var alerts = resource.define('alerts');
+var config = require('../../../config');
+var util = require('util');
+var fs = require('fs');
+var async = require('async');
+var email = require('resource-email');
+
+var exceededLimitEmailTemplate = fs.readFileSync(__dirname + '/emails/exceeded-rate-limit.txt').toString();
+var approachingLimitEmailTemplate = fs.readFileSync(__dirname + '/emails/approaching-rate-limit.txt').toString();
+
+alerts.timestamps();
+
+alerts.property('name', {
+ 'type': 'string',
+ 'default': 'my-alert-name',
+ 'required': true,
+ 'minLength': 1,
+ 'maxLength': 50
+});
+
+alerts.property('username', {
+ 'type': 'string',
+ 'required': true,
+ 'minLength': 1,
+ 'maxLength': 50
+});
+
+alerts.property('email', {
+ 'type': 'string',
+ 'required': false,
+ 'default': 'hookmaster@hook.io'
+});
+
+alerts.property('subject', {
+ 'type': 'string',
+ 'required': true,
+ 'default': 'Alert from hook.io'
+});
+
+alerts.property('code', {
+ 'type': 'string',
+ 'required': true,
+ 'default': 'DEFAULT_ALERT_CODE'
+});
+
+alerts.property('message', {
+ 'type': 'string'
+});
+
+alerts.property('metadata', {
+ 'type': 'object'
+});
+
+alerts.property('status', {
+ 'type': 'string',
+ 'default': 'queued',
+ 'required': true,
+ 'enum': ['queued', 'silent', 'sent', 'error']
+});
+
+alerts.after('create', function (data, next) {
+ // create
+ metric.zadd('alerts', new Date().getTime(), data.username, function (err) {
+ if (err) {
+ console.log('error: saving metrics/alerts', data.username, err);
+ }
+ next(null, data);
+ });
+});
+
+alerts.persist(config.couch);
+resource.on('usage::ratelimit', function (data) {
+ // by default, alerts should be silent ( no intended actions )
+ var status = 'silent';
+ // If the user has exceeded it's monthly rate limit, we do want to send out an alert, so queue it
+ if (data.code === 'RATE_LIMIT_EXCEEDED') {
+ status = 'queued';
+ }
+ alerts.create({
+ username: data.username,
+ email: data.email,
+ name: 'Rate Limit Exceeded',
+ status: status,
+ subject: 'Account Rate Limit Exceeded',
+ metadata: data,
+ code: data.code
+ }, function (err, alert) {
+ if (err) {
+ console.log('error creating alert:', err);
+ }
+ });
+});
+
+// TODO: clear out / archive older alerts after some period of time ( perhaps 3 months )
+alerts.sendAlerts = function (data, finish) {
+ alerts.find({ status: 'queued' }, function (err, _alerts) {
+ console.log('Found alerts', _alerts.length);
+ // consolidate alerts into object keyed on email
+ // we shouldn't be sending out multiple alert emails at once, it probably means an error in alerting system
+ var deduped = {};
+ _alerts.map(function(a){
+ deduped[a.email] = a;
+ });
+ console.log('Dedupled alerts to', Object.keys(deduped).length);
+ async.eachLimit(Object.keys(deduped), 5, processAlert, function (err, re){
+ finish();
+ });
+ function processAlert (key, cb) {
+ var _alert = deduped[key];
+ _alert.message = exceededLimitEmailTemplate;
+ _alert.message = _alert.message.replace('{{username}}', _alert.username);
+ _alert.message = _alert.message.replace(/{{servicePlan}}/g, _alert.metadata.servicePlan);
+ _alert.message = _alert.message.replace(/{{monthlyLimit}}/g, _alert.metadata.monthlyLimit);
+ console.log('sending alert', _alert.email, _alert);
+ email.send({
+ provider: config.email.provider,
+ api_user: config.email.api_user,
+ api_key: config.email.api_key,
+ to: _alert.email,
+ bcc: ['marak@hook.io'],
+ from: 'hookmaster@hook.io',
+ subject: _alert.subject,
+ html: _alert.message
+ }, function (err) {
+ if (err) {
+ console.log(err);
+ cb();
+ return;
+ }
+ console.log('alert email sent', data)
+ _alert.status = 'sent';
+ _alert.save(cb);
+ })
+ }
+ });
+};
+
+module['exports'] = alerts;
\ No newline at end of file
diff --git a/lib/resources/alerts/emails/approaching-rate-limit.txt b/lib/resources/alerts/emails/approaching-rate-limit.txt
new file mode 100644
index 00000000..d6f0a24d
--- /dev/null
+++ b/lib/resources/alerts/emails/approaching-rate-limit.txt
@@ -0,0 +1,15 @@
+Hello {{username}}!
+
+This is a friendly reminder that your hook.io account has reached 75% of it's allotted requests this month.
+
+Current Monthly Requests: {{currentMonthlyTotal}}
+Monthly Limit: {{monthlyTotalLimit}}
+Service Plan: {{planName}}
+
+If your account exceeds it's monthly limit it's services may become temporarily unavailable.
+
+Please let me know if you have any questions.
+
+Sincerely,
+Marak
+Creator of hook.io
\ No newline at end of file
diff --git a/lib/resources/alerts/emails/exceeded-rate-limit.txt b/lib/resources/alerts/emails/exceeded-rate-limit.txt
new file mode 100644
index 00000000..be098716
--- /dev/null
+++ b/lib/resources/alerts/emails/exceeded-rate-limit.txt
@@ -0,0 +1,14 @@
+Hello {{username}}!
+
+Your hook.io account has exceeded {{monthlyLimit}} requests this month which is above the limits of your current {{servicePlan}} plan.
+
+Allowed Monthly Requests: {{monthlyLimit}}
+Current Service Plan: {{servicePlan}}
+
+In order to keep your services online we ask that you upgrade your account at: https://hook.io/pricing
+
## Open-Source Microservice Hosting Platform
### Build and deploy HTTP microservices in seconds
-To start using hook.io visit the website at [http://hook.io](http://hook.io). Here you will find many examples and documentation on how to use hook.io
-
-
-**Built with:** [Node.js](http://nodejs.org), [CouchDB](http://couchdb.com), and [Github Gist](http://gist.github.com). [Node Package Manager](http://npmjs.org) modules are fully supported.
+#### Supported Service Programming Languages
+
+ - c ( with `gcc` )
+ - java
+ - javascript ( first-class support )
+ - coffee-script
+ - common
+ - bash
+ - lua
+ - golang
+ - ocaml
+ - perl
+ - php
+ - python
+ - python3
+ - ruby
+ - rust
+ - r
+ - scheme
+ - smalltalk
+ - tcl
+
+To start using hook.io visit the website at [https://hook.io](https://hook.io). Here you will find many examples and documentation on how to use hook.io
Architectural details can be found a bit further down.
@@ -18,80 +37,53 @@ If you'd like, you can run the following Curl command to opt-in to our mailing l
Replace youremail@marak.com with your email address.
-## What is the purpose of hook.io?
+## Installing Local Hook.io Server
-hook.io is an open-source hosting platform for webhooks and microservices. The microservice architectural style is an approach to developing a single application as a suite of small services, each running in its own process and communicating with lightweight mechanisms. hook.io provides an easy way to create, host, and share microservices. Through developing many small re-usable microservices, you can reduce the complexity of your applications while improving stability.
+Before setting up a local hook.io server, you should try the free hosted version at [https://hook.io](https://hook.io)
+If you don't need a full hosting platform and only want to host microservices, we recommend using the [Microcule](https://github.com/stackvana/microcule) project.
+```bash
+git clone https://github.com/bigcompany/hook.io.git
+cd hook.io
+docker-compose build
+docker-compose up
+````
-## Why or how would I want to use hook.io?
+At this point you should be able to load hook.io locally at: `http://localhost:9999`
-You should want to use hook.io if it can make your life as a developer easier.
+## What is the purpose of hook.io?
+hook.io is an open-source hosting platform for webhooks and microservices. The microservice architectural style is an approach to developing a single application as a suite of small services, each running in its own process and communicating with lightweight mechanisms. hook.io provides an easy way to create, host, and share microservices. Through developing many small re-usable microservices, you can reduce the complexity of your applications while improving stability.
-The most *basic use-case* for hook.io is quick and free webhook hosting. You can instantly create a [simple hook](http://hook.io/Marak/echo) which parses the incoming parameters of an HTTP request and performs arbitrary actions on it. For instance: Send an SMS message every-time the Hook is requested as a webpage. Since NPM is supported, you can re-use any existing library from the extensive [NPM module repository](http://npmjs.org). You can also configure Hooks to be executed on a schedule using a [Cron pattern](http://hook.io/cron).
+## Why or how would I want to use hook.io?
+You should want to use hook.io if it can make your life as a developer easier.
+The most *basic use-case* for hook.io is quick and free webhook hosting. You can instantly create a [simple hook](https://hook.io/examples/echo) which parses the incoming parameters of an HTTP request and performs arbitrary actions on it. For instance: Send an SMS message every-time the Hook is requested as a webpage. Since NPM is supported, you can re-use any existing library from the extensive [NPM module repository](http://npmjs.org). You can also configure Hooks to be executed on a schedule using a [Cron pattern](https://hook.io/cron).
At this point, we will take note that Hooks are [fully streaming](https://github.com/substack/stream-handbook). Inside your Hook source code you have direct access to Node's [http.IncomingMessage](http://nodejs.org/api/http.html#http_http_incomingmessage) and [httpServer.ServerResponse](http://nodejs.org/api/http.html#http_class_http_serverresponse) request and response streams. This means you can treat the inside of a Hook the exact same way as if it were inside a streaming middleware in a regular node http server. Having direct access to these streams is extremely useful and I am unsure if any other microservice hosting providers currently offer this feature.
+More *advanced use-cases* for hook.io would be replacing individual parts of your application with microservices. Instead of adding a new route or module to your application , you could instead create a Hook responsible for only one unit of functionality and call it using a regular HTTP request from inside your existing application. One specific example could be building a Hook with a [custom theme](https://hook.io/themes) which acts perfectly as a stand-alone sign-up form. This sign-up form can then be loaded server-side in your application using one HTTP get request. It might sound complicated at first, but integrating microservices with your existing application is actually very easy. In the upcoming weeks we'll work on releasing specific guides for separating application functionalities into microservices.
-
-More *advanced use-cases* for hook.io would be replacing individual parts of your application with microservices. Instead of adding a new route or module to your application , you could instead create a Hook responsible for only one unit of functionality and call it using a regular HTTP request from inside your existing application. One specific example could be building a Hook with a [custom theme](http://hook.io/themes) which acts perfectly as a stand-alone sign-up form. This sign-up form can then be loaded server-side in your application using one HTTP get request. It might sound complicated at first, but integrating microservices with your existing application is actually very easy. In the upcoming weeks we'll work on releasing specific guides for separating application functionalities into microservices.
-
-
-
-An *even more advanced usage* would be building a suite of Hooks and composing them to create new and unique applications! Since every Hook understands Standard In and Standard Out and Hooks can [easily call other Hooks](http://hook.io/Marak/merge) from inside each other, there are an endless amount of combinations to be made. This composability enables the foundation for [Flow-based Programming](http://en.wikipedia.org/wiki/Flow-based_programming) without imposing any specific rules for composition. A specific example could be building a Hook ( called "tar" ) responsible for taking in STDIN and streaming out a compressed tar file. Once this Hook is created, you could easily pipe the results of another Hook ( such as an image downloader ) into the "tar" Hook. These Hooks don't exist yet, but I am certain someone will build them in the near future.
-
-
+An *even more advanced usage* would be building a suite of Hooks and composing them to create new and unique applications! Since every Hook understands Standard In and Standard Out and Hooks can [easily call other Hooks](https://hook.io/examples/javascript-stream-merge) from inside each other, there are an endless amount of combinations to be made. This composability enables the foundation for [Flow-based Programming](http://en.wikipedia.org/wiki/Flow-based_programming) without imposing any specific rules for composition. A specific example could be building a Hook ( called "tar" ) responsible for taking in STDIN and streaming out a compressed tar file. Once this Hook is created, you could easily pipe the results of another Hook ( such as an image downloader ) into the "tar" Hook. These Hooks don't exist yet, but I am certain someone will build them in the near future.
## Unix Pipes!
-hook.io is very friendly with Unix Pipes. Using STDOUT and STDIN you can connect hook.io to your existing Unix Tool chain. The best way to explain this concept is to review the [Curl examples](http://hook.io/curl).
-
-
-
-Here is one specific example of using hook.io to flip a cat upside-down with `cat` and `curl`. You will need to provide your own cat.png
-
-
-
-```
-cat cat.png | curl -F 'degrees=180' -F 'image=@-;type=image/png' http://hook.io/Marak/image/rotate > upsidedown-cat.png
-```
-
-
+hook.io is very friendly with Unix Pipes. Using STDOUT and STDIN you can connect hook.io to your existing Unix Tool chain. The best way to explain this concept is to review the [Curl examples](https://hook.io/curl).
## The Data!
If you noticed in the last example, hook.io is fully capable of streaming binary data. It also supports streaming file uploads, multipart form uploads, and will assist in parsing all incoming form fields, JSON, and query string data.
-
-
## Software Architecture
The core software architecture of hook.io is Resource-View-Presenter ( RVP ).
Resources are created using the npm [resource](http://npmjs.org/package/resource) module.
-View-Presenters are created using the npm [view](http://npmjs.org/package/view) module with regular HTML, CSS, and JavaScript. The same View-Presenter pattern is also used to implement custom theming for Hooks see: [hook.io/themes](http://hook.io/themes)
-
-
-## Dependency Tree
-
-hook.io itself is not a very large application. The majority of what powers hook.io is already MIT open-sourced and available for immediate download.
-
-Learning about the following dependencies is a great way to start understanding how hook.io works.
-
-[mschema](http://github.com/mschema/mschema) - Provides validation through-out the entire stack.
-
-[big](http://npmjs.org/package/big) - Small application framework. Provides [website](https://github.com/bigcompany/big/blob/master/apps/website/index.js) app which hook.io extends.
-
-[resource-http](http://github.com/bigcompany/http) - Provides core HTTP server API. Helps in configuring [Express](http://expressjs.com) with middlewares like [Passport](http://passportjs.org/)
-
-[resource-mesh](http://github.com/bigcompany/mesh) - Provides a distributed event emitter mesh using a [star network topography](http://en.wikipedia.org/wiki/Network_topology#Star). hook.io primarily uses this module as a monitoring agent to report status back to our monitoring [sink](https://github.com/bigcompany/big/blob/master/apps/sink/index.js).
-
-[resource-user](http://github.com/bigcompany/user) - Provides basic user API ( signups / logins / encrypted passwords / password resets / etc )
+View-Presenters are created using the npm [view](http://npmjs.org/package/view) module with regular HTML, CSS, and JavaScript. The same View-Presenter pattern is also used to implement custom theming for Hooks see: [hook.io/themes](https://hook.io/themes)
## Server Architecture
@@ -102,7 +94,7 @@ The front-facing server is responsible for serving static content, maintaining u
Workers are responsible for executing user-submitted source code and piping their responses through the front-facing server to the client.
-At this point, we will take note that communication between the Hook and client remains streaming throughout the entire architecture. This gives hook.io the ability to perform complex tasks like [transcoding large video streams](http://hook.io/Marak/transcodeVideo) without worrying about clogging up any parts of the system with large memory buffers.
+At this point, we will take note that communication between the Hook and client remains streaming throughout the entire architecture. This gives hook.io the ability to perform complex tasks like transcoding large video streams without worrying about clogging up any parts of the system with large memory buffers.
Hook Servers and Hook Workers are immutable and stateless to ensure stability of the platform. They are designed to fail fast and restart fast. [mon](http://github.com/tj/mon) is used as a process supervisor.
@@ -114,7 +106,7 @@ Source code for Hooks is currently stored on Github as Github Gists. I'd imagine
## Creating new Hooks
-It's very simple. Go to [http://hook.io/new](http://hook.io/new)
+It's very simple. Go to [https://hook.io/new](https://hook.io/new)
## Support
@@ -122,7 +114,7 @@ If you run into an issue, have a question, or have feedback with using hook.io y
## Adding new NPM Modules to hook.io
-The fastest way to get an additional NPM module added to the hook.io platform is to open up a Pull Request modifying [this file](https://github.com/bigcompany/hook.io/blob/master/modules/modules.js).
+NPM modules will automatically install if you attempt to require them in a Hook. The first time the Hook is run, hook.io will install the dependency. Re-run the hook a few moments later and it should just work.
If your module requires additional dependencies outside of what NPM can install, you can create a custom build script in [this folder](https://github.com/bigcompany/hook.io/tree/master/modules/builds). The hosting environment for hook.io is Ubuntu 14.04.1 LTS (Trusty Tahr) Bash scripts are recommended.
@@ -130,25 +122,22 @@ If your module requires additional dependencies outside of what NPM can install,
If you only need to test your Hook code, you can run `./bin/test-hook` without having to setup the full hook.io stack.
-## Setting up a private hook.io
-
-Before setting up a private hook.io server, you should try the free hosted version at [http://hook.io](http://hook.io)
-
-Setting up a private hook.io server is easy! You'll want to clone this repository, install the dependencies, and run the `start.sh` script. There currently are not detailed installation instructions and you will need to configure a few dependencies ( such as couchdb and github api ).
-
-If you want to run Hooks without any additional dependencies, try running `./bin/test-hook`.
-
## Workers
Hooks are executed on *stateless* isolated workers to help facilitate scaling and to ensure stability in the core application. These workers are responsible for running user-submitted Hook source code and piping their responses back to the main server. If running untrusted user-submitted code, you will need to isolate these workers.
see: `./bin/worker` and `./bin/test-worker`
-## User process isolation
+## i18n Internationalization
+
+[https://github.com/bigcompany/hook.io-i18n](https://github.com/bigcompany/hook.io-i18n)
-If you plan to run a hook.io server that allows user-submitted code, you will need to setup process isolation per user on every worker so that user-submitted Hooks will not potentially affect performance of other users or interact with parts of the system the user should not have permission to access.
-Docker is a great tool to start with.
+## Tests
+
+```bash
+npm test
+```
## Contributing
diff --git a/bin/cron b/bin/cron
deleted file mode 100644
index 32829745..00000000
--- a/bin/cron
+++ /dev/null
@@ -1,8 +0,0 @@
-var cron = require('../lib/resources/cron');
-
-cron.processAll(function(err, result){
- // wait 60 seconds and process again
- setTimeout(function(){
- process.exit(0);
- }, 60000)
-});
\ No newline at end of file
diff --git a/bin/crons/send-user-alerts b/bin/crons/send-user-alerts
new file mode 100644
index 00000000..3a89e1a2
--- /dev/null
+++ b/bin/crons/send-user-alerts
@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+var PAUSE_TIME = 60000;
+const alerts = require('../../lib/resources/alerts/alerts');
+
+alerts.sendAlerts({}, function(err, result){
+ console.log(err, result);
+ // TODO: set timeout
+ // wait 60 seconds and process again
+ setTimeout(function(){
+ // this script is intended to be run with a process monitor
+ // by calling process.exit, we close the script and let the process
+ // monitor restart the cron process
+ process.exit(0);
+ }, PAUSE_TIME);
+});
\ No newline at end of file
diff --git a/bin/docker/initialize b/bin/docker/initialize
new file mode 100755
index 00000000..c76bcb39
--- /dev/null
+++ b/bin/docker/initialize
@@ -0,0 +1,20 @@
+#!/bin/sh
+if [ ! -e "/src/.setup_done" ]
+then
+ echo "Creating admin..."
+ sh /src/config/couchdb/create_admin.sh
+ echo "Adding default users..."
+ /src/bin/docker/wait web -c node /src/scripts/install/add-default-users.js
+ echo "Adding default hooks..."
+ /src/bin/docker/wait web -c node /src/scripts/install/add-default-hooks.js
+ echo "Done adding default hooks..."
+ touch "/src/.setup_done"
+ echo
+ echo "================================================================"
+ echo " Load Balancer started locally: "
+ echo
+ echo " http://localhost:9999"
+ echo
+ echo
+ echo "================================================================"
+fi
diff --git a/bin/docker/wait b/bin/docker/wait
new file mode 100755
index 00000000..3e9a980c
--- /dev/null
+++ b/bin/docker/wait
@@ -0,0 +1,28 @@
+#!/bin/bash
+
+declare -A PORT
+PORT[redis]=6379
+PORT[couch]=5984
+PORT[balancer]=9999
+PORT[worker0]=10000
+PORT[web]=11000
+
+wait_for() {
+ local host=$1
+ local port=${PORT[$host]}
+
+ echo "Waiting for $host:$port..."
+ until $(nc -z $host $port); do
+ sleep 1
+ done
+}
+
+until [ "$1" == "-c" ]; do
+ wait_for $1
+ echo "$1 is up"
+ shift
+done
+
+shift
+echo "Executing $@"
+exec $@
diff --git a/bin/hpm-server b/bin/hpm-server
new file mode 100644
index 00000000..93efde95
--- /dev/null
+++ b/bin/hpm-server
@@ -0,0 +1,13 @@
+#!/usr/local/bin/node
+
+var hpm = require('hpm');
+
+hpm.onAny(function(data){
+ console.log('event');
+ console.log(this.event, data)
+});
+
+// TODO: move options to config
+hpm.server.start({ port: 8888, host: "localhost" }, function (err, app){
+ console.log(err, app.server.address())
+});
\ No newline at end of file
diff --git a/bin/npm-install b/bin/npm-install
new file mode 100755
index 00000000..bbdfbea6
--- /dev/null
+++ b/bin/npm-install
@@ -0,0 +1,26 @@
+#!/usr/local/bin/node
+
+// parse incoming command line arguments
+var argv = require('minimist')(process.argv.slice(2));
+
+if (typeof argv.p === "undefined" || argv.p.length === 0) {
+ console.log('Packages parameter required. Please pass in -p argument');
+ process.exit();
+}
+
+var packages;
+
+try {
+ packages = JSON.parse(argv.p);
+} catch (err) {
+ console.log('Invalid -p argument. Not JSON' + err.message);
+ process.exit();
+}
+
+var npm = require("../lib/resources/npm");
+
+npm.install("/Users/chroot/", { packages: packages }, function(err, res){
+ if (err) {
+ console.error(err.message)
+ }
+});
\ No newline at end of file
diff --git a/bin/server b/bin/server
deleted file mode 100644
index ef761c86..00000000
--- a/bin/server
+++ /dev/null
@@ -1,6 +0,0 @@
-var server = require('../lib/server');
-server.start({}, function(err){
- if (err) {
- throw err;
- }
-});
\ No newline at end of file
diff --git a/bin/services/broadcast b/bin/services/broadcast
new file mode 100755
index 00000000..bc0aecae
--- /dev/null
+++ b/bin/services/broadcast
@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+var broadcast = require('../../lib/broadcast/broadcast');
+broadcast.start({}, function (err, app) {
+ if (err) {
+ throw err;
+ }
+ console.log('web server started', app.server.address())
+});
\ No newline at end of file
diff --git a/bin/services/cron b/bin/services/cron
new file mode 100644
index 00000000..08b5a101
--- /dev/null
+++ b/bin/services/cron
@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+var cron = require('../../lib/resources/cron/cron');
+var PAUSE_TIME = 60000;
+
+cron.run(function(err, result){
+ if (err) {
+ throw err;
+ }
+ console.log('processed all crons', result)
+ // wait 60 seconds and process again
+ setTimeout(function(){
+ // this script is intended to be run with a process monitor
+ // by calling process.exit, we close the script and let the process
+ // monitor restart the cron process
+ process.exit(0);
+ }, PAUSE_TIME);
+});
\ No newline at end of file
diff --git a/bin/services/load-balancer b/bin/services/load-balancer
new file mode 100755
index 00000000..f2a9c971
--- /dev/null
+++ b/bin/services/load-balancer
@@ -0,0 +1,89 @@
+#!/usr/bin/env node
+var lb = require('../../lib/load-balancer/load-balancer');
+var cluster = require('cluster');
+var config = require('../../config');
+config.env = 'prod';
+if (config.env === 'dev') {
+ console.log('using dev mode, no cluster');
+ lb.start({}, function(err, app){
+ if (err) {
+ throw err;
+ }
+ console.log('lb started', app.server.address());
+ });
+} else {
+
+ // the master node is responsible for performing clustering logic
+ if (cluster.isMaster) {
+
+ // create a new worker for every available CPU
+ var numWorkers = require('os').cpus().length;
+
+ console.log('Master cluster setting up ' + numWorkers + ' workers...');
+
+ for(var i = 0; i < numWorkers; i++) {
+ cluster.fork();
+ }
+
+ cluster.on('exit', function (worker, code, signal) {
+ console.log('Worker ' + worker.process.pid + ' died with code: ' + code + ', and signal: ' + signal);
+ console.log('Starting a new worker');
+ // If the worker exited after disconnect, don't do anything. It should have already forked.
+ if (worker.exitedAfterDisconnect === true) {
+ console.log('exited after disconnect. probably performing rolling update');
+ } else {
+ // Else if the worker did not have disconnect event, assume it was a crash and fork() immediately
+ console.log('got exit event without disconnect, probably a process crash');
+ }
+ cluster.fork();
+ });
+
+ cluster.on('online', function(worker) {
+ console.log('Worker ' + worker.process.pid + ' is online');
+ worker.on('disconnect', function () {
+ var id = worker.id;
+ console.log('node got disconnect event', id);
+ // once disconnected, this node is no longer accepting incoming traffic from the cluster
+ // so immediately kill the worker node
+ worker.kill();
+ });
+
+ // message handler is used for worker to receieve messages from parent process
+ worker.on('message', function (message) {
+ if (message.event === 'restart') {
+ // disconnect one worker from the pool and wait
+ var workers = Object.keys(cluster.workers);
+ if (workers.length === 0) {
+ console.log('fatal error: cluster has exhausted all nodes');
+ return;
+ }
+ // performing rolling update here where we iterate through each stale node
+ var workerId = workers[0];
+ cluster.workers[workerId].disconnect();
+ }
+ if (message.event === 'query') {
+ var queryResponse = {};
+ for (var w in cluster.workers) {
+ queryResponse[w] = {
+ pid: cluster.workers[w].process.pid,
+ spawnfile: cluster.workers[w].process.spawnfile
+ };
+ // TODO: add uptime() or ctime
+ }
+ worker.send({ event: 'queryResponse', data: queryResponse });
+ }
+ });
+ });
+ cluster.on('listening', function (worker) {
+ console.log('Worker ' + worker.process.pid + ' is listening');
+ });
+ } else {
+ lb.start({}, function(err, app){
+ if (err) {
+ throw err;
+ }
+ // process.send({ event: 'load-balancer::listening' });
+ console.log('lb started', app.server.address());
+ });
+ }
+}
\ No newline at end of file
diff --git a/bin/services/microtail-front b/bin/services/microtail-front
new file mode 100644
index 00000000..1d6a26c0
--- /dev/null
+++ b/bin/services/microtail-front
@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+var colors = require('colors');
+var microtail = require('microtail');
+var path = require('path');
+var config = require('../../config');
+
+microtail.start({
+ http: {
+ port: 9980,
+ auth: {
+ basicAuth: config.tailAdmin
+ }
+ },
+ tails: [{
+ name: 'webserver logs',
+ path: path.resolve(__dirname + "/../../logs/web-logs.txt"),
+ lines: 10
+ },{
+ name: 'cron logs',
+ path: path.resolve(__dirname + "/../../logs/cron-logs.txt"),
+ lines: 10
+ },{
+ name: 'balancer logs',
+ path: path.resolve(__dirname + "/../../logs/balancer-logs.txt"),
+ lines: 10
+ }]
+}, function (err, app) {
+ if (err) {
+ console.log('microtail start error'.red);
+ throw err;
+ }
+ console.log('microtail server started'.blue, app.server());
+});
\ No newline at end of file
diff --git a/bin/services/microtail-workers b/bin/services/microtail-workers
new file mode 100644
index 00000000..bfdb632d
--- /dev/null
+++ b/bin/services/microtail-workers
@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+var colors = require('colors');
+var microtail = require('microtail');
+var path = require('path');
+
+microtail.start({
+ http: {
+ port: 9980,
+ auth: {
+ basicAuth: config.tailAdmin
+ }
+ },
+ tails: [{
+ name: 'worker logs',
+ path: path.resolve(__dirname + "/../../logs/worker-logs.txt"),
+ lines: 10
+ }]
+}, function (err, app) {
+ if (err) {
+ console.log('microtail start error'.red);
+ throw err;
+ }
+ console.log('microtail server started'.blue, app.server());
+});
\ No newline at end of file
diff --git a/bin/services/web b/bin/services/web
new file mode 100755
index 00000000..dc31e89f
--- /dev/null
+++ b/bin/services/web
@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+// front-facing web servers
+// currently handles static assets / views / and api endpoints
+var web = require('../../lib/web/web');
+web.start({}, function(err, app){
+ if (err) {
+ throw err;
+ }
+ console.log('web server started', app.server.address())
+});
\ No newline at end of file
diff --git a/bin/services/worker b/bin/services/worker
new file mode 100755
index 00000000..968a2c01
--- /dev/null
+++ b/bin/services/worker
@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+var colors = require('colors');
+var worker = require('../../lib/worker/worker');
+
+worker.start({}, function (err, app) {
+ if (err) {
+ console.log('worker error'.red);
+ throw err;
+ }
+ console.log('worker started'.blue, app.server.address());
+});
\ No newline at end of file
diff --git a/bin/test-hook b/bin/test-hook
deleted file mode 100644
index d1f9a17c..00000000
--- a/bin/test-hook
+++ /dev/null
@@ -1,46 +0,0 @@
-var hook = require('../lib/resources/hook');
-
-/*********************************************************/
- //
- // Put your hook code here
- //
-
- var exampleHook = function exampleHook (hook) {
- hook.res.end('Success!');
- }
-
-/*********************************************************/
- //
- // This code runs the hook locally
- //
-
- var http = require('resource-http');
- var request = require('request');
-
- http.listen({ port: 9999 }, function(err, app){
- app.get('/test', function(req, res){
- req.resource = {};
- // Set custom Hook.params here
- req.resource.params = {
- "foo": "bar"
- }
- req.hook = {};
- req.hook.env = {};
- hook.runUntrustedHook({ req: req, res: res, params: "format" } , exampleHook, function(err){
- if (err) {
- throw err;
- }
- });
- });
- request.get('http://localhost:9999/test', function(err, res, body){
- console.log(err, body);
- process.exit();
- });
- });
-
-/*********************************************************/
-
-//
-// TODO: move this code into a separate module
-// see: https://github.com/bigcompany/hook.io/issues/17
-//
\ No newline at end of file
diff --git a/bin/test-worker b/bin/test-worker
deleted file mode 100644
index 7329a56a..00000000
--- a/bin/test-worker
+++ /dev/null
@@ -1,12 +0,0 @@
-var request = require('hyperquest');
-var net = require('net');
-
-var http = require('http');
-
-var server = http.createServer(function(req, res){
- var _url = 'http://localhost:9999/runHook' + req.url;
- var stream = request.post(_url);
- req.pipe(stream).pipe(res);
-});
-
-server.listen(8888);
\ No newline at end of file
diff --git a/bin/worker b/bin/worker
deleted file mode 100644
index bda51ec2..00000000
--- a/bin/worker
+++ /dev/null
@@ -1,6 +0,0 @@
-var worker = require('../lib/worker');
-worker.start({}, function (err){
- if (err) {
- throw err;
- }
-});
\ No newline at end of file
diff --git a/config/couchdb/Dockerfile b/config/couchdb/Dockerfile
new file mode 100644
index 00000000..7292a6ff
--- /dev/null
+++ b/config/couchdb/Dockerfile
@@ -0,0 +1,3 @@
+FROM klaemo/couchdb
+
+COPY local.ini /usr/local/etc/couchdb/
diff --git a/config/couchdb/create_admin.sh b/config/couchdb/create_admin.sh
new file mode 100755
index 00000000..810bc1a4
--- /dev/null
+++ b/config/couchdb/create_admin.sh
@@ -0,0 +1,10 @@
+#!/bin/bash
+
+HOST=http://couch:5984
+
+curl -s -X PUT $HOST/_node/nonode@nohost/_config/admins/admin -d '"password"'
+curl -s -X PUT -u admin:password $HOST/_users
+curl -s -X PUT -u admin:password $HOST/_replicator
+curl -s -X PUT -u admin:password $HOST/_global_changes
+
+#curl -X PUT $HOST/_config/admins/admin -d '"password"'
diff --git a/config/dev/index.js b/config/dev/index.js
new file mode 100644
index 00000000..59e223eb
--- /dev/null
+++ b/config/dev/index.js
@@ -0,0 +1,183 @@
+const app = {
+ name: "hook.io",
+ // host: "https://hook.io",
+ url: "http://localhost:9999",
+ ws: "ws://localhost:9999",
+ //url: "https://hook.io",
+ domain: "localhost",
+ port: "9999",
+ logo: "http://localhost:9999/img/logo.png",
+ logoInverse: "http://localhost:9999/img/logo-inverse.png",
+ adminEmail: "hookmaster@hook.io"
+};
+
+const redis = {
+ port: 6379,
+ password: "password",
+ host: "0.0.0.0"
+};
+
+const couch = {
+ "username": "admin",
+ "password": "password",
+ "port": 5984,
+ "host": "0.0.0.0"
+};
+
+const cluster = {
+ registerWithLoadBalancer: true,
+ pools : {
+ // Note: All services will auto-port up based on the first available port after the starting port
+ // this allows us define ranges of ports of the elastic pool instead of pre-configuring the pool statically
+ web: [],
+ worker: [],
+ lb: []
+ }
+};
+
+const balancer = {
+ port: 9999,
+ host: "0.0.0.0",
+ https: false,
+ publicIP: "127.0.0.1",
+ roots: ["hookio", "0.0.0.0", "localhost", "hook.io", "www.hook.io", "couch"],
+ secret: "change secret",
+ redis: {
+ prefix: '/session/',
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ }
+};
+
+const broadcast = {
+ port: 9998,
+ host: "0.0.0.0",
+ https: false,
+ publicIP: "127.0.0.1",
+ roots: ["ws.hookio", "0.0.0.0", "localhost", "ws.hook.io"],
+ secret: "change secret",
+ redis: {
+ prefix: '/session/',
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ }
+};
+
+const web = {
+ port: 11000,
+ host: "app",
+ https: false,
+ registerWithLoadBalancer: cluster.registerWithLoadBalancer,
+ roots: ["hookio", "0.0.0.0", "localhost", "hook.io", "www.hook.io"],
+ secret: "change secret",
+ redis: {
+ prefix: '/session/',
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ }
+};
+
+const worker = {
+ host: '0.0.0.0',
+ startingPort: 10000,
+ registerWithLoadBalancer: cluster.registerWithLoadBalancer,
+ nproc: {
+ soft: 15000,
+ hard: 20000
+ },
+ //npmPath: __dirname + '/../../../../stackvana/microcule/' || "/Users/chroot/",
+ npmPath: "/var/chroot/root/microcule/",
+ publicIP: 'worker0',
+ chrootUser: 'worker',
+ useChroot: false,
+ useNSJAIL: false,
+ nsJailArgs: [ '-Mo', '--disable_clone_newnet', '--chroot', '/var/chroot/', '--user', '99999', '--group', '99999', '--rlimit_as', '9999', '--log', 'nsjail.log', '--rlimit_nproc', '1000' ,'--quiet', '--']
+};
+
+module['exports'] = {
+ usingDocker: true,
+ superadmin: {
+ "name": "superadmin",
+ "password": "footy",
+ "super_private_key": "1234"
+ },
+ tailAdmin: {
+ "username": "tails",
+ "password": "password"
+ },
+ // contains definitions for elastic server pools
+ pools : {
+ // Note: All services will auto-port up based on the first available port after the starting port
+ // this allows us define ranges of ports of the elastic pool instead of pre-configuring the pool statically
+ web: cluster.pools.web,
+ worker: cluster.pools.worker,
+ lb: cluster.pools.lb
+ },
+ web: web,
+ balancer: balancer,
+ broadcast: broadcast,
+ baseUrl: "http://localhost:9999",
+ couch: {
+ "database": "hook",
+ "type": "couch2",
+ "username": couch.username,
+ "password": couch.password,
+ "port": couch.port,
+ "host": couch.host
+ },
+ redisCache: {
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ },
+ redis: {
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ },
+ github: {
+ accessName: "",
+ accessToken: "",
+ // working github tokens are given
+ // these are dedicated for hook.io testing
+ // don't use these in production as they may be revoked and refeshed at anytime
+ CLIENT_ID: "321de11108ccdacf2279",
+ CLIENT_SECRET: "14ed41431983aaceef121d32f2f3f3087e0434ac",
+ OAUTH_CALLBACK: "http://localhost:9999/login/github/callback"
+ },
+ defaultTheme : "http://localhost:9999/themes/none/index.html", // should be https?
+ defaultPresenter : "http://localhost:9999/themes/none/index.js",
+ stripe: {
+ secretKey: "sk_test_ZXdJj4I3Db2iB9ZRm0gqyzDV",
+ publicKey: "pk_test_axAR0vF3Qam8zs09JE7t8ZIo"
+ },
+ email: {
+ "provider": "mock",
+ "api_user": "abc",
+ "api_key": "1234"
+ },
+ cacheView: false,
+ // tempDirectory: __dirname + "/../temp/",
+ tempDirectory: "/hook-temp/",
+ sslKeyDirectory: '/src/ssl/',
+ chrootDirectory: '/var/chroot',
+ //sslKeyDirectory: __dirname + '/../ssl/',
+ //chrootDirectory: '/Users/worker',
+ locales: {
+ locales: ['en', 'de']
+ },
+ worker: worker,
+ customDomains: false,
+ MAX_SERVICE_EXECUTIONS_PER_CYCLE: Infinity,
+ MAX_SERVICE_CONCURRENCY: 10,
+ UNTRUSTED_HOOK_TIMEOUT: 10000,
+ messages: {
+ childProcessSpawnError: require('../messages/childProcessSpawnError'),
+ serviceExecutionTimeout: require('../messages/serviceExecutionTimeout'),
+ unauthorizedRoleAccess: require('../messages/unauthorizedRoleAccess')
+ },
+ app: app
+};
diff --git a/config/docker/index.js b/config/docker/index.js
new file mode 100644
index 00000000..07268ad4
--- /dev/null
+++ b/config/docker/index.js
@@ -0,0 +1,183 @@
+const app = {
+ name: "hook.io",
+ // host: "https://hook.io",
+ url: "http://localhost:9999",
+ ws: "ws://localhost:9999",
+ //url: "https://hook.io",
+ domain: "localhost",
+ port: "9999",
+ logo: "http://localhost:9999/img/logo.png",
+ logoInverse: "http://localhost:9999/img/logo-inverse.png",
+ adminEmail: "hookmaster@hook.io"
+};
+
+const redis = {
+ port: 6379,
+ password: "password",
+ host: "redis"
+};
+
+const couch = {
+ "username": "admin",
+ "password": "password",
+ "port": 5984,
+ "host": "couch"
+};
+
+const cluster = {
+ registerWithLoadBalancer: true,
+ pools : {
+ // Note: All services will auto-port up based on the first available port after the starting port
+ // this allows us define ranges of ports of the elastic pool instead of pre-configuring the pool statically
+ web: [],
+ worker: [],
+ lb: []
+ }
+};
+
+const balancer = {
+ port: 9999,
+ host: "app",
+ https: false,
+ publicIP: "127.0.0.1",
+ roots: ["hookio", "0.0.0.0", "localhost", "hook.io", "www.hook.io", "couch"],
+ secret: "change secret",
+ redis: {
+ prefix: '/session/',
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ }
+};
+
+const broadcast = {
+ port: 9998,
+ host: "0.0.0.0",
+ https: false,
+ publicIP: "127.0.0.1",
+ roots: ["ws.hookio", "0.0.0.0", "localhost", "ws.hook.io"],
+ secret: "change secret",
+ redis: {
+ prefix: '/session/',
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ }
+};
+
+const web = {
+ port: 11000,
+ host: "app",
+ https: false,
+ registerWithLoadBalancer: cluster.registerWithLoadBalancer,
+ roots: ["hookio", "0.0.0.0", "localhost", "hook.io", "www.hook.io"],
+ secret: "change secret",
+ redis: {
+ prefix: '/session/',
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ }
+};
+
+const worker = {
+ host: 'worker0',
+ startingPort: 10000,
+ registerWithLoadBalancer: cluster.registerWithLoadBalancer,
+ nproc: {
+ soft: 15000,
+ hard: 20000
+ },
+ //npmPath: __dirname + '/../../../../stackvana/microcule/' || "/Users/chroot/",
+ npmPath: "/var/chroot/root/microcule/",
+ publicIP: 'worker0',
+ chrootUser: 'worker',
+ useChroot: false,
+ useNSJAIL: false,
+ nsJailArgs: [ '-Mo', '--disable_clone_newnet', '--chroot', '/var/chroot/', '--user', '99999', '--group', '99999', '--rlimit_as', '9999', '--log', 'nsjail.log', '--rlimit_nproc', '1000' ,'--quiet', '--']
+};
+
+module['exports'] = {
+ usingDocker: true,
+ superadmin: {
+ "name": "superadmin",
+ "password": "footy",
+ "super_private_key": "1234"
+ },
+ tailAdmin: {
+ "username": "tails",
+ "password": "password"
+ },
+ // contains definitions for elastic server pools
+ pools : {
+ // Note: All services will auto-port up based on the first available port after the starting port
+ // this allows us define ranges of ports of the elastic pool instead of pre-configuring the pool statically
+ web: cluster.pools.web,
+ worker: cluster.pools.worker,
+ lb: cluster.pools.lb
+ },
+ web: web,
+ balancer: balancer,
+ broadcast: broadcast,
+ baseUrl: "http://localhost:9999",
+ couch: {
+ "database": "hook",
+ "type": "couch2",
+ "username": couch.username,
+ "password": couch.password,
+ "port": couch.port,
+ "host": couch.host
+ },
+ redisCache: {
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ },
+ redis: {
+ port: redis.port,
+ password: redis.password,
+ host: redis.host
+ },
+ github: {
+ accessName: "",
+ accessToken: "",
+ // working github tokens are given
+ // these are dedicated for hook.io testing
+ // don't use these in production as they may be revoked and refeshed at anytime
+ CLIENT_ID: "321de11108ccdacf2279",
+ CLIENT_SECRET: "14ed41431983aaceef121d32f2f3f3087e0434ac",
+ OAUTH_CALLBACK: "http://localhost:9999/login/github/callback"
+ },
+ defaultTheme : "http://localhost:9999/themes/none/index.html", // should be https?
+ defaultPresenter : "http://localhost:9999/themes/none/index.js",
+ stripe: {
+ secretKey: "",
+ publicKey: ""
+ },
+ email: {
+ "provider": "mock",
+ "api_user": "abc",
+ "api_key": "1234"
+ },
+ cacheView: false,
+ // tempDirectory: __dirname + "/../temp/",
+ tempDirectory: "/hook-temp/",
+ sslKeyDirectory: '/src/ssl/',
+ chrootDirectory: '/var/chroot',
+ //sslKeyDirectory: __dirname + '/../ssl/',
+ //chrootDirectory: '/Users/worker',
+ locales: {
+ locales: ['en', 'de']
+ },
+ worker: worker,
+ customDomains: false,
+ MAX_SERVICE_EXECUTIONS_PER_CYCLE: Infinity,
+ MAX_SERVICE_CONCURRENCY: 10,
+ UNTRUSTED_HOOK_TIMEOUT: 10000,
+ messages: {
+ childProcessSpawnError: require('../messages/childProcessSpawnError'),
+ serviceExecutionTimeout: require('../messages/serviceExecutionTimeout'),
+ unauthorizedRoleAccess: require('../messages/unauthorizedRoleAccess')
+ },
+ app: app
+};
diff --git a/config/index.js b/config/index.js
index b8e4bbeb..6ebf0850 100644
--- a/config/index.js
+++ b/config/index.js
@@ -1,24 +1,15 @@
-module['exports'] = {
- site: {
- port: 9999,
- https: false
- },
- couch: {
- "database": "hook",
- "type": "couchdb",
- "username": "admin",
- "password": "password",
- "port": 5984,
- "host": "localhost"
- },
- github: {
- // working github tokens are given
- // these are dedicated for hook.io testing
- // don't use these in production as they may be revoked and refeshed at anytime
- CLIENT_ID: "321de11108ccdacf2279",
- CLIENT_SECRET: "14ed41431983aaceef121d32f2f3f3087e0434ac",
- OAUTH_CALLBACK: "http://localhost:9999/login/callback"
- },
- defaultTheme : "http://localhost:9999/themes/debug/index.html",
- defaultPresenter : "http://localhost:9999/themes/debug/index.js",
-};
\ No newline at end of file
+const isDocker = require('is-docker');
+
+if (isDocker()) {
+ module.exports = require('./docker');
+ module.exports.env = "docker";
+} else {
+ module.exports = require('./dev');
+ module.exports.env = "dev";
+ if (process.env['NODE_ENV'] === 'production') {
+ module.exports = require('./production');
+ module.exports.env = "production";
+ }
+}
+
+// console.log('Info: Using env: ' + module.exports.env);
\ No newline at end of file
diff --git a/config/messages/README.md b/config/messages/README.md
new file mode 100644
index 00000000..838e8d79
--- /dev/null
+++ b/config/messages/README.md
@@ -0,0 +1,5 @@
+This directory contains messages which may be presented to the user.
+
+These messages are configurable, so we can adjust the copy of certain messages without having to touch any sensitive code paths.
+
+This is also useful if you intend to white-label this project.
\ No newline at end of file
diff --git a/config/messages/childProcessSpawnError.js b/config/messages/childProcessSpawnError.js
new file mode 100644
index 00000000..f97ed513
--- /dev/null
+++ b/config/messages/childProcessSpawnError.js
@@ -0,0 +1,8 @@
+module['exports'] = function childProcessSpawnErrorMessage (args) {
+ // TODO: use a template instead of str concat
+ var str = '';
+ str += 'Error in spawning child process. Error code: 1\n';
+ str += 'We attempted to run the following command: \n\n'
+ str += args.join(" ");
+ return str;
+}
\ No newline at end of file
diff --git a/config/messages/serviceExecutionTimeout.js b/config/messages/serviceExecutionTimeout.js
new file mode 100644
index 00000000..583950d5
--- /dev/null
+++ b/config/messages/serviceExecutionTimeout.js
@@ -0,0 +1,12 @@
+module['exports'] = function serviceExecutionTimeoutMessage (seconds) {
+ // TODO: use a template instead of str concat
+ var str = '';
+ str += 'Timeout Limit Hit. Request Aborted! \n\nHook source code took more than ';
+ str += seconds;
+ str += ' complete.\n\n';
+ str += 'A delay of this long may indicate there is an error in the source code for the Hook. \n\n';
+ str += 'If there are no errors and the Hook requires more than ';
+ str += seconds;
+ str += ' seconds to execute, you can upgrade to a paid account to increase your timeout limits.';
+ return str;
+}
\ No newline at end of file
diff --git a/config/messages/unauthorizedRoleAccess.js b/config/messages/unauthorizedRoleAccess.js
new file mode 100644
index 00000000..ec67a593
--- /dev/null
+++ b/config/messages/unauthorizedRoleAccess.js
@@ -0,0 +1,55 @@
+var config;
+process.nextTick(function(){
+ config = require('../');
+});
+
+module['exports'] = function unauthorizedRoleAccess (req, role) {
+ // TODO: use a template instead of str concat
+ var str = '',
+ errorType = "unauthorized-role-access";
+
+ // if no session, create temporary session scope for anonymous user error
+ if (typeof req.session === 'undefined') {
+ req.session = {};
+ }
+
+ if (typeof req.session.user === "undefined") {
+ req.session.user = "anonymous";
+ }
+
+ if (typeof req.resource.params.hook_private_key !== "undefined") {
+ // if key was provided but the role check failed ( since it reached here ) show specific error message
+ str += "A role access check was attempted but failed with key " + '"' + req.resource.params.hook_private_key + '"\n\n';
+ errorType = "unauthorized-role-access";
+ //str += "Try again with a diffirent `hook_private_key` value?\n\n";
+ }
+
+ if (typeof req.resource.keyName !== "undefined") {
+ str += ('"' + req.resource.keyName + '" does not have the role "' + role + '" which is required to access "' + req._parsedUrl.pathname + '"');
+ } else {
+ str += ('"' + req.session.user + '" does not have the role "' + role + '" which is required to access "' + req._parsedUrl.pathname + '"');
+ }
+
+ if (req.session.user === "anonymous") {
+ str += "\n\nIf you are the owner of this resource try logging in at https://" + config.app.domain + "/login";
+ }
+
+ if (typeof req.resource.params.hook_private_key !== "undefined") {
+ // do nothing
+ } else {
+ // provide instructions to provide keys
+ str += "\n\nIf any access keys have been created you can provide a `hook_private_key` parameter to access this URL.";
+ }
+
+ if (req.jsonResponse === true) {
+ str = JSON.stringify({
+ error: true,
+ message: str,
+ user: req.session.user,
+ role: role,
+ type: errorType
+ });
+ }
+
+ return str;
+}
\ No newline at end of file
diff --git a/config/redis/redis.conf b/config/redis/redis.conf
new file mode 100644
index 00000000..02579403
--- /dev/null
+++ b/config/redis/redis.conf
@@ -0,0 +1,938 @@
+# Redis configuration file example
+
+# Note on units: when memory size is needed, it is possible to specify
+# it in the usual form of 1k 5GB 4M and so forth:
+#
+# 1k => 1000 bytes
+# 1kb => 1024 bytes
+# 1m => 1000000 bytes
+# 1mb => 1024*1024 bytes
+# 1g => 1000000000 bytes
+# 1gb => 1024*1024*1024 bytes
+#
+# units are case insensitive so 1GB 1Gb 1gB are all the same.
+
+################################## INCLUDES ###################################
+
+# Include one or more other config files here. This is useful if you
+# have a standard template that goes to all Redis servers but also need
+# to customize a few per-server settings. Include files can include
+# other files, so use this wisely.
+#
+# Notice option "include" won't be rewritten by command "CONFIG REWRITE"
+# from admin or Redis Sentinel. Since Redis always uses the last processed
+# line as value of a configuration directive, you'd better put includes
+# at the beginning of this file to avoid overwriting config change at runtime.
+#
+# If instead you are interested in using includes to override configuration
+# options, it is better to use include as the last line.
+#
+# include /path/to/local.conf
+# include /path/to/other.conf
+
+################################ GENERAL #####################################
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /usr/local/var/run/redis.pid when daemonized.
+daemonize yes
+
+# When running daemonized, Redis writes a pid file in /usr/local/var/run/redis.pid by
+# default. You can specify a custom pid file location here.
+pidfile /usr/local/var/run/redis.pid
+
+# Accept connections on the specified port, default is 6379.
+# If port 0 is specified Redis will not listen on a TCP socket.
+port 6379
+
+# TCP listen() backlog.
+#
+# In high requests-per-second environments you need an high backlog in order
+# to avoid slow clients connections issues. Note that the Linux kernel
+# will silently truncate it to the value of /proc/sys/net/core/somaxconn so
+# make sure to raise both the value of somaxconn and tcp_max_syn_backlog
+# in order to get the desired effect.
+tcp-backlog 511
+
+# By default Redis listens for connections from all the network interfaces
+# available on the server. It is possible to listen to just one or multiple
+# interfaces using the "bind" configuration directive, followed by one or
+# more IP addresses.
+#
+# Examples:
+#
+# bind 192.168.1.100 10.0.0.1
+# bind 127.0.0.1
+
+# Specify the path for the Unix socket that will be used to listen for
+# incoming connections. There is no default, so Redis will not listen
+# on a unix socket when not specified.
+#
+# unixsocket /tmp/redis.sock
+# unixsocketperm 700
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 0
+
+# TCP keepalive.
+#
+# If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence
+# of communication. This is useful for two reasons:
+#
+# 1) Detect dead peers.
+# 2) Take the connection alive from the point of view of network
+# equipment in the middle.
+#
+# On Linux, the specified value (in seconds) is the period used to send ACKs.
+# Note that to close the connection the double of the time is needed.
+# On other kernels the period depends on the kernel configuration.
+#
+# A reasonable value for this option is 60 seconds.
+tcp-keepalive 0
+
+# Specify the server verbosity level.
+# This can be one of:
+# debug (a lot of information, useful for development/testing)
+# verbose (many rarely useful info, but not a mess like the debug level)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel notice
+
+# Specify the log file name. Also the empty string can be used to force
+# Redis to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile ""
+
+# To enable logging to the system logger, just set 'syslog-enabled' to yes,
+# and optionally update the other syslog parameters to suit your needs.
+# syslog-enabled no
+
+# Specify the syslog identity.
+# syslog-ident redis
+
+# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
+# syslog-facility local0
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT