Read More

ZeroConfig Settings

ZeroConfig is a feature that allows authorized client servers to send their configuration (domains, ip addresses, ports, etc.) to LiteSpeed Web ADC. This feature provides an alternative way to set up load balancing dynamically rather than working with the webadmin interface. The ZeroConfig API describes the messages accepted by the ZeroConfig feature. This section provides the interface to enable and configure the ZeroConfig feature.

Table of Contents

General

Enable Zero Config | User Password File | Group Password File | Zconf SHM Directory

Zconf Log

File Name | Log Level | Debug Level | Rolling Size (bytes)

Zconf Access Log

File Name | Piped Logger | Log Format | Log Headers | Rolling Size (bytes) | Keep Days | Compress Archive

Access Control

Allowed List | Denied List

Zconf Listeners

Listener Name | Address | Private Key File | Certificate File | CA Certificate File

Enable Zero Config

Description

Choose whether or not to enable the zero config feature.

Syntax

Select from radio box

Tips

Once enabled at the server level, this feature can be enabled individually per listener.

User Password File

Description

The location of an HTTP basic authentication user password file.

Syntax

path

Group Password File

Description

The location of an HTTP basic authentication group password file.

Syntax

path

Zconf SHM Directory

Description

The location where zero config shared memory files are stored. The default directory is $SERVER_ROOT/zconf.

Syntax

path

File Name

Description

Specifies the path for the log file.

Syntax

Filename which can be an absolute path or a relative path to $SERVER_ROOT.

Tips

Place the log file on a separate disk.

Log Level

Description

Specifies the level of logging to include in your log file. Available levels (from high to low) are: ERROR, WARNING, NOTICE, INFO and DEBUG. Only messages with level higher or equal to the current setting will be logged.

Syntax

Select from drop down list

Tips

Using DEBUG log level does not have any performance impact, unless Debug Level is set to a level other than NONE. It's recommended to set Log Level to DEBUG and Debug Level to NONE. These settings mean that you will not fill up your hard disk with debug logging, but you will be able to use the Toggle Debug Logging action to control debug output. This action can turn debug logging on and off on the fly, and is useful for debugging busy production servers.

See Also

Debug Level

Debug Level

Description

Specifies the level of debug logging. Log Level must be set to DEBUG to use this feature. Debug logging is disabled when "Debug Level" is set to NONE even if Log Level is set to DEBUG. Toggle Debug Logging can be used to control debug level on a live server without restarting.

Syntax

Select from drop down list

Tips

Important! Always set this to NONE if you do not need detailed debug logging. Active debug logging will severely degrade service performance and potentially saturate disk space in a very short time. Debug logging includes detailed information for each request and response.

It's recommended to set Log Level to DEBUG and Debug Level to NONE. These settings mean that you will not fill up your hard disk with debug logging, but you will be able to use the Toggle Debug Logging action to control debug output. This action can turn debug logging on and off on the fly, and is useful for debugging busy production servers.

See Also

Log Level, Toggle Debug Logging

Rolling Size (bytes)

Description

Specifies when the current log file needs to be rolled over, also known as log rotation. When the file size is over the rollover limit, the active log file will be renamed to log_name.mm_dd_yyyy(.sequence) in the same directory and a new active log file will be created. The actual size of the rotated log file once it is created will sometimes be a little bigger than this size limit. Set to 0 to disable log rotation.

Syntax

Integer number

Tips

Append "K", "M", "G" to the number for kilo-, mega- and giga- bytes.

File Name

Description

The access log filename.

Syntax

Filename which can be an absolute path or a relative path to $SERVER_ROOT.

Tips

Put access log file on a separate disk.

Piped Logger

Description

Specifies an external application that will receive the access log data sent by LiteSpeed through a pipe on its STDIN stream (file handle 0). When specified, the access log will be sent to the logger application instead of the access log file specified in previous entry.

LiteSpeed load balancer performs simple load balancing among multiple logger applications if more than one instance of a logger application is configured. LiteSpeed Web Server always attempts to keep the number of logger processes as low as possible. Only when one logger application fails to process access log entries in time will the server attempt to spawn another logger application instance.

