The idsvr command#

The idsvr command is used to start the Curity Identity Server, but also to manage configuration and run database migrations.

Environment variables#

The following environment variables may be provided to customize behavior (but all have sensible default values):

• IDSVR_HOME - the root directory of the server distribution.
• CONFD_DIR - root directory of the Configuration Service.
• CLASSPATH - additional Java classpath.
• PROGRAM_NAME - program name (can be used in help messages instead of idsvr).
• SKIP_DEP_CHECK - skip checking dependencies (e.g. do not check the Java version).

Options#

Information#

These options, when used, print information and exit.

-h,--help                                            prints this help message and exits
-v,--version                                         prints the version and exits

Start the Server#

Options that can be used when starting the Identity Server:

-a,--admin                                           whether the server should run as an admin node
-n,--no-admin                                        whether the server should not run as an admin node
-i,--hsm-pin <PIN>                                   the PIN (or a file containing it) needed to login to the HSM
-m,--debug-hsm                                       include HSM-related debug log messages in the server log
-e,--config-encryption-key <CONFIG_ENCRYPTION_KEY>   the configuration encryption key
-N,--service-name <SERVICE_NAME>                     Descriptive name for this server
-s,--service-role <SERVICE_ROLE>                     Role for this server
--no-status                                          Do not start the status endpoint.

See also:

• Service Roles .
• Go-live Checklist .
• Hardware Security Module .

Configuration Management#

The following options are used to manage the server configuration:

-d,--dump-config <CONFIG_PATH>                       dumps the configuration to the console. If a CONFIG_PATH is given then only the
matching part of the configuration will be dumped
-D,--dump-config-with-params <CONFIG_PATH>           dumps the configuration to the console with the actual substitution parameters. If a
CONFIG_PATH is given then only the matching part of the configuration will be dumped
-f,--force-reload                                    replaces the current configuration with the configuration from etc/init
-l,--load-config <LOAD_FILE>                         delete and replace the parts of the configuration with those present in the given file
-r,--reload                                          reloads the configuration in etc/init and merges with the existing configuration

See also:

• Restoring the Initial Configuration .
• Encrypted Configuration .
• Parameterized Configuration .

Database Schema Migration#

Options related to database schema migrations:

-C,--liquibase-changelog <CHANGELOG>                 Executes the given Liquibase Changelog and exits. To use the default Changelog, use
                                                     the value 'default'.
-L,--liquibase-changelog <CHANGELOG>                 Checks the given Liquibase Changelog and exits. To use the default Changelog, use
                                                     the value 'default'.

See also:

• Database Schema Migration .
• Upgrading .

Further Reading#