Merge pull request buddycloud#188 from buddycloud/docker

Add docker support. Merging with honour.

Author: Simon Tennant

.gitignore

@@ -1,6 +1,8 @@
 node_modules/
 config.js
+!contrib/docker/config.js
 .project
 .settings
 .DS_Store
 public/scripts/buddycloud.js
+npm-debug.log

Dockerfile

@@ -9,13 +9,16 @@ MAINTAINER Lloyd Watkin <lloyd@evilprofessor.co.uk>
 
 EXPOSE 9123
 
-ENV NODE_ENV production
+ENV NODE_ENV $NODE_ENV
 
 RUN apt-get update
 RUN apt-get upgrade -y
 RUN apt-get install -y git git-core libicu-dev libexpat-dev build-essential libssl-dev build-essential g++
 
 RUN git clone https://github.com/buddycloud/buddycloud-http-api.git api-server
-RUN cd api-server && npm i .
-RUN cd api-server && cp contrib/docker/config.js .
-CMD cd api-server && npm start
+RUN cd api-server && git checkout docker
+RUN cd api-server && npm i . && cp contrib/docker/config.js .
+ADD contrib/docker/start.sh /data/
+
+RUN chmod +x start.sh
+CMD ./start.sh

README.md

@@ -22,6 +22,29 @@ which you can instantiate to give you a websocket connection.
 
 Please see [buddycloud.com](http://www.buddycloud.com) for more information on using this connection.
 
+## Docker
+
+There is a docker image available for the API server. Configuration is currently passed via environment variables:
+
+|      Configuration     	|          Example         	|                                             Description                                             	| Required or default 	|
+|:----------------------:	|:------------------------:	|:---------------------------------------------------------------------------------------------------:	|:-------------------:	|
+| XMPP_DOMAIN            	| buddycloud.org           	| The XMPP domain for your server                                                                     	| ✓                   	|
+| XMPP_HOST              	| 192.168.0.55             	| The hostname or IP of your XMPP server                                                                        	| ✓                   	|
+| CHANNEL_COMPONENT      	| channels.buddycloud.org  	| The channel server component address                                                                	| ✓                   	|
+| ANONYMOUS_COMPONENT    	| anon.buddycloud.org      	| An 'anonymous' component which can be used for open nodes                                           	| null                	|
+| MEDIA_ENDPOINT         	| http://192.168.0.56:9000 	| The endpoint for a [media server](https://github.com/buddycloud/buddycloud-media-server)            	| null                	|
+| PUSHER_COMPONENT       	| pusher.buddycloud.org    	| The location of a [pusher component](https://github.com/buddycloud/buddycloud-pusher)               	| null                	|
+| FRIENDFINDER_COMPONENT 	| finder.buddycloud.org    	| The location of a [friend finder component](https://github.com/buddycloud/buddycloud-friend-finder) 	| null                	|
+| SEARCH_COMPONENT       	| search.buddycloud.org    	| The location of a [search component](https://github.com/buddycloud/channel-directory)               	| null                	|
+| DISABLE_WEBSOCKET      	| 0                        	| Whether to disable the [XMPP-FTW](https://xmpp-ftw.jit.su) endpoint                                 	| false               	|
+| DEBUG                  	| 1                        	| Whether to write additional debug to the logs                                                       	| false               	|
+
+Then simply launch the API server with the required environment variables as follows:
+
+```bash
+docker run -d -p 9123:9123 -e ..... buddycloud/api-server
+```
+
 ## Issues
 
 Please log any issues at https://github.com/buddycloud/buddycloud-http-api/issues

config.js.example

@@ -19,6 +19,9 @@
 exports._ = {
   // This is the port that your webserver's reverse proxy will forward requests to
   port: 9123,
+  
+  // Whether to disable the xmpp-ftw endpoint
+  disableWebsocket: false
 };
 
 // Production settings

contrib/docker/config.js

@@ -0,0 +1,29 @@
+exports._ = {
+  // This is the port that your webserver's reverse proxy will forward requests to
+  port: 9123,
+};
+
+if (!process.env.XMPP_DOMAIN) {
+    throw new Error('Missing XMPP domain')
+}
+if (!process.env.XMPP_HOST) {
+    throw new Error('Missing XMPP host')
+}
+if (!process.env.CHANNEL_COMPONENT) {
+    throw new Error('Missing channel server component')
+}
+
+// Production settings
+exports.production = {
+  debug: process.env.DEBUG || false,
+  xmppDomain: process.env.XMPP_DOMAIN,
+  xmppHost: process.env.XMPP_HOST,
+  xmppAnonymousDomain: process.env.ANONYMOUS_COMPONENT,
+  channelDomain: process.env.CHANNEL_COMPONENT,
+  pusherComponent: process.env.PUSHER_COMPONENT,
+  friendFinderComponent: process.env.FRIENDFINDER_COMPONENT,
+  searchComponent: process.env.SEARCH_COMPONENT,
+  homeMediaRoot: process.env.MEDIA_ENDPOINT,
+  createUserOnSessionCreation: true,
+  disableWebsocket: (typeof process.env.DISABLE_WEBSOCKET !== 'undefined') ? process.env.DISABLE_WEBSOCKET : false
+}

contrib/docker/start.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+cd api-server
+npm start

package.json

@@ -18,7 +18,6 @@
     "ltx": "~0.3.0",
     "node-expat": "~2.0.0",
     "jwt-simple": "0.1.x",
-    "iso8601": "1.1.1",
     "pubcontrol": "0.3.1",
     "grip": "0.1.4",
     "segfault-handler": "git+https://github.com/ddopson/node-segfault-handler.git",

src/content_feed.js

@@ -18,7 +18,6 @@
 // Handles requests related to channel node feeds
 // (/<channel>/content/<node>).
 
-var iso8601 = require('iso8601');
 var ltx = require('ltx');
 var api = require('./util/api');
 var atom = require('./util/atom');
@@ -73,8 +72,8 @@ function getNodeFeedNext(req, res) {
       var prevId = null;
       if (req.query.since_post && req.query.since_time) {
         var since_post = req.query.since_post;
-        var since_time = Math.floor(iso8601.toDate(req.query.since_time).getTime() / 1000) * 1000;
-        logger.debug("since_post=" + since_post + "&since_time=" + iso8601.fromDate(new Date(since_time)) + " (" + since_time + ")");
+        var since_time = Math.floor(Date.parse(req.query.since_time).getTime() / 1000) * 1000;
+        logger.debug("since_post=" + since_post + "&since_time=" + new Date(since_time).toISOString() + " (" + since_time + ")");
         var start = null;
         if (sub.items !== undefined) {
           for (var i = sub.items.length - 1; i >= 0; --i) {

src/util/session.js

@@ -19,7 +19,6 @@
 
 var Client = require('node-xmpp-client')
   , http = require('http')
-  , iso8601 = require('iso8601')
   , jwt = require('jwt-simple')
   , api = require('./api')
   , cache = require('./cache')