Urchin Services Control Utility (urchinctl)

Overview

The Urchin Services Control utility, urchinctl, provides a means of starting and stopping the Urchin Scheduler and Urchin Webserver services. On UNIX-type systems, urchinctl is typically called from one of the system's boot-time scripts to automatically start up or shut down Urchin services.

The types of operations that urchinctl can perform are:

  • Start, stop, or restart the scheduler or webserver (or both)
  • Start the webserver on an alternate port
  • Start the webserver with SSL encryption

Usage

urchinctl is located in the bin directory of the Urchin distribution.

Usage of the utility is as follows:

  urchinctl -h (prints usage message and exits)
  urchinctl -v (prints version and exits)
  urchinctl [-e] [-p port] [[-s] | [-w]] action
where:
  -e  activates encryption (SSL) in the webserver
  -p  specifies the port for the webserver to listen on
  -s  performs the action on the Urchin scheduler ONLY
  -w  performs the action on the Urchin webserver ONLY
and action is one of:
  start   (starts the service(s))
  stop    (stops the service(s))
  restart (stops and then starts the service(s))
  status  (displays webserver/scheduler runtime status)
By default, the action is performed on both the webserver and the scheduler unless the "-s" or "-w" options are specified. Note that these options are mutually exclusive.

Considerations

On UNIX-type systems, urchinctl should be run as the user/UID that Urchin is installed as to ensure that the urchinwebd and urchind processes are started as that UID.