supervisor_pydantic.UnixHttpServerConfiguration

pydantic model supervisor_pydantic.UnixHttpServerConfiguration

Bases: _BaseCfgModel

Show JSON schema

{
   "title": "UnixHttpServerConfiguration",
   "type": "object",
   "properties": {
      "file": {
         "anyOf": [
            {
               "format": "path",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A path to a UNIX domain socket on which supervisor will listen for HTTP/XML-RPC requests. supervisorctl uses XML-RPC to communicate with supervisord over this port. This option can include the value %(here)s, which expands to the directory in which the supervisord configuration file was found.",
         "title": "File"
      },
      "chmod": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Change the UNIX permission mode bits of the UNIX domain socket to this value at startup.",
         "title": "Chmod"
      },
      "chown": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Change the user and group of the socket file to this value. May be a UNIX username (e.g. chrism) or a UNIX username and group separated by a colon (e.g. chrism:wheel).",
         "title": "Chown"
      },
      "username": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The username required for authentication to this HTTP server.",
         "title": "Username"
      },
      "password": {
         "anyOf": [
            {
               "format": "password",
               "type": "string",
               "writeOnly": true
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The password required for authentication to this HTTP server. This can be a cleartext password, or can be specified as a SHA-1 hash if prefixed by the string {SHA}. For example, {SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d is the SHA-stored version of the password \u201cthepassword\u201d. Note that hashed password must be in hex format.",
         "title": "Password"
      }
   }
}

Fields:

• chmod (str | None)

• chown (str | None)

• file (pathlib.Path | None)

• password (pydantic.types.SecretStr | None)

• username (str | None)

field file: Path | None = None

A path to a UNIX domain socket on which supervisor will listen for HTTP/XML-RPC requests. supervisorctl uses XML-RPC to communicate with supervisord over this port. This option can include the value %(here)s, which expands to the directory in which the supervisord configuration file was found.

field chmod: _check_is_octal)] | None = None

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

field chown: Annotated[str, AfterValidator(func=_is_username_or_usernamegroup)] | None = None

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

field username: Annotated[str, AfterValidator(func=_is_username)] | None = None

The username required for authentication to this HTTP server.

field password: SecretStr | None = None

The password required for authentication to this HTTP server. This can be a cleartext password, or can be specified as a SHA-1 hash if prefixed by the string {SHA}. For example, {SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d is the SHA-stored version of the password “thepassword”. Note that hashed password must be in hex format.