Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 1.77 KB

README.md

File metadata and controls

73 lines (49 loc) · 1.77 KB
Raw

SPUL Connector

SPUL connector for splitting spul buffers into binary payloads and forwarding it to ConCaVa.

Documentation

The project documentation is hosted on http://kukua.github.io/concava-connector-spul/.

Installation

The SPUL connector can be run as a NodeJS program or in a Docker container.

Make sure ConCaVa is setup as well. See .env.example for the default configuration.

NodeJS

git clone https://github.com/kukua/concava-connector-spul.git
cd concava-connector-spul
cp .env.example .env
chmod 600 .env
# > Edit .env

npm install
npm run compile
source .env
npm start

Tested with NodeJS v5.1

Multitenancy

To allow spul to send data to multiple concava instances, provide the CONCAVA_INSTANCES_PATH as a .json file in the .env. This file should be like the concava-instances.example.json file.

Docker

First, install Docker. Then run:

curl https://raw.githubusercontent.com/kukua/concava-connector-spul/master/.env.example > .env
chmod 600 .env
# > Edit .env

docker run -d -p 3333:3333 -p 5555:5555 \
	-v ./spul.log:/tmp/output.log
	--env-file .env --name spul_connector \
	kukuadev/concava-connector-spul

Tested with Docker v1.9.

Test

Make sure a SPUL container is running with the name 'spul_connector'. Then run:

source .env
npm test
docker logs spul_connector

Contribute

Your help and feedback are highly appreciated!

License

This software is licensed under the MIT license.

© 2016 Kukua BV