Starting & Stopping OpenIDM
This chapter covers scripts provided for managing OpenIDM.
Startup & Shutdown
Starting OpenIDM
Stopping OpenIDM
By default you start and stop OpenIDM in interactive mode.
To start OpenIDM interactively, open a terminal or command window,
change to the openidm directory, and run the startup
script:
startup.sh on UNIX, Linux, & Mac OS X
startup.bat on Windows
The startup script starts OpenIDM, and opens an OSGi console with a
-> prompt where you can issue console commands.
To stop OpenIDM interactively in the OSGi console, enter the
shutdown command.
-> shutdown
You can also start OpenIDM as a background process on UNIX, Linux, and
Mac OS X. Follow these steps before starting OpenIDM for the first
time.
If you have already started OpenIDM, then shut down OpenIDM and
remove Felix cache files under
openidm/felix-cache/.
-> shutdown
...
$ rm -rf felix-cache/*
Disable ConsoleHandler logging before starting
OpenIDM by editing openidm/conf/logging.properties
to set java.util.logging.ConsoleHandler.level = OFF,
and to comment out other references to ConsoleHandler,
as shown in the following excerpt.
# ConsoleHandler: A simple handler for writing formatted records to System.err
#handlers=java.util.logging.FileHandler, java.util.logging.ConsoleHandler
handlers=java.util.logging.FileHandler
...
# --- ConsoleHandler ---
# Default: java.util.logging.ConsoleHandler.level = INFO
java.util.logging.ConsoleHandler.level = OFF
#java.util.logging.ConsoleHandler.formatter = ...
#java.util.logging.ConsoleHandler.filter=...
Remove the text-based OSGi console bundle,
bundle/org.apache.felix.shell.tui-version.jar.
Start OpenIDM in the background.
$ ./startup.sh &
[3] 454
$ ./startup.sh
Using OPENIDM_HOME: /path/to/openidm
Using OPENIDM_OPTS: -Xmx1024m
Using LOGGING_CONFIG:
-Djava.util.logging.config.file=/path/to/openidm/conf/logging.properties
Using boot properties at /path/to/openidm/conf/boot/boot.properties
$
Alternatively, use the nohup command to keep
OpenIDM running after you log out.
$ nohup ./startup.sh &
[2] 394
$ appending output to nohup.out
$
To stop OpenIDM running as a background process, use the
shutdown.sh script.
$ ./shutdown.sh
./shutdown.sh
Stopping OpenIDM (454)
Command-Line Tools
OpenIDM includes these command line tools in the
openidm directory.
cli.sh
This script supports the following subcommands.
validate
Configuration
Validating
Validate all .json configuration files in the
conf/ directory
java -jar bundle/init/openidm-crypto-.jar
Utility to obfuscate passwords such as the bootstrap password stored
in openidm/conf/boot/boot.properties
java -jar bundle/json-crypto-cli-.jar
Encryption
Utility to encrypt and decrypt values in JSON objects
startup.bat
startup.sh
Script to start OpenIDM and the OSGi console
shutdown.sh
Script to stop OpenIDM, especially when you run OpenIDM as a
background process