This documentation refers to the unreleased development version of the Nuxeo Platform. For the current production version, refer to the 5.6 documentation.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Option

Description

--accept=true|false|ask

(Since Nuxeo 5.6) Accept, refuse or ask confirmation for all changes (default: ask)
--accept=true also sets --relax=true (i.e. non interactive mode)

-d
--debug

(Since Nuxeo 5.5) Activate debug messages. See 'category' option.

-dc <arg>

(Since Nuxeo 5.6) Comma separated root categories for 'debug' option (default: "org.nuxeo.launcher").

--gui=true|false

(Since Nuxeo 5.6) Use graphical user interface (default is true on Windows and false on other platforms)

-h
--help

Show detailed help

--json

(Since Nuxeo 5.6) Output JSON for mp-commands

--nodeps

(Since Nuxeo 5.6) Ignore package dependencies and constraints (old behavior)

-q
--quiet

(Since Nuxeo 5.5) Activate quiet mode.

--relax=true|false|ask

(Since Nuxeo 5.6) Allow relax constraint on current platform (default: ask)

--xml

(Since Nuxeo 5.6) Output XML for mp-commands

...

Command

Description

help

Print this message.

gui

(Deprecated since Nuxeo 5.6: use --gui option instead) Use graphical user interface.
On Linux/Mac OS X, default is in headless/console mode.
On Windows, the --gui=true option is activated by default.

nogui

(Deprecated since Nuxeo 5.6: use --gui option instead) Windows only. This option deactivates the gui option which is set by default under Windows.

start

Start Nuxeo server in background, waiting for effective start.
Useful for batch executions requiring the server being immediately available after the script returned.

stop

Stop any Nuxeo server started with the same nuxeo.conf file.

restart

Restart Nuxeo server.

configure

Configure Nuxeo server with parameters from nuxeo.conf.

wizard

Enable the wizard (force the wizard to be played again in case the wizard configuration has already been done).

console

Start Nuxeo server in a console mode. Ctrl+C will stop it.

status

Print server status (running or not).

startbg

Start Nuxeo server in background, without waiting for effective start.
Useful for starting Nuxeo as a service.

restartbg

Restart Nuxeo server with a call to startbg after stop.

pack

Build a static archive (the "pack" Shell script is deprecated).

showconf

Display the instance configuration.

mp-list

List local Marketplace packages.

mp-listall

List all Marketplace packages (requires a registered instance).

mp-init

Pre-cache Marketplace packages locally available in the distribution.

mp-update

Update cache of Marketplace packages list.

mp-add

Add Marketplace package(s) to local cache. You must provide the package file(s), name(s) or ID(s) as parameter.

mp-install

Run Marketplace package installation. It is automatically called at startup if installAfterRestart.log file exists in data directory. Else you must provide the package file(s), name(s) or ID(s) as parameter.

mp-uninstall

Uninstall Marketplace package(s). You must provide the package name(s) or ID(s) as parameter (see "mp-list" command).
If uninstalling a package by its ID and other versions of the same package are available, the most up-to-date will be installed instead.

mp-remove

Remove Marketplace package(s). You must provide the package name(s) or ID(s) as parameter (see "mp-list" command).

mp-reset

Reset all packages to DOWNLOADED state. May be useful after a manual server upgrade.

mp-purge

Uninstall and remove all packages from the local cache.

mp-hotfix

Install all the available hotfixes for the current platform (requires a registered instance).

mp-upgrade

Get all the available upgrades for the Marketplace packages currently installed (requires a registered instance).

...