Database Configuration
Contents
If you have not made any configuration changes yet, please see How to make configuration changes
Introduction
idenprotect Core Platform installation sets up a local MariaDB database for its use. MariaDB is an open-source MySQL-compliant database server. idenprotect Core Platform also uses a technology called Liquibase to keep the database schema up to date. See more Liquibase Information
The database stores vital idenprotect Core Platform data, such as idenprotect devices, idenprotect users, authentication attempts, and idenprotect Core Platform Admin Console users.
By default, idenprotect Core Platform is configured to use the local MariaDB database, but idenprotect Core Platform can use external SQL databases as well. When using the local MariaDB database, you don’t have to change anything.
Other Database Related Configuration
To configure the retention period of historical data, see Data Retention Configuration
To maintain an active back-up or enable high availability, see Database Replication Configuration
To manually set up the idenprotect Core Platform database, see Database Manual Setup
Configuring the Database Connection
Configuration location
To use a different database, you have to change the database connection settings. The settings are configured in:`
- Database section in the idenprotect Core Platform Admin Console Config Tab
- Server file system in
/etc/idenprotect/database.properties
Using External Database Server
Both local and external database connections are established using a JDBC connection URL, which is defined in /etc/idenprotect/database.properties. MariaDB / MySQL database connections use JDBC MySQL driver, and Oracle database connections use the Oracle Thin JDBC Driver.
JDBC Driver note
Note that up to release version 3.12.0, specifying the driver is a requirement as noted in the example configurations below. In later versions, this requirement has been removed and the driver is automatically selected based upon the Vendor selected.
MariaDB / MySQL Database
Change the following database connection parameters:
| Parameter in Config Tab | Parameter in Properties File | Configuration Change |
|---|---|---|
Username
|
db.username
|
User name of the idenprotect database |
Password
|
db.password
|
The user’s password |
Driver
|
db.jdbc.driver
|
JDBC Driver name. Set to com.mysql.jdbc.Driver
|
URL
|
db.jdbc.url
|
JDBC connection URL. Set to jdbc:mysql://<server-ip/hostname>:<port>/<database-name>?autoReconnect=true
|
Database Vendor
|
db.vendor
|
Database type. Set to MYSQL.
|
When using MariaDB / MySQL, idenprotect Core Platform stores all data in database named IDENPROTECT. If the database doesn’t exist, idenprotect Core Platform startup script creates the database during initial startup.
Oracle Database
idenprotect Core Platform supports Oracle Database version 11g Release 2 (11.2.0.x) Enterprise and Express editions. To use Oracle Database instead of MariaDB, change the following database connection parameters:
Please note the following regarding Autoincrement
| Parameter in Config Tab | Parameter in Properties File | Configuration Change |
|---|---|---|
Username
|
db.username
|
The name of the idenprotect user / schema on the database |
Password
|
db.password
|
Password of the user / schema |
Driver
|
db.jdbc.driver
|
JDBC Driver name. Set to oracle.jdbc.OracleDriver
|
URL
|
db.jdbc.url
|
JDBC connection URL. Set to to jdbc:<database-SID>:thin:@<server-ip/hostname>:<port>/<global-database-name>
|
Database Vendor
|
db.vendor
|
Database type. Set to ORACLE.
|
idenprotect Core Platform Oracle Database connector requires that an empty schema for the data is created before launching idenprotect Core Platform for the first time with the new database connection. During startup, idenprotect Core Platform creates all tables and required core data when it detects that the schema exists.
There are multiple ways to create a new user/schema in Oracle Database. For instructions, see CREATE USER in Oracle Database SQL Reference
