A virtual host provides a logical grouping for configuring web applications to a particular host name. The default virtual host (default_host) is suitable for most simple configurations.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
enabled | boolean | true | Enable this virtual host. |
allowFromEndpointRef | List of references to top level httpEndpoint elements (comma-separated string). | Specify the identifier of one or more HTTP endpoints to restrict inbound traffic for this virtual host to the specified endpoints. |
Associate a host and port with this virtual host, using the host:port syntax. The specified host can be an IP address, domain name server (DNS) hostname with a domain name suffix, the DNS hostname, or * for a wildcard match on all hostnames. Note that IPv6 addresses must be enclosed in [].
Specify the identifier of one or more HTTP endpoints to restrict inbound traffic for this virtual host to the specified endpoints.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
onError |
| WARN | Action to take after a failure to start an endpoint. IGNORE Server will not issue any warning and error messages when it incurs a configuration error. FAIL Server will issue a warning or error message on the first error occurrence and then stop the server. WARN Server will issue warning and error messages when it incurs a configuration error. |
enabled | boolean | true | Toggle the availability of an endpoint. When true, this endpoint will be activated by the dispatcher to handle HTTP requests. |
host | string | localhost | IP address, domain name server (DNS) host name with domain name suffix, or just the DNS host name, used by a client to request a resource. Use '*' for all available network interfaces. |
httpPort | int Min: -1 Max: 65535 | The port used for client HTTP requests. Use -1 to disable this port. | |
httpsPort | int Min: -1 Max: 65535 | The port used for client HTTP requests secured with SSL (https). Use -1 to disable this port. | |
httpOptionsRef | A reference to top level httpOptions element (string). | defaultHttpOptions | HTTP protocol options for the endpoint. |
sslOptionsRef | A reference to top level sslOptions element (string). | SSL protocol options for the endpoint. | |
tcpOptionsRef | A reference to top level tcpOptions element (string). | defaultTCPOptions | TCP protocol options for the endpoint. |
accessLoggingRef | A reference to top level httpAccessLogging element (string). | HTTP access logging configuration for the endpoint. |
allowFromEndpoint > httpOptions
HTTP protocol options for the endpoint.
Name | Type | Default | Description |
---|---|---|---|
keepAliveEnabled | boolean | true | Enables persistent connections (HTTP keepalive). If true, connections are kept alive for reuse by multiple sequential requests and responses. If false, connections are closed after the response is sent. |
maxKeepAliveRequests | int Min: -1 | 100 | Maximum number of persistent requests that are allowed on a single HTTP connection if persistent connections are enabled. A value of -1 means unlimited. |
persistTimeout | A period of time with second precision | 30s | Amount of time that a socket will be allowed to remain idle between requests. This setting only applies if persistent connections are enabled. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. |
readTimeout | A period of time with second precision | 60s | Amount of time to wait for a read request to complete on a socket after the first read occurs. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. |
writeTimeout | A period of time with second precision | 60s | Amount of time to wait on a socket for each portion of the response data to be transmitted. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. |
removeServerHeader | boolean | false | Removes server implementation information from HTTP headers and also disables the default Liberty profile welcome page. |
allowFromEndpoint > sslOptions
SSL protocol options for the endpoint.
Name | Type | Default | Description |
---|---|---|---|
sessionTimeout | A period of time with second precision | 1d | Amount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds. |
suppressHandshakeErrors | boolean | false | Disable logging of SSL handshake errors. SSL handshake errors can occur during normal operation, however these messages can be useful when SSL is behaving unexpectedly. |
sslRef | A reference to top level ssl element (string). | The default SSL configuration repertoire. The default value is defaultSSLSettings. | |
sslSessionTimeout | A period of time with millisecond precision | 8640ms | The timeout limit for an SSL session that is established by the SSL Channel. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. |
allowFromEndpoint > tcpOptions
TCP protocol options for the endpoint.
Name | Type | Default | Description |
---|---|---|---|
inactivityTimeout | A period of time with millisecond precision | 60s | Amount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. |
soReuseAddr | boolean | true | Enables immediate rebind to a port with no active listener. |
allowFromEndpoint > accessLogging
HTTP access logging configuration for the endpoint.
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | true | Enable access logging. |
filePath | Path to a file | ${server.output.dir}/logs/http_access.log | Directory path and name of the access log file. Standard variable substitutions, such as ${server.output.dir}, can be used when specifying the directory path. |
logFormat | string | %h %u %{t}W "%r" %s %b | Specifies the log format that is used when logging client access information. |
maxFileSize | int Min: 0 | 20 | Maximum size of a log file, in megabytes, before being rolled over; a value of 0 means no limit. |
maxFiles | int Min: 0 | 2 | Maximum number of log files that will be kept, before the oldest file is removed; a value of 0 means no limit. |