Skip to content

gitter-badger/fiware-cepheus

 
 

Repository files navigation

FIWARE Cepheus

Build Status Coverity Scan Status Coverage Status Docs Status GNU GPL Version 2 Licence

This is the code repository for the Fiware-Cepheus project.

This project is part of FIWARE under the Gateway Data Handling GE subproject. Check also the FIWARE Catalogue entry for Cepheus

Renaming

The previous name of the project was "EspR4FastData". It was renamed to a more generic name (using the convention of other FIWARE Generic Enablers).

Overall description

Fiware-Cepheus provides NGSI-compatible gateway level components. This project contains two Spring Boot applications and a common library :

  • cepheus-cep: A CEP (Complex Event Processor) engine.
  • cepheus-broker: A light broker (NGSI forwarding-only).
  • cepheus-ngsi : a client/server NGSI library.

Quick instructions

You can find the complete build and installation instructions for each components in the administrator guide here.

Requirements

  • JAVA 8
  • Maven 2 (for build)

Build via Maven

git clone https://github.com/Orange-OpenSource/fiware-cepheus.git
cd fiware-cepheus
mvn clean install

Installing from Docker

Using Docker is the fastest way to have a working setup :

docker pull orangeopensource/fiware-cepheus

Our docker manual can be found here

Installing from Debian packaging

Using mvn install will create two debian packages: cepheus-cep-{version}.deb and cepeheus-lb-{version}.deb. Then you can install these packages lauching :

dpkg -i cepheus-cep-{version}.deb
dpkg -i cepheus-broker-{version}.deb

Running

The project provides two SpringBoot applications. You can run them simply with:

java -jar cepheus-cep.jar
java -jar cepheus-broker.jar

User & programming guide

The user & programming guide can be found under the /doc folder. It is also available though readthedocs.org: User guide

Administrator manual

The administrator manual can be found under the /doc/admin folder. It is also available though readthedocs.org: Administrator manual

Examples

Some simple examples to learn how to use Cepheus-CEP and Cepheus-Broker can be found under the doc/examples folder.

License

FIWARE Cepheus is licensed under the GNU General Public License Version 2.

Support

Ask your programming questions using stackoverflow and your general questions on FIWARE Q&A. In both cases please use the tag fiware-cepheus.

Packages

No packages published

Languages

  • Java 98.7%
  • Shell 1.3%