Running supervisord

To start supervisord, run $BINDIR/supervisord. Theresulting process will daemonize itself and detach from the terminal.It keeps an operations log at $CWD/supervisor.log by default.

You may start the supervisord executable in the foregroundby passing the -n flag on its command line. This is useful todebug startup problems.

Warning

When supervisord starts up, it will search for itsconfiguration file in default locations including the current workingdirectory. If you are security-conscious you will probably want tospecify a “-c” argument after the supervisord commandspecifying an absolute path to a configuration file to ensure that someonedoesn’t trick you into running supervisor from within a directory thatcontains a rogue supervisord.conf file. A warning is emitted whensupervisor is started as root without this -c argument.

To change the set of programs controlled by supervisord,edit the supervisord.conf file and kill-HUP or otherwiserestart the supervisord process. This file has severalexample program definitions.

The supervisord command accepts a number of command-lineoptions. Each of these command line options overrides any equivalentvalue in the configuration file.

supervisord Command-Line Options

-c FILE, —configuration=FILE
The path to a supervisord configuration file.
-n, —nodaemonRun supervisord in the foreground.
-h, —helpShow supervisord command help.
-u USER, —user=USER
UNIX username or numeric user id. If supervisord isstarted as the root user, setuid to this user as soon as possibleduring startup.
-m OCTAL, —umask=OCTAL
Octal number (e.g. 022) representing the umask that shouldbe used by supervisord after it starts.
-d PATH, —directory=PATH
When supervisord is run as a daemon, cd to this directory beforedaemonizing.
-l FILE, —logfile=FILE
Filename path to use as the supervisord activity log.
-y BYTES, —logfilemaxbytes=_BYTES
Max size of the supervisord activity log file before a rotationoccurs. The value is suffix-multiplied, e.g “1” is one byte, “1MB”is 1 megabyte, “1GB” is 1 gigabyte.
-z NUM, —logfilebackups=_NUM
Number of backup copies of the supervisord activity log to keeparound. Each logfile will be of size logfilemaxbytes.
-e _LEVEL, —loglevel=LEVEL
The logging level at which supervisor should write to the activitylog. Valid levels are trace, debug, info, warn,error, and critical.
-j FILE, —pidfile=FILE
The filename to which supervisord should write its pid file.
-i STRING, —identifier=STRING
Arbitrary string identifier exposed by various client UIs for thisinstance of supervisor.
-q PATH, —childlogdir=PATH
A path to a directory (it must already exist) where supervisor willwrite its AUTO -mode child process logs.
-k, —nocleanup
Prevent supervisord from performing cleanup (removal ofold AUTO process log files) at startup.
-a NUM, —minfds=NUM
The minimum number of file descriptors that must be available tothe supervisord process before it will start successfully.
-t, —stripansi
Strip ANSI escape sequences from all child log process.
-v, —versionPrint the supervisord version number out to stdout and exit.
—profile_options=_LIST
Comma-separated options list for profiling. Causessupervisord to run under a profiler, and output resultsbased on the options, which is a comma-separated list of thefollowing: cumulative, calls, callers.E.g. cumulative,callers.
—minprocs=NUMThe minimum number of OS process slots that must be available tothe supervisord process before it will start successfully.