• Maintained by:
  Bonitasoft Community

• Where to get help:
  Bonita official documentation, StackOverflow, Bonitasoft Community forum

• 2022.2-u0, 2022.2, 7.15.0, 7.15

• 2023.1-u0, 2023.1, 8.0.0, 8.0

• 2023.2-u0, 2023.2, 9.0.0, 9.0, latest

• Where to file issues:
  Jira

• Supported architectures: (more info)
  amd64, arm64v8, ppc64le

• Published image artifact details:
  repo-info repo's repos/bonita/ directory (history)
  (image metadata, transfer size, etc)

• Image updates:
  official-images repo's library/bonita label
  official-images repo's library/bonita file (history)

• Source of this description:
  docs repo's bonita/ directory (history)

Bonita is an open-source business process management and workflow suite created in 2001. It was started in France National Institute for Research in Computer Science, and then had incubated several years inside the French computer science company Groupe Bull. Since 2009, the development of Bonita is supported by a company dedicated to this activity: Bonitasoft.

wikipedia.org/wiki/Bonita_BPM

$ docker run --name bonita -d -p 8080:8080 bonita

This will start a container running Bonita runtime: a Tomcat bundle with Bonita Engine + Bonita Portal. With no environment variables specified, it's as if you have launched the bundle on your host using startup.{sh|bat} (with security hardening on REST and HTTP APIs, cf Security part). Bonita uses a H2 database here.

You can access the Bonita Portal on http://localhost:8080/bonita and login using the default credentials: install / install

The H2 database allows the Bonita container to work out of the box, but it is not recommended outside a development environment.

As PostgreSQL is the recommended database for qualification and production environments, follow one of these next sections to configure your Bonita container to run on PostgreSQL database. You can work with either a PostgreSQL Container, or PostgreSQL as an installed service.

From Bonita 2022.1 onwards, the Bonita docker image does not include configuration scripts to automatically create databases and users anymore.

Therefore the PostgreSQL container needs to be configured to work with Bonita before starting the Bonita container. The configuration of a PostgreSQL database to work with Bonita is described in details in the database configuration page. + Alternatively, Bonita provides a preconfigured PostgreSQL image on docker-hub. + You can run the image with the following command:

docker run --name mydbpostgres -h <hostname> -d bonitasoft/bonita-postgres:12.6

This image is built from the following GitHub repository, which can be further adapted/customized to suit your needs.

Example docker-compose.yml for bonita:

version: '3'

services:
  db:
    image: bonitasoft/bonita-postgres:12.6
    environment:
      POSTGRES_PASSWORD: example
    restart: always
    command:
      - -c
      - max_prepared_transactions=100
  bonita:
    image: bonita:7.14.0
    hostname: custom-hostname.example.com
    ports:
      - 8080:8080
    environment:
      - DB_VENDOR=postgres
      - DB_HOST=db
      - DB_PORT=5432
      - DB_NAME=bonita
      - DB_USER=bonita
      - DB_PASS=bpm
      - BIZ_DB_NAME=business_data
      - BIZ_DB_USER=business_data
      - BIZ_DB_PASS=bpm
      - TENANT_LOGIN=tech_user
      - TENANT_PASSWORD=secret
      - PLATFORM_LOGIN=pfadmin
      - PLATFORM_PASSWORD=pfsecret
    restart: on-failure:2
    depends_on:
      - db
    entrypoint:
      - bash
      - -c
      - |
        set -e
        echo 'Waiting for PostgreSQL to be available'
        maxTries=10
        while [ "$$maxTries" -gt 0 ] && [ $$(echo 'QUIT' | nc -w 1 "$$DB_HOST" 5432; echo "$$?") -gt 0 ]; do
            sleep 1
            let maxTries--
        done
        if [ "$$maxTries" -le 0 ]; then
            echo >&2 'error: unable to contact Postgres after 10 tries'
            exit 1
        fi
        exec /opt/files/startup.sh /opt/bonita/server/bin/catalina.sh run

Run docker stack deploy -c stack.yml bonita (or docker-compose -f stack.yml up), wait for it to initialize completely, and visit http://swarm-ip:8080, http://localhost:8080, or http://host-ip:8080 (as appropriate).

