Skip to main content
Version: 4.3

Installing CMDBuild

Installing CMDBuild​

Before installing CMDBuild, ensure that the following software is installed and properly configured:

  • PostgreSQL database, running and accessible
  • Apache Tomcat application server (required only for manual installation)
  • Alfresco DMS or Microsoft SharePoint (required only if document management is needed)
  • Java Runtime Environment (JRE)

Download links for all required software are available in the System Configuration chapter.

Warning: Ensure that no directory in the installation path contains spaces.

Installation​

After all prerequisites have been installed and configured, proceed with the CMDBuild installation.

Installation packages are available on the official CMDBuild website:

Page with war file, which is used for manual installation.

Manual installation​

For manual installation, Apache Tomcat and all required dependencies must already be installed. Refer to the previous chapter for supported versions and download links.

Note: When installing OpenMAINT, replace all references to CMDBuild with openMAINT.

Extract the contents of the downloaded file (for example, cmdbuild-4.3.0.war) into the Tomcat installation directory under /webapps/cmdbuild.

At this stage, the CMDBuild application is installed, but the database has not yet been configured.

Database configuration can be performed in one of the following ways:

  • Using the Database Configuration Wizard available after the first Tomcat startup
  • Using the command line

Database configuration using the Wizard​

A database configuration wizard is available for new CMDBuild installations.

After deploying the CMDBuild web application and starting Tomcat, open the application in a web browser. You will be automatically redirected to the database configuration page.

../img/technical/configuration-page.png

The configuration form contains the following fields:

  • Type — database type or initialization mode: demo, empty, existing database, or database import from file
  • Name — PostgreSQL database name
  • Host — PostgreSQL server hostname or IP address
  • Port — PostgreSQL server port
  • Username — PostgreSQL username (recommended: cmdbuild)
  • Password — PostgreSQL user password (recommended: cmdbuild)
  • Admin username — PostgreSQL administrator username (recommended: postgres)
  • Admin password — PostgreSQL administrator password (recommended: postgres)

After completing the form, click Test database connection to verify the configuration.

If the connection test succeeds, click Configure to create or initialize the database.

If database patches are required, a list will be displayed after configuration. Click Apply patches to execute them.

The installation is complete when the CMDBuild login page is displayed.

Windows - Database configuration​

On Windows, the database must be imported manually using a tool such as pgAdmin or the PostgreSQL command-line utilities.

The database dump files are located in the WEB-INF/sql/dump directory inside the deployed web application.

Note: If you need to import a database containing GIS data, refer to the PostGIS documentation for configuration requirements and version compatibility details.

The following example describes a PostGIS installation with PostgreSQL 17 and PostGIS 3.x on Windows 11.

  1. Install PostgreSQL 17 from PostgreSQL Official Site
  2. Install PostGIS for PostgreSQL 17 from OSGeo Site
  3. Connect to the PostgreSQL instance using pgAdmin 4
  4. Create a new user named cmdbuild and assign a password
  5. Create a new database owned by the cmdbuild user
  6. Connect to the new database as cmdbuild and create the GIS schema:
CREATE SCHEMA gis;
  1. Create the PostGIS extension. Superuser privileges may be required for this operation and can be revoked afterward:
CREATE EXTENSION postgis SCHEMA gis;
  1. Import the CMDBuild database using pgAdmin, selecting the cmdbuild database as the target

During the import process, warnings about duplicate entries in the dump file may be displayed. These warnings can be safely ignored.

After the import is complete, start Tomcat using the appropriate startup script.

To modify the default port or other Tomcat settings, edit the server.xml file located in:

<tomcat_install_folder>/conf

Linux - Database configuration​

On Linux, database configuration is performed using the dbconfig command available through the cmdbuild.sh script located in the web application directory.

The dbconfig command supports database creation from a dump file and other database management operations.

To import the demo database included in the CMDBuild .war package, run:

bash webapps/cmdbuild/cmdbuild.sh dbconfig create demo -configfile /path/to/configfile

CMDBuild creates a new database using the name specified in the configuration file and automatically imports the demo dataset.

DMS configuration​

Configuration of document management systems is described in the dedicated section:

Configuring DMS