Overview

This is the first configuration file, it's used when the system is booting. The settings in this file can generally not be modified using the administrative configuration UI, only by using a file editor. Additionally, this file is not synchronized between the cluster members when running as a cluster (which is the case for phenix-store.json). For details on how the system is booted and how the configuration files are applied, see the documentation on how bootstrapping works.

Sections

The configuration file is written in JSON. There is one root-object - each property in the root object is a section, and the sections are pre-defined and various parts of the system can be configured in these sections.

defaults

default_modules

When the system starts for the first time, these modules will be injected into the new phenix-store.json configuration as modules to deploy.

deploy

When the system boots up, these modules will be deployed first. Modules marked with "synchronous": "true" will be started first before the other modules are deployed.

Default configuration

This is what the default configuration looks like on a new installation. This configuration is not upgraded automatically when the system is upgraded, so the default configuration here might differ from your installed boot.json configuration file.

{
    "description": "PhenixID Server boot configuration",
    "defaults": {
        "default_modules": [
            {
                "name": "com.phenixidentity~phenix-pipes",
                "scope": "global",
                "singleton": "true",
                "config": {}
            },
            {
                "name": "com.phenixidentity~phenix-crypto",
                "scope": "global",
                "singleton": "true",
                "config": {}
            },
            {
                "name": "com.phenixidentity~phenix-ca",
                "scope": "global",
                "singleton": "true",
                "config": {
                    "enableHttp": "false"
                }
            },
            {
                "name": "com.phenixidentity~phenix-httpclient-mod",
                "scope": "global",
                "singleton": "true",
                "config": {
                    "_proxy": "",
                    "ssl_tls_version": "TLSv1.3",
                    "ssl_trust_all": "false",
                    "_ssl_keystore_ref": "",
                    "_ssl_truststore_ref": "",
                    "request_timeout": "2000",
                    "connect_timeout": "-1",
                    "socket_timeout": "-1",
                    "allow_redirect": "false",
                    "allow_relative_redirect": "false",
                    "max_redirects": "0",
                    "request_body_max_size": "2097152",
                    "response_body_max_size": "2097152"
                }
            }
        ]
    },
    "allowonlinelicensecheck": "true",
    "licensePassword": "nackastrand",
    "deploy": [
        {
            "name": "com.phenixidentity~phenix-event",
            "enabled": "true"
        },
        {
            "name": "com.phenixidentity~phenix-store-json",
            "synchronous": "true",
            "address": "com.phenixidentity.configuration",
            "config": {
                "store.file": "./config/phenix-store.json",
                "persistsessions": "false",
                "encryption.key": "******",
                "enabled": "true"
            }
        },
        {
            "module": "com.phenixidentity~phenix-schedule",
            "enabled": "true",
            "config": {}
        },
        {
            "name": "com.phenixidentity~phenix-session-manager",
            "scope": "global",
            "singleton": "true",
            "config": {}
        },
        {
            "name": "com.phenixidentity~phenix-store-mpl",
            "config": {
                "user": "phenixid",
                "password": "mplPassword",
                "encryption.key": "mplencrypt",
                "export_start": "04:00",
                "driver_class": "org.hsqldb.jdbc.JDBCDriver",
                "dataretention": "60",
                "is_server": "true",
                "url": "jdbc:hsqldb:hsql://localhost:9001/phenixid"
            }
        },
        {
            "name": "com.phenixidentity~phenix-prism",
            "enabled": "true",
            "config": {
                "_auth_redirect_url": "/config/authenticate/config",
                "base_url": "/config",
                "enable_module_deployment": "true",
                "enable_roles": "true",
                "enable_language": "false",
                "requires_role_for_admin": "sysadmin",
                "display_name": "Configuration Manager",
                "prism_modules": [
                    {
                        "name": "com.phenixidentity~phenix-prism-start",
                        "config": {
                            "display_name": "Start",
                            "base_uri": "start",
                            "requires_role": "sysadmin"
                        }
                    },
                    {
                        "name": "com.phenixidentity~phenix-prism-report",
                        "enabled": "true",
                        "config": {
                            "display_name": "Reports",
                            "base_uri": "report",
                            "requires_role": "sysadmin"
                        }
                    },
                    {
                        "name": "com.phenixidentity~phenix-prism-guides",
                        "config": {
                            "display_name": "Scenarios",
                            "base_uri": "scenarios",
                            "requires_role": "sysadmin"
                        }
                    },
                    {
                        "name": "com.phenixidentity~phenix-prism-config",
                        "enabled": "true",
                        "config": {
                            "display_name": "Advanced",
                            "base_uri": "configuration",
                            "requires_role": "sysadmin"
                        }
                    }
                ]
            }
        },
        {
            "name": "com.phenixidentity~auth-http",
            "enabled": "true",
            "config": {
                "root_uri": "/config",
                "v2_classes": {
                    "TokenAuthenticator": "com.phenixidentity.authn.http.internal.headless.TokenHeadless"
                }
            }
        }
    ]
}