• Replace <hostname> with the one used in the licence generation command
• leave double $$ untouched

If you don't want to run your database in a docker container, the following env.txt file needs to be configured and provided to the docker run command:

DB_VENDOR=postgres
DB_HOST=172.17.0.2
DB_PORT=5432
DB_NAME=custombonitadb
DB_USER=custombonitauser
DB_PASS=custombonitapass
BIZ_DB_NAME=custombusinessdb
BIZ_DB_USER=custombusinessuser
BIZ_DB_PASS=custombusinesspass

docker run --name=bonita -h <hostname> --env-file=env.txt -d -p 8080:8080 bonita

docker run --name=bonita -h <hostname> -e "TENANT_LOGIN=tech_user" -e "TENANT_PASSWORD=secret" -e "PLATFORM_LOGIN=pfadmin" -e "PLATFORM_PASSWORD=pfsecret" -d -p 8080:8080 bonita

Now you can access the Bonita Runtime on localhost:8080/bonita and login using: tech_user / secret

Bonita uses tomcat that writes file to a working directory and a temp directory.

It can be a good practice to mount the following folders into volumes

• /opt/bonita/server/temp
• /opt/bonita/server/work

When you start the bonita image, you can adjust the configuration of the Bonita instance by passing one or more environment variables on the docker run command line.

This optional environment variable is used in conjunction with PLATFORM_PASSWORD to define the username for the platform administrator. If it is not specified, the default username platformAdmin will be used.

This environment variable is recommended for you to use the Bonita image. It sets the platform administrator password for Bonita. If it is not specified, the default password platform will be used.

This optional environment variable is used in conjunction with TENANT_PASSWORD to define the username for the tenant administrator. If it is not specified, the default username install will be used.

This environment variable is recommended for you to use the Bonita image. It sets the tenant administrator password for Bonita. If it is not specified, the default password install will be used.

This optional environment variable is used in conjunction with MONITORING_PASSWORD to define the access to endpoints protected with BASIC Auth access: it is used for the JMX remote access. If it is not specified, the default monitoring username monitoring will be used.

This optional environment variable is used in conjunction with MONITORING_USERNAME to define the access to endpoints protected with BASIC Auth access: it is used for the JMX remote access. If it is not specified, the default monitoring password mon1tor1ng_adm1n will be used.

This optional environment variable is used to enable/disable the Bonita HTTP API. The default value is false, which will deactivate the HTTP API. From Bonita 2022.1, HTTP API is protected with Basic access authentication. See the following 2 parameters to configure Basic access authentication.

This optional environment variable is used to configure the HTTP API Basic access authentication username. The default value is http-api.

This optional environment variable is used to configure the HTTP API Basic access authentication password. There is no default value, and providing a value is mandatory if HTTP_API=true.

This optional environment variable is used to enable/disable the access to the JMX console from a remote machine. + Default value is false. + The host to connect to is the name / IP address of the bonita server, the port to connect to is 9000. + The credentials to connect are the environment variables MONITORING_USERNAME, MONITORING_PASSWORD.

This optional environment variable allows to activate/deactivate reverse proxy redirection. Default value is false.

This optional environment variable allows to activate/deactivate writing Tomcat access logs to standard output. Default value is false.

This optional environment variable allows to activate/deactivate writing Tomcat access logs to a specific file. When activated, will write those logs to /opt/bonita/logs/ inside the docker container. In practice, it is only useful when mounting a volume to the aforementioned directory. Default value is false.

If ACCESSLOGS_FILES_ENABLED=true, this optional environment variable overrides the default path to the access log files. Default value is /opt/bonita/logs.

If ACCESSLOGS_FILES_ENABLED=true, this optional environment variable allows to append a subdirectory with the hostname to the full path of the directory to put access log files into. Default value is false.

If ACCESSLOGS_FILES_ENABLED=true, this optional environment variable allows to automatically delete access log files after a certain number of days. Default value is 30.

This optional environment variable allows to specify the maximum Http thread number Tomcat will use to serve HTTP/1.1 requests. Directly modifies the maxThreads parameter in the server.xml file of the Tomcat inside the docker container. More information on the usefulness of this parameter can be found here. Default value is 20.

