fh-ditch-alpha

fh-ditch(1) -- The FeedHenry Data In The Cloud Hooks

DESCRIPTION

The Ditch Server is a FeedHenry API Service which allows access to a storage system for apps. The system initially provides basic CRUD functionally. Each app, will only have access to it's own database, and will specify which collection to operate upon. The data will be stored in a MongoDB database

Dependencies

Messaging currently relies on the following being installed on a host:

• node.js

• npm (the Node Package Manager)

Ditch also relies on access to a Mongo Database running either locally or remotely.

Installation

Ditch is deployed using npm. The Ditch Package (fh-ditch-.tar.gz) can be installed via npm, either by copying the package to the local host or installing over http.

To install (on ubuntu):

sudo npm install fh-ditch-.tar.gz

The necessary node dependency modules are also installed automatically.

You can upgrade an existing intallation with the same command.

Running and Configuration

To run the Message Server you must pass a config file on the command line. For a sample configuration file, see 'dev.json' in the config directory.

E.g: fh-ditch /etc/feedhenry/fh-ditch/conf.json

Upstart

Create a file called 'fh-ditch.conf' in the /etc/init directory, and put in the following:

pre-start script
    mkdir -p /var/log/feedhenry/fh-ditch/
end script

description "FeedHenry Ditch Server"
author  "FeedHenry Ltd"

start on (local-filesystems and net-device-up IFACE=eth0)
stop on shutdown

respawn

exec sudo fh-ditch /etc/feedhenry/fh-ditch/conf.json >> /log/feedhenry/fh-ditch/fh-ditch.log 2>&1

The fh-ditch server can then be started/stopped with sudo start fh-ditch sudo stop fh-ditch

Documentation

Documentation of the API of the Ditch Server is located in the doc/api.txt file.