1. Getting Started
  2. Configuration

Getting Started


The IdentityHub ships with a simple textbased property configuration in toml format.


An example configuration that contains all possible configuration properties and possible default values can be found in the config directory of the release archive as default.toml

You should create your own config file named local.toml and adopt the settings from the default.toml for your environment.


The config file local.toml should be in a folder config that lies next to the IdentityHub executable, which is the default location. Otherwise the location of the config folder can be configured by using the NODE_CONFIG_ENV environment variable.

Configuration manager

For an easy and safe (validated) way to create or adapt a configuration file for the IdentityHub, you can use the internal config-manager tool.


A possibly running instance of the IdentityHub should be stopped beforehand, to prevent validation errors like i.e. checking available free port. Keep in mind that additional certificates must be available for some validations.

To execute the config manager, run the following command. (Replace the path to your certificate file)

NODE_EXTRA_CA_CERTS=./config/ca-bundle.pem ./identity-hub config-manager

The configuration manager itself hopefully is self-explaining and ready to try out.