Getting Started

• What Is Kuwaiba?
• Enterprise Support
• Docker images
• Build & Run
  • Get the code
  • Build the Dependencies
  • Optional Steps
  • Build Web Client Module
• License

What Is Kuwaiba?

Kuwaiba is the first and only open source, enterprise-grade network inventory system for the telecommunications industry. The following links will useful be in your path to exploring Kuwaiba:

• Admin and User manuals.
• Discord channel.
• Misc tutorials.

Enterprise Support

Neotropic is behind the development of Kuwaiba. Check out their site if you are interested in deploying it in your organization, or if you want to become a partner as a system integrator.

Docker images

The easies way to try Kuwaiba is to launch one of the Docker images available at Docker Hub.

Build & Run

Get the code

git clone https://git.code.sf.net/p/kuwaiba/server kuwaiba-server

Build the Dependencies

Some dependencies (mostly in-house made Vaadin Flow add-ons) are not available on the central Maven repository.

• Ace Editor Component for Vaadin Flow git clone https://github.com/NeotropicSAS/ace-editor-for-vaadin-flow.git
• Google Maps Component for Vaadin Flow git clone https://github.com/NeotropicSAS/gmaps-for-vaadin-flow.git
• Mx Graph Component for Vaadin Flow git clone https://github.com/NeotropicSAS/mxgraph-for-vaadin-flow.git
• Google Charts Component for Vaadin Flow git clone https://github.com/NeotropicSAS/gcharts-for-vaadin-flow.git
• Paper Dialog Component for Vaadin Flow git clone https://github.com/NeotropicSAS/paper-dialog-for-vaadin-flow.git
• Paper Toggle Button Component for Vaadin Flow git clone https://github.com/NeotropicSAS/paper-toggle-button-for-vaadin-flow.git
• OpenLayers Component for Vaadin Flow git clone https://github.com/NeotropicSAS/olmap-for-vaadin-flow.git
• Color Picker Component for Vaadin Flow git clone https://github.com/NeotropicSAS/color-picker-for-vaadin-flow.git
• X6 Component for Vaadin Flow git clone https://github.com/NeotropicSAS/x6-for-vaadin-flow.git

Optional Steps

• Open webclient/src/main/resources/application.properties and set the variable db.path to the path where your database will be located. See the Administrator's Manual for details.

Build Web Client Module

mvn -f kuwaiba/server/ --no-transfer-progress clean install

mvn --also-make --projects webclient -f kuwaiba/server/ -Pproduction --no-transfer-progress install

License

This software is dual-licensed APLv2 and GPLv3, choose the one that fits your purposes, but keep in mind that we ship third-party libraries whose licenses are only compatible with GPL.

This software is provided “AS IS”, with no warranty at all. Install it and use it at your own risk.