This optional environment variable is used to customize JAVA_OPTS. The default value is -Xms1024m -Xmx1024m -XX:MaxPermSize=256m. The syntax to use is -e JAVA_OPTS="-Xms2048m -Xmx2048m -XX:MaxPermSize=1024m"

This environment variable is automatically set to postgres or mysql if the Bonita container is linked to a PostgreSQL or MySQL database using --link. The default value is h2. It can be overridden if you don't use the --link capability.

These variables are optional, used in conjunction to configure the bonita image to reach the database instance. There are automatically set if --link is used to run the container.

These variables are used in conjunction to define how Bonita should access its database for internal functioning.

DB_NAME default value is bonitadb.

DB_USER default value is bonitauser.

DB_PASS default value is bonitapass.

These variables are used in conjunction to define how Bonita should access the Business Data database.

BIZ_DB_NAME default value is businessdb.

BIZ_DB_USER default value is businessuser.

BIZ_DB_PASS default value is businesspass.

Since 2022.1

The logger can be configured by mounting a volume on folder /opt/bonita/conf/logs containing the configuration files.

the volume must contain the 2 files log4j2-loggers.xml and log4j2-appenders.xml

Any change made to one of this 2 files is automatically hot-reloaded and taken into account immediately.

This Docker image activates both static and dynamic authorization checks by default on REST API. To be consistent, it also deactivates the HTTP API.

• REST API authorization

  • Static authorization checking

• HTTP API

For specific needs you can override this behavior by setting HTTP_API to true:

$ docker run  -e HTTP_API=true -e HTTP_API_PASSWORD="My-Cust0m_S3cR3T" --name bonita -d -p 8080:8080 bonita

For updating from a version before 7.10.0, please refer to the documentation

• Stop the container to perform a database backup

  $ docker stop bonita

• Retrieve the DB container IP

  $ docker inspect --format '{{ .NetworkSettings.IPAddress }}' mydbpostgres
  172.17.0.26

• Dump the database

  $ export PGPASSWORD=mysecretpassword
  $ pg_dump -O -x -h 172.17.0.26 -U postgres bonitadb > /tmp/bonitadb.sql

  Note that businessdb won't be updated by the update tool but you may want to also backup/move it.

• Load the dump

  $ export PGPASSWORD=mysecretpassword
  $ psql -U postgres -h 172.17.0.26 -d postgres -c "CREATE USER newbonitauser WITH PASSWORD 'newbonitapass';"
  $ psql -U postgres -h 172.17.0.26 -d postgres -c "CREATE DATABASE newbonitadb OWNER newbonitauser;"
  $ export PGPASSWORD=newbonitapass
  $ cat /tmp/bonitadb.sql | psql -U newbonitauser -h 172.17.0.26 newbonitadb

• Retrieve the last update tool

  wget https://github.com/bonitasoft/bonita-platform-releases/releases/download/2023.2-u0/bonita-update-tool-3.3.0.zip
  unzip bonita-update-tool-3.3.0.zip

• Configure the update tool

  $ cd bonita-update-tool-3.3.0

  edit the update tool configuration file Config.properties to point towards the database.

  $ vim Config.properties

  For example :

  db.vendor=postgres
  db.url=jdbc:postgresql://172.17.0.26:5432/newbonitadb
  db.driverClass=org.postgresql.Driver
  db.user=newbonitauser
  db.password=newbonitapass

• Launch the update tool

  $ cd bin
  $ ./bonita-update-tool

• Launch the new container pointing towards the copy of the database.

  $ docker run --name=bonita --link mydbpostgres:postgres -e "DB_NAME=newbonitadb" -e "DB_USER=newbonitauser" -e "DB_PASS=newbonitapass" -d -p 8081:8080 bonita:2023.2-u0

For more details regarding Bonita update and for version before 7.10.0, see the documentation.

Bonita image includes two parts :

• Bonita Engine under LGPL v2.1

• Bonita Portal under GPL v2.0

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

Some additional license information which was able to be auto-detected might be found in the repo-info repository's bonita/ directory.

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.