neotropic/kuwaiba repository overview

⁠Pull

For nightly builds (which are not really generated nightly, but at least quite often), use:

docker pull neotropic/kuwaiba:v2.1-nightly

⁠Run

⁠Starting the Container

The container exposes 2 ports: 8080 (application) and 8081 (SOAP-based web service). You can use the following command to run the container and map those ports to the host machine.

docker run -dp 8080-8081:8080-8081 --name kuwaiba-server neotropic/kuwaiba:v2.1-nightly

Now it's possible to access the application by going to http://localhost:8080/kuwaiba⁠, or to access the SOAP-based web service API WSDL at http://localhost:8081/kuwaiba/KuwaibaService?wsdl⁠.

⁠Using a Custom Database

To avoid losing information across containers when you update an image, you can mount a custom database (thus overriding the stock one) located in your host machine and reuse it in different containers:

docker run -dp 8080-8081:8080-8081 --name kuwaiba-server -v /path/to/your/custom/database:/data/db/kuwaiba.db neotropic/kuwaiba:v2.1-nightly

Make sure the user used to run the container has write access on /path/to/your/custom/database. You can download empty or sample databases from the Sourceforge repository⁠.

⁠Misc Info

• Default Application Credentials: admin/kuwaiba. There are several other users used to showcase the Process Manager capabilities. You can check them in the User Manager module. Their passwords are also kuwaiba.
• Data Directory: /data
• Application Directory: /opt/programs

⁠Process Manager

The Process Manager is a fully functional module that hasn't been completely documented yet. It aims to enable Kuwaiba to design and orchestrate business processes not necessarily inside the very network inventory. Using the Process Editor (a part of the Process Manager), you design processes using BPMN, define the activities inside each step of the process, the actors involved in the process and code the business logic associated to each step. You can then start the process and hand each action to its respective actor. The version included in these images contains a couple process definitions as sample. As the user procmanager (password: kuwaiba), you can perform any activity in any process. You login, open the Process Manager (under the Services menu category -the little stacked blocks icon-), select a process (try Equipment Purchase, because Service Feasibility is intended to show how to interact with third-party applications) and click on the only existing instance. That will open another tab with the BPMN diagram. Clicking on each activity will show you a form. That sample process is already completed, but you can create your own to play around with it. A complete series of video tutorials is expected to be released with specific details.

⁠Outside Plant Module

This module is a huge improvement from the previous version, mostly proof of concept, module. To display the maps, several providers are supported. This container, though, is shipped only with Google Maps. GMaps requires an API key in order to display the maps without the "development-only" watermark. To set the API key, just go to the Configuration Variables module and set the general.maps.apiKey to a valid value.

⁠Generate your own image

• Fetch the Dockerfile from the project repository⁠ on SourceForge. Alternatively, you can also download the docker compose file from the same repository⁠
• Customize the Dockerfile depending on your needs.
• Build the image with:

docker build -t REPOSITORY_NAME:TAG .

where REPOSITORY_NAME is the name of the repository where the image will be placed and TAG is the tag for such container. Instead, you can also use the docker compose file like this:

docker compose -f kuwaiba.yaml up