nuxeoctl and Control Panel Usage

The nuxeoctl script enables various options and commands, explained in details below.

It is available as an executable in the Docker image.

If you have installed Nuxeo from the Tomcat server ZIP, its location is the bin folder of the Nuxeo server.

For Windows users, its equivalent is the nuxeoctl.bat script, also located in the bin folder.

nuxeoctl Usage

Here is the script usage:

nuxeoctl <command> [options] [--] [command parameters]

Issue nuxeoctl help to print this information:

docker run docker.packages.nuxeo.com/nuxeo/nuxeo nuxeoctl help

Particularities:

• You can use multiple options at once but only one command.
• The values separated by | are choices (| means "exclusive or").
• Option and command parameters between square brackets ([]) are optional.
• Options and commands can have some parameters, optional or not. An equal sign (=) can be used (ie. -d org.nuxeo com.company equals to -d=org.nuxeo,com.company).
• Some options also have a shortcut (ie. -h equals to --help).
• Two dots (..) means the command accepts repeated parameters.
• Commands may need to be prefixed with -- to separate them from options when confusion arises.

Per-command Usage

nuxeoctl encrypt [--encrypt <algorithm>] [<clearValue>..] [-d [<categories>]|-q]
        Output encrypted value for <clearValue>.
        If <clearValue> is not provided, it is read from stdin.

nuxeoctl decrypt '<cryptedValue>'.. [-d [<categories>]|-q]
        Output decrypted value for <cryptedValue>. The secret key is read from stdin.

nuxeoctl config [<key> <value>].. <key> [<value>] [--encrypt [<algorithm>]] [--set [<template>]] [-d [<categories>]|-q]
        Set template or global parameters.
        If <value> is not provided and the --set 'option' is used, then the value is read from stdin.

nuxeoctl config [--get] <key>.. [-d [<categories>]|-q]
        Get value for the given key(s).

nuxeoctl config [--get-regexp] <regexp>.. [-d [<categories>]|-q]
        Get value for the keys matching the given regular expression(s).

nuxeoctl help|status|showconf [-d [<categories>]|-q]

nuxeoctl configure [-d [<categories>]|-q|-hdw]

nuxeoctl stop [-d [<categories>]|-q|--gui <true|false|yes|no>]

nuxeoctl start|restart|console|startbg|restartbg [-d [<categories>]|-q|--clid <arg>|--gui <true|false|yes|no>|--lenient|-hdw]

nuxeoctl mp-show [command parameters] [-d [<categories>]|-q|--clid <arg>|--xml|--json]

nuxeoctl mp-list|mp-listall|mp-update [command parameters] [-d [<categories>]|-q|--clid <arg>|--xml|--json]

nuxeoctl mp-reset|mp-purge|mp-hotfix|mp-upgrade [command parameters] [-d [<categories>]|-q|--clid <arg>|--xml|--json|--accept <true|false|yes|no|ask>]

nuxeoctl mp-add|mp-install|mp-uninstall|mp-remove|mp-set|mp-request [command parameters] [-d [<categories>]|-q|--clid <arg>|--xml|--json|--nodeps|--relax <true|false|yes|no|ask>|--accept <true|false|yes|no|ask>|-s|-im]

nuxeoctl register [<username> [<project> [<type> <description>] [<pwd>]]]
        Register an instance with Nuxeo Online Services.

nuxeoctl register --clid <arg>
        Register an instance according to the given CLID file.

nuxeoctl register --renew [--clid <arg>]
        Renew an instance registration with Nuxeo Online Services.

nuxeoctl pack <target> [-d [<categories>]|-q]

nuxeoctl connect-report [--output <file>|--gzip <*true|false|yes|no>|--pretty-print <true|*false|yes|no>]

Options

Commands

The following commands cannot be executed on a running server: pack, mp-purge, mp-add, mp-install, mp-uninstall, mp-request, mp-remove, mp-hotfix, mp-upgrade, mp-reset.

Additional Parameters

All parameters following a command which accepts no parameter are passed to the Java process when executing the command. That can be used for specific installs on which you rely on server specific parameters.

Environment Variables

Here are the OS environment variables which are read by nuxeoctl.

Java Usage

Launcher can be run as a Java command, without using the Shell (nuxeoctl) or Batch (nuxeoctl.bat) script. The equivalent Java command to Shell command is printed at startup. See the line starting with "Launcher command:". It can be reused for writing your own scripts.

Here is the Java usage:

java [-Dlauncher.java.opts="JVM options"] [-Dnuxeo.home="/path/to/nuxeo"] [-Dnuxeo.conf="/path/to/nuxeo.conf"] \
     [-Djvmcheck=nofail] -jar "path/to/nuxeo-launcher.jar" \
     [options] <command> [command parameters]

Java Options

Commands

See the nuxeoctl commands.

Additional Parameters

See the nuxeoctl additional parameters.

Exit Code Values

Exit code values are following the Linux Standard Base Core Specification 4.1.

If the status command was requested, nuxeoctl will return the following exit status codes:

In case of an error while processing any action except for status, nuxeoctl shall print an error message and exit with a non-zero status code: