The Cargo Daemon is a Web-based application that uses the Cargo API to configure, start and stop containers on a remote machine.
The daemon is meant to be listening 24/7, to allow users to deploy new containers and web applications at their command.
It can be accessed using a browser-based UI, via Java API or Maven2 plugin.
Table of Contents
The documentatation for the Cargo Daemon includes:
- Installation: explains how to install and run the daemon
- Getting started: very quick guide on using the daemon
To install and run the Cargo Daemon:
- Download the Cargo Daemon from the Downloads page
- Execute by typing:
where <version> is the version number of the daemon that you have downloaded.
By default, the Cargo Daemon will run on HTTP port
18000. To change it, use the
Additionally, Cargo Daemon will save log files in the cargo home directory unless the
-nologging option is used.
Note that the Cargo Daemon is a WAR file; you can actually also deploy it as a WAR on any existing container. This can be useful if you want to, for example, reuse a certain security configuration.
The daemon also accepts other parameters, in the form of system properties:
Directory in which the standaone daemon server stores its files. These include the temporary files (such as its own WAR and server temporary files) as well as the server log files (
This property is not used and completely ignored if the daemon WAR file is deployed on an existing container.
Directory in which the daemon (be it standalone or deployed on an existing container) stores the list of containers, downloaded container archives, container logs, etc.
Note that the standalone daemon by default sets this to
Getting started using the browser UI
To use the Cargo Daemon via the browser UI, simply open
<machine> is the machine host name or IP address and
<port> is the port number used (default is
- To start a container, fill in the form and press Submit:
- To stop, restart, delete or view logs of a container, use the actions on the containers list:
- The Cargo Daemon keeps a persistent record on disk of all the containers that have been submitted. Containers that have been submitted will stay in the list, even when they are stopped. This allows you to manually restart them, or view the logs even after the container is stopped.
- If you want the container to be removed from the list, simply press the delete button.
- Containers can also be submitted with the
autostartproperty (currently only via the Java API or the Maven2/Maven3 plugin), this will automatically restart the container if the daemon notices it is stopped.
Getting started with the Java API / Maven2/Maven3 plugin
As stated before, the Cargo Daemon is also available programmatically:
- The details of the Java API can be seen on the Javadoc for o.c.c.tools.daemon.DaemonClient
- The details of the configuration for the Maven2/Maven3 plugin is documented in the