# HTTP configuration (part 1) These Liberator configuration items define how Liberator handles HTTP connections with clients. **💡 TIP**\ Liberator’s supplied with a built-in HTTP [Config blade](../deployment-framework/cdf-blade-types.md) that’s automatically activated when you install the Liberator (see [Built-in blades](../deployment-framework/cdf-built-in-blades.md)). For more about how to change the configuration of this blade, see How can I... [Configure how Liberator handles HTTP connections](liberator-configure-how-liberator-handles-http-connections.md). For more HTTP-related configuration items, see [HTTP configuration (part 2)](liberator-http-configuration-part-2.md). ## http-access-control-header `http-access-control-header` sets the HTTP Access-Control-Origin-Header (see the Wikipedia entry at [https://en.wikipedia.org/wiki/Cross-origin_resource_sharing](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)), which Liberator sends as an HTTP response to a client. The header permits client resources that were loaded from other webservers to access data from the Liberator server. The configuration item consists of one or more fully qualified web addresses (for example, `https://www.caplin.com`). These are the addresses of the resources (typically JavaScript files) that were loaded into the client and need the Liberator data. Use this configuration item to ensure security of access to Liberator by client applications that may use the following [StreamLink](../streamlink/index.md) connection types: * Streaming JavaScript via IFrame (when Server-Sent Events are turned off). * HTML5 Server-Sent Events * WebSocket If you don’t set this configuration item, or a requesting client resource was loaded from a web address that doesn’t match an address in the list, Liberator supplies the default value `**`, which allows access from all domains (and is therefore not secure). The [Wikipedia entry](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) states: "The value of "**" is special in that it does not allow requests to supply credentials, meaning HTTP authentication, client-side SSL certificates, nor does it allow cookies to be sent." **Syntax:** `http-access-control-header ` You can also specify multiple instances of `http-access-control-header` like this: ``` http-access-control-header web-address-A http-access-control-header web-address-B http-access-control-header web-address-C ``` **Type:** array of strings **Default value:** `*` (see description above) **Example:** ``` http-access-control-header https://application.mydomain.com http-access-control-header https://application2.anotherdomain.com ``` ## http-access-log `http-access-log` specifies the name of the HTTP access log file. The log filename can contain the parameters `%a` and `%h` At run time, `%a` is replaced by the Liberator’s application name (see the DataSource configuration item [application-name](../datasource/datasource-run-time-environment-configuration.md#application-name) ), and `%h` is replaced by the host name of the machine on which the Liberator is running. **Syntax:** `http-access-log ` **Type:** string **Default value:** `http-access-%a.log` which, by default, translates to `http-access-rttpd.log` ## http-connection-cookie-enable `http-connection-cookie-enable` when set to TRUE, causes Liberator to send a cookie to each client that connects over HTTP. Also see [http-connection-cookie-expires](#http-connection-cookie-expires). **Syntax:** `http-connection-cookie-enable ` **Type:** boolean **Default value:** `FALSE` ## http-connection-cookie-expires `http-connection-cookie-expires` specifies the number of days before a cookie sent to a client expires. Also see [http-connection-cookie-enable](#http-connection-cookie-enable). **Syntax:** `http-connection-cookie-expires ` **Type:** integer **Default value:** `1` day ## http-def-content-type `http-def-content-type` specifies the default HTTP content-type (MIME type). **Syntax:** `http-def-content-type ` **Type:** string **Default value:** `text/plain` ## http-err-content-type `http-err-content-type` specifies the content-type (MIME type) of error messages sent to clients. **Syntax:** `http-err-content-type ` **Type:** string **Default value:** `text/html` ## http-error-file-400 `http-error-file-400` specifies the filename of a custom page that’s returned to the client in response to an HTTP 400 error ("Bad Request"). **Syntax:** `http-error-file-400 ` **Type:** string **Default value:** The standard Error 400 page is returned to the client. ## http-error-file-401 `http-error-file-401` specifies the filename of a custom page that’s returned to the client in response to an HTTP 401 error ("Unauthorized"). **Syntax:** `http-error-file-401 ` **Type:** string **Default value:** The standard Error 401 page is returned to the client. ## http-error-file-403 `http-error-file-403` specifies the filename of a custom page that’s returned to the client in response to an HTTP 403 error ("Forbidden"). **Syntax:** `http-error-file-403 ` **Type:** string **Default value:** The standard Error 403 page is returned to the client. ## http-error-file-404 `http-error-file-404` specifies the filename of a custom page that’s returned to the client in response to an HTTP 404 error ("Not Found"). **Syntax:** `http-error-file-404 ` **Type:** string **Default value:** The standard Error 404 page is returned to the client. ## http-error-log `http-error-log` specifies the name of the HTTP error log file. This file contains information about all the HTTP requests that result in an "Object not found" error. The log filename can contain the parameters `%a` and `%h` At run time, `%a` is replaced by the Liberator’s application name (see the DataSource configuration item [application-name](../datasource/datasource-run-time-environment-configuration.md#application-name) ), and `%h` is replaced by the host name of the machine on which the Liberator is running. **Syntax:** `http-error-log ` **Type:** string **Default value:** `http-error-%a.log` which, by default, translates to `http-error-rttpd.log` ## http-extensions `http-extensions` specifies flags that enable various HTTP protocol extensions. These flags allow you to turn on HTTP features that can utilise the client-Liberator connection more efficiently. You can override and /or add to the settings of this item for a particular browser or browsers by using the extensions option of an [add-useragent](liberator-http-configuration-part-2.md#add-useragent) configuration item. **Syntax:** `http-extensions flag|flag|flag|...` You can also specify multiple instances of `http-extensions` like this: ``` http-extensions flag1 http-extensions flag2 http-extensions flag3 ``` **Type:** string **Valid flags are:** | Flag | Description | | --- | --- | | `force-type5-chunked` | This flag forces Liberator to use HTTP [chunked-transfer encoding](https://en.wikipedia.org/wiki/Chunked_transfer_encoding) when the [StreamLink](../streamlink/index.md) connection type is "Streaming JavaScript via IFrame" and Server-Sent Events are turned off. (This connection type is typically used when the browser is Microsoft Internet Explorer). Specify this flag to allow [RTTP](liberator-rttp.md) data to pass through proxies without being rejected. | | `allow-sse-deflate` | This flag allows Liberator to negotiate compression for the HTML5 Server-Sent Events connection type. Compression typically reduces the amount of traffic being sent by 50-60%, but it does have an adverse impact on both Liberator performance and latency. | | `allow-ws-permessage-deflate` | When using HTML5 WebSocket-based connections, during the opening handshake, the browser may offer to compress Websocket frames exchanged with the server using the DEFLATE compression algorithm. When the `allow-ws-permessage-deflate` flag is set, Liberator accepts such a request, and subsequent WebSocket frames can be compressed as necessary before they’re exchanged. At the time of writing (June 2014) the latest versions of the Chrome and Safari browsers can request permessage-deflate compression. For more about the DEFLATE algorithm, see [RFC 1951](https://www.ietf.org/rfc/rfc1951.txt). | **Default value:** +[no flags set]+ ## http-idx-content-type `http-idx-content-type` specifies the content-type (MIME type) of index pages sent to clients. **Syntax:** `http-idx-content-type ` **Type:** string **Default value:** `text/html` ## http-indexfile `http-indexfile` specifies a comma-separated list of files to attempt to use when a directory is requested. **Syntax:** `http-indexfile ` **Type:** string **Default value:** `index.html,index.js` ## http-interface `http-interface` specifies the network interfaces that Liberator listens on for HTTP connection requests. **📌 NOTE**\ In the [Caplin Platform Deployment Framework](../deployment-framework/index.md), you use a configuration macro `LIBERATOR${THIS_LEG}_HTTPINTERFACE` to specify Liberator’s `http-interface`. See [Configuration macros and items](../deployment-framework/cdf-configuration-macros-and-items.md) and How can I ... [Configure how Liberator handles HTTP connections](liberator-configure-how-liberator-handles-http-connections.md). **Syntax:** `http-interface ` **Type:** array of strings **Default value:** +[all available network interfaces]+ ## http-keepalive-max `http-keepalive-max` specifies the maximum number of requests the Liberator will allow per persistent HTTP connection. (Together with [http-keepalive-timeout](#http-keepalive-timeout), this configures the HTTP Keep Alive feature.) **Syntax:** `http-keepalive-max ` **Type:** integer **Default value:** `10000 requests` ## http-keepalive-timeout `http-keepalive-timeout` specifies the maximum time in seconds for which the Liberator will keep a persistent HTTP connection open. (Together with [http-keepalive-max](#http-keepalive-max), this configures the HTTP Keep Alive feature.) **Syntax:** `http-keepalive-timeout ` **Type:** integer **Default value:** `120 seconds` (2 minutes) ## http-max-body-length `http-max-body-length` specifies the maximum number of bytes allowed in the body of an HTTP message. **Syntax:** `http-max-body-length ` **Type:** integer **Default value:** `65536` ## http-max-header-line-length `http-max-header-line-length` specifies the maximum number of bytes allowed in a single HTTP header line. **Syntax:** `http-max-header-line-length ` **Type:** integer **Default value:** `65536` ## http-max-header-lines `http-max-header-lines` specifies the maximum number of header lines allowed in an HTTP message. **Syntax:** `http-max-header-lines ` **Type:** integer **Default value:** `30` ## http-max-request-length `http-max-request-length` specifies the maximum number of bytes allowed in a single HTTP request line (the line that contains a GET or a POST). **Syntax:** `http-max-request-length ` **Type:** integer **Default value:** `1024` ## http-port `http-port` specifies the network port that Liberator listens on for HTTP connection requests. **📌 NOTE**\ In the [Caplin Platform Deployment Framework](../deployment-framework/index.md), you use a configuration macro `LIBERATOR${THIS_LEG}_HTTPPORT` to specify Liberator’s `http-port`. See [Configuration macros and items](../deployment-framework/cdf-configuration-macros-and-items.md) and How can I ... [Configure how Liberator handles HTTP connections](liberator-configure-how-liberator-handles-http-connections.md). **Syntax:** `http-port ` **Type:** integer **Default value:** `8080` ## http-process-extension `http-process-extension` specifies the types of file on which the Liberator performs server-side processing. When such a file is to be served to a client, Liberator first searches it for processing directives and replaces the directives with their run-time equivalents. The processing directives supported are: | Processing directive | Is replaced by | | --- | --- | | `%%< http.username >%%` | The authenticated HTTP username | | `%%< http.password >%%` | The authenticated HTTP password | | `%%< http.request >%%` | The raw HTTP resource request | | `%%< http.filtered_request >%%` | The resource request filtered to prevent cross-site scripting attacks (XSS attacks) | | `%%< version >%%` | The Liberator version | **Syntax:** `http-process-extension filetype filetype filetype ...` You can also specify multiple instances of `http-process-extension` like this: ``` http-process-extension filetypeA http-process-extension filetypeB http-process-extension filetypeC ``` **📌 NOTE**\ Don’t add a '.' prefix to the file types. Thus, `xml` and `html` are correct, `.xml` and `.html` are incorrect. **Type:** array of strings **Default values:** The default setting is equivalent to `http-process-extension xml html js txt` ## http-refuse-time `http-refuse-time` specifies the time in seconds after which Liberator refuses new HTTP connections when no more sockets are available. **Syntax:** `http-refuse-time ` **Type:** float **Default value:** `5.0` seconds ## http-rttp-content-type `http-rttp-content-type` specifies the default content type for [RTTP](liberator-rttp.md) streams over HTTP. **Syntax:** `http-rttp-content-type ` **Type:** string **Default value:** `application/octet-stream` ## http-server-name `http-server-name` specifies the name of the Liberator server to be returned in the HTTP response headers. This item allows you change the name returned to something other than the default, which is sometimes advised for security reasons so that the type of server isn’t advertised to clients. **📌 NOTE**\ In the [Caplin Platform Deployment Framework](../deployment-framework/index.md), a configuration macro `LIBERATOR${THIS_LEG}_HTTP_SERVERNAME` is used to specify Liberator’s `http-server-name`. See [Configuration macros and items](../deployment-framework/cdf-configuration-macros-and-items.md). **Syntax:** `http-server-name ` **Type:** string **Default value:** string ## http-tcp-nodelay-off `http-tcp-nodelay-off` specifies whether Liberator’s HTTP client connection sockets should have the TCP_NODELAY feature turned off. The default is `FALSE`, which means TCP_NODELAY is enabled. Setting this configuration item to `TRUE` _disables_ TCP_NODELAY. **Syntax:** `http-tcp-nodelay-off ` **Type:** boolean **Default value:** `FALSE` (TCP_NODELAY is disabled) ## http-wwwroot `http-wwwroot` specifies the root directory of the Liberator’s HTML files. The directory path can contain the parameter `%r`, which is replaced at run time by the root directory ([application-root](../datasource/datasource-run-time-environment-configuration.md#application-root)) under which the Liberator runs. This item is overidden for specific virtual host connections by the [wwwroot](liberator-https-configuration.md#wwwroot) option of the [add-virtual-host](liberator-https-configuration.md#add-virtual-host) that defines the virtual host. **Syntax:** `http-wwwroot ` **Type:** string **Default value:** `%r/htdocs` --- **See also:** * How can I ... [Configure how Liberator handles HTTP connections](liberator-configure-how-liberator-handles-http-connections.md) * Reference: [HTTP configuration (part 2)](liberator-http-configuration-part-2.md) * Reference: [HTTPS configuration](liberator-https-configuration.md) * Reference: [RTTP configuration](liberator-rttp-configuration.md)