If a logger process crashes, the server will start another instance but the log data in the stream buffer will be lost. It is possible to lose log data if external loggers cannot keep up with the speed and volume of the log stream.
File path to the logger application should be given here, and optionally, the number of application instances can be set before the file path, followed by '|'.

Syntax

[<intances>|]<path_to_logger_app>

Example

4|/path/to/logger/app
tells the server to start up to 4 logger processes.

/path/to/logger/app
tells the server to start only one logger process.

Log Format

Description

Specifies the log format for the access log. When log format is set, it will override the Log Headers setting.

Syntax

String. The syntax of log format is compatible with Apache 2.0's custom log format.

Example

Common Log Format (CLF)
"%h %l %u %t \"%r\" %>s %b"

Common Log Format with Virtual Host
"%v %h %l %u %t \"%r\" %>s %b"

NCSA extended/combined log format
"%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"

Log cookie value of Foobar
"%{Foobar}C"

See Also

Log Headers

Log Headers

Description

Specifies whether to log HTTP request headers: Referer, UserAgent, and Host.

Syntax

Select from checkbox

Tips

Turn this off if you do not need these headers in the access log.

See Also

Log Format

Keep Days

Description

Specifies how many days the access log file will be kept on disk. Only rotated log files older than the specified number of days will be deleted. The current log file will not be touched regardless how many days worth of data it contains. If you do not want to auto-delete stale and very old log files, set this to 0.

Syntax

Integer number

Compress Archive

Description

Specifies whether to compress rotated log files in order to save disk space.

Syntax

Select from radio box

Tips

Log files are highly compressible and this is recommended to reduce disk usage for old logs.

Access Control

Description

Specifies what sub networks and/or IP addresses can send zero config messages to LiteSpeed Web ADC when zero config is enabled.

Allowed List

Description

Specifies the list of IPs or sub-networks allowed. * or ALL are accepted.

Syntax

Comma delimited list of IP addresses or sub-networks. A trailing "T" can be used to indicate a trusted IP or sub-network, such as 192.168.1.*T.

Example

Sub-networks: 192.168.1.0/255.255.255.0, 192.168.1.0/24, 192.168.1, or 192.168.1.*
IPv6 addresses: ::1 or [::1]
IPv6 subnets: 3ffe:302:11:2:20f:1fff:fe29:717c/64 or [3ffe:302:11:2:20f:1fff:fe29:717c]/64

Denied List

Description

Specifies the list of IPs or sub-networks disallowed.

Syntax

Comma delimited list of IP addresses or sub-networks. * or ALL are accepted.

Example

Sub-networks: 192.168.1.0/255.255.255.0, 192.168.1.0/24, 192.168.1, or 192.168.1.*
IPv6 addresses: ::1 or [::1]
IPv6 subnets: 3ffe:302:11:2:20f:1fff:fe29:717c/64 or [3ffe:302:11:2:20f:1fff:fe29:717c]/64

Zconf Listeners

Description

Secure SSL listeners that will listen for zero config messages only.

Listener Name

Description

A unique name for this listener.

Address

Description

Address of listener that will only accept Zconf configuration and control messages.

Syntax

IP:port

Private Key File

Description

The filename of the SSL private key file. The key file should not be encrypted.

Syntax

Filename which can be an absolute path or a relative path to $SERVER_ROOT.

Tips

The private key file should be placed in a secured directory that allows read-only access to the user the server runs as.

Certificate File

Description

The filename of the SSL certificate file.

Syntax

Filename which can be an absolute path or a relative path to $SERVER_ROOT.

Tips

The certificate file should be placed in a secured directory, which allows read-only access to the user that the server runs as.

CA Certificate File

Description

Specifies the file that contains all certificates of certification authorities (CAs) for chained certificates. This file is simply the concatenation of PEM-encoded certificate files, in order of preference. This can be used as an alternative or in addition to CA Certificate Path. Those certificates are used for client certificate authentication and constructing the server certificate chain, which will be sent to browsers in addition to the server certificate.

Syntax

Filename which can be an absolute path or a relative path to $SERVER_ROOT.