• Get the basic configuration definitions for the Maintenance Endpoint

    Parameters

    • variables: Dict<undefined | string> = process.env

      process.env variables or custom provided values

    • Optional logger: LoggerFn

    Returns {
        maintenanceEndpointPassword: (() => string);
        maintenanceEndpointPort: (() => undefined | number);
        maintenanceEndpointUserName: (() => string);
    }

    The following configuration values are included:

    maintenanceEndpointPort // e.g. MAINTENANCE_ENDPOINT_PORT=9911
    maintenanceEndpointUserName // e.g. MAINTENANCE_ENDPOINT_USER_NAME=maintenance
    maintenanceEndpointPassword // e.g. MAINTENANCE_ENDPOINT_PASSWORD={qx/!|PEa0m{.8^W
    • maintenanceEndpointPassword: (() => string)
        • (): string
        • Returns string

          Example

          MAINTENANCE_ENDPOINT_PASSWORD={qx/!|PEa0m{.8^W
          
    • maintenanceEndpointPort: (() => undefined | number)
        • (): undefined | number
        • Returns undefined | number

          Example

          MAINTENANCE_ENDPOINT_PORT=9911
          
    • maintenanceEndpointUserName: (() => string)
        • (): string
        • Returns string

          Example

          MAINTENANCE_ENDPOINT_USER_NAME=maintenance
          

Generated using TypeDoc