Configure a database

Configure a database

Kadeck requires a database for storing information. An external database such as H2 or PostgreSQL is recommended in a production environment.
If no external database information is supplied, Kadeck will use an internal H2 file-based database. This is not recommended for production use as all data is lost after a container restart. 

Supported databases

Kadeck currently supports:
  1. PostgreSQL Database
  2. H2 database

Configuring the database connection

The database connection details are passed to Kadeck as environment variables in the form of a JDBC connection string.
Example (with Postgres database):
  1. xeotek_kadeck_db_url=jdbc:postgresql://kadeckweb.eu-central-1.rds.amazonaws.com:5432/kadeckweb
Although username and password can be specified in the JDBC string, the username and password can alternatively be specified using the following environment variables:

  1. xeotek_kadeck_db_username=my_user
  2. xeotek_kadeck_db_password=my_password
User permissions
The configured database user must be able to create tables and read/write data.

Database size

A recommended size for the database to start with is 1GB. Depending on the usage and the growing audit logs, the size of the database must be increased.

    • Related Articles

    • External database

      If you want to know how to configure a database, please read this article as well. Kadeck, at this point in time, supports two databases: H2 Postgresql If no database is specified with startup parameters, Kadeck will use an H2 in-memory database. ...

    • Configure OpenId authentication

      This guide outlines the process of setting up OpenID authentication in Kadeck. OpenID provides a secure and standardized way for users to authenticate across different platforms. To activate OpenID authentication, please configure and set the ...

    • Configure LDAP Basic module

      Active Directory (AD) and OpenLDAP are supported to authenticate users. LDAP is only available to specific licenses. LDAP is configured via Startup Parameters with the prefix xeotek_kadeck_authentication_ldap. To enable LDAP, the ...

    • Configure a home path

      The home path can be used to change the URL through which the Kadeck Teams UI and API are accessible. In the default configuration, all endpoints are exposed via the host domain (e.g. localhost:80/). The home path parameter can be used to append ...

    • Configure a Kadeck cluster setup

      This article describes how to configure multiple Kadeck instances that run as a cluster. Define master nodes First define a list of master nodes. In this example, we will configure 3 Kadeck instances running as a minimum (to handle 2 simultaneous ...