openxpkictl - start/stop script for OpenXPKI server
openxpkictl [options] COMMAND
Commands:
start Start OpenXPKI daemon
stop Stop OpenXPKI daemon
reload Reload the configuration
restart Restart OpenXPKI daemon
status Get OpenXPKI daemon status
version Print the OpenXPKI version and license info
See below for supported options.
Available commands:
- start
- Starts the OpenXPKI daemon.
- stop
- Stops the OpenXPKI daemon.
- reload
- Reloads the OpenXPKI daemon, re-reading the config repository. Note: Some
changes need a restart, see the documentation!
- restart
- Restarts the OpenXPKI daemon.
- status
- Checks the OpenXPKI daemon status.
- version
- Print information on the version and license.
- --help
- Print a brief help message and exits.
- --man
- Prints the manual page and exits.
- --config|cfg PATH
- Use PATH to point to the configuration repository (base of yaml tree).
Defaults to /usr/local/etc/openxpki/config.d
- --instance|i NAME
- Shortcut to set the config path when running multiple instances using the
proposed config path layout
(/usr/local/etc/openxpki/instance/config.d).
- --version
- Print program version and exit.
- --debug MODULE:LEVEL
- Set specific module debug level to LEVEL (must be a positive integer).
Higher values mean more debug output. MODULE must be a module
specification (e. g. OpenXPKI::Server) and may contain Perl Regular
expressions.
LEVEL can be specified as a decadic or binary number (e.g. 5
or 0b101). LEVEL defaults to 1 if not specified.
If MODULE is omitted the given LEVEL will be set for all
modules.
You can add multiple --debug options on one command line.
Examples:
--debug
(equivalent to --debug .*:1)
--debug OpenPKI::Server
(equivalent to --debug OpenXPKI::Server:1)
--debug OpenPKI::Server:100
(equivalent to --debug OpenXPKI::Server:100)
--debug OpenPKI::Server:10 --debug OpenXPKI::Crypto::.*:20
- --debug MODULE[=BITMASK]
- Show debug messages of MODULE whose level fits into the given BITMASK
(i.e. "level AND BITMASK == level"). BITMASK can be specified as
a decadic or binary number (e.g. 5 or 0b101). If not given BITMASK
defaults to 1.
- --nocensor
- Turn off censoring in the Debug module.
- --keep-temp-files yes
- Do not delete temporary files. WARNING: Files might contain
confidential data!
- --no-detach|nd
- Do not fork away the control process - useful to run inside containers or
from systemd.
- --foreground|fg
- Does not fork program away and uses a non-forking server. This
limits the OpenXPKI server to handle only one request at a time, so this
is pretty much useful only for debugging and profiling.
DO NOT USE THIS FOR PRODUCTION.
openxpkictl is the start script for the OpenXPKI server process.
The openxpkictl script returns a 0 exit value on success,
and >0 if an error occurs.