[supervisorctl] Section Settings

The configuration file may contain settings for thesupervisorctl interactive shell program. These optionsare listed below.

[supervisorctl] Section Values

serverurl

The URL that should be used to access the supervisord server,e.g. http://localhost:9001. For UNIX domain sockets, useunix:///absolute/path/to/file.sock.

Default: http://localhost:9001

Required: No.

Introduced: 3.0

username

The username to pass to the supervisord server for use inauthentication. This should be same as username from thesupervisord server configuration for the port or UNIX domain socketyou’re attempting to access.

Default: No username

Required: No.

Introduced: 3.0

password

The password to pass to the supervisord server for use inauthentication. This should be the cleartext version of passwordfrom the supervisord server configuration for the port or UNIXdomain socket you’re attempting to access. This value cannot bepassed as a SHA hash. Unlike other passwords specified in thisfile, it must be provided in cleartext.

Default: No password

Required: No.

Introduced: 3.0

prompt

String used as supervisorctl prompt.

Default: supervisor

Required: No.

Introduced: 3.0

history_file

A path to use as the readline persistent history file. If youenable this feature by choosing a path, your supervisorctl commandswill be kept in the file, and you can use readline (e.g. arrow-up)to invoke commands you performed in your last supervisorctl session.

Default: No file

Required: No.

Introduced: 3.0a5

[supervisorctl] Section Example

[supervisorctl]
serverurl = unix:///tmp/supervisor.sock
username = chris
password = 123
prompt = mysupervisor