[unix_http_server] Section Settings

The supervisord.conf file contains a section named[unix_http_server] under which configuration parameters for anHTTP server that listens on a UNIX domain socket should be inserted.If the configuration file has no [unix_http_server] section, aUNIX domain socket HTTP server will not be started. The allowableconfiguration values are as follows.

[unix_http_server] Section Values

file

A path to a UNIX domain socket on which supervisor will listen forHTTP/XML-RPC requests. supervisorctl uses XML-RPC tocommunicate with supervisord over this port. This optioncan include the value %(here)s, which expands to the directoryin which the supervisord configuration file was found.

Default: None.

Required: No.

Introduced: 3.0

Warning

The example configuration output by echo_supervisord_conf uses/tmp/supervisor.sock as the socket file. That path is an example onlyand will likely need to be changed to a location more appropriate for yoursystem. Some systems periodically delete older files in /tmp. If thesocket file is deleted, supervisorctl will be unable toconnect to supervisord.

chmod

Change the UNIX permission mode bits of the UNIX domain socket tothis value at startup.

Default: 0700

Required: No.

Introduced: 3.0

chown

Change the user and group of the socket file to this value. May bea UNIX username (e.g. chrism) or a UNIX username and groupseparated by a colon (e.g. chrism:wheel).

Default: Use the username and group of the user who starts supervisord.

Required: No.

Introduced: 3.0

username

The username required for authentication to this HTTP server.

Default: No username required.

Required: No.

Introduced: 3.0

password

The password required for authentication to this HTTP server. Thiscan be a cleartext password, or can be specified as a SHA-1 hash ifprefixed by the string {SHA}. For example,{SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d is the SHA-storedversion of the password “thepassword”.

Note that hashed password must be in hex format.

Default: No password required.

Required: No.

Introduced: 3.0

[unix_http_server] Section Example

[unix_http_server]
file = /tmp/supervisor.sock
chmod = 0777
chown= nobody:nogroup
username = user
password = 123