Getting Started

There are a couple ways of getting started. It depends on what you want to do, or what stage you are at. 

Setting up and starting the service:

Use (See architecture)If you would like:
Maven Deployment
  • Develop Kagura itself
  • Test the capabilities
  • Fork Kagura
War Deployment
  • Setup a demo site
  • Prepared reports needing a host
  • Small mostly static deployment
Karaf Deployment
  • To integrate into an existing OSGI container and processes
  • Larger scale deployment
  • Simple deployment and configuration process
Maven Redeployment
  • To develop reports and repackage a Karaf deployment
  • Integrate into a CI pipeline
  • Karaf deployment but with customized Karaf assembly
  • Avoid recompiling
As a Library
  • To integrate Kagura into your existing framework
  • To use kagura as backend for another system

You will need to setup users if you haven't changed the Authentication method from File Authentication Provider:

After you get a container started, see the guides below regarding building reports:

Or you can just use a template: