Skip to main content
OCLC Support


Learn how to use the LBPeer config.txt directive to specify hostnames and ports for load balanced servers in EZproxy.

LBPeer specifies hostnames and ports that EZproxy load balanced servers can use to communicate with each other when necessary. LBPeer should be used when Option UserObject is employed on multiple EZproxy servers, all of which operate with a single name behind a load balancer. When a user object is created, it is stored on a specific back-end EZproxy server. With LBPeer enabled, the ticket generated to retrieve a user object incorporates the id value that identifies that back-end server that holds the user object. When a request is placed to retrieve the user object, the id is used to identify if the server holding the user object received the request. This enables a request for the user object to be passed on if necessary to the server that holds it.

LBPeer is a repeatable position-dependent config.txt directive.


Qualifier Description
-Host=host The hostname or IP address to use to communicate directly with this server.
-http=port The port to use to communicate directly with this server using http. If -http is specified, -https cannot be specified.
-https=port The port to use to communicate directly with this server using https. If -https is specified, -http cannot be specified.
id The identifier to use to tag content which must be handled by this server.


LBPeer -Host= host [-http= port | -https= port] id


Specify information on three load balancer hosts. EZproxy will open a listening socket on the local server for each of the hostnames on the local server to determine which the LBPeer directive represents the local server. If none of the hostnames match, the EZproxy will record a warning and then ignore all LBPeer directives.

LBPeer -https=443 ezproxy1
LBPeer -https=443 ezproxy2
LBPeer -https=443 ezproxy3

Related directives

Option UserObject