In Domino 8.5.1 Administrator, you can enable, disable, and configure gzip compression using either NOTES.INI settings or settings on the Web Site document. These two methods of configuring gzip compression are mutually exclusive. When you use the NOTES.lNI file settings to configure gzip compression, the settings apply at the server level. When you use the settings in the Web Site document to configure gzip compression, the settings apply to individual Web sites. Prior to Domino 8.5.1, you could enable or disable gzip compression using a NOTES.INI file setting.

The NOTES.INI settings only apply if the Web server is configured from the Web Configuration view. The NOTES.INI settings do not apply when the Web server is configured to use the Web Site document from the Internet Sites View. The Server document setting "Load Internet configurations from Server\Internet documents" determines which configuration view is used by the Web server.

The IBMŸ LotusŸ DominoŸ 8.5.1 Web server serves files compressed by gzip (GNU zip) given the following conditions:

• If the Server document setting "Load Internet configurations from Server/Internet documents" is disabled, the server's NOTES.INI file must not contain the following setting: HTTPDisablePreCompressedGzipFiles=1. This setting disables checking for file system compressed files. If the Server document setting "Load Internet configurations from Server/Internet documents" is enabled, the setting "Compress output" in each Web Site document determines whether the server checks for compressed files.
• The name of the compressed file is the name of the original file with an additional extension of .gz. For example, the gzip counterpart of c:\notes\data\domino\html\foo.html is c:\notes\data\domino\html\foo.html.gz. (A browser sees this file as http://<servername>/foo.html.)
• The gzip file must be present in the same directory as the original file. The original file is served if it is newer than the gzip file or compression is disabled and the gzip file is smaller than the original file.
• The browser or other client must send the request header Accept-Encoding: gzip (the default for most browsers).
• The MIME Content-type of the file must match the MIME types specified by the NOTES.INI setting "HTTPIncludeMimeTypes" if using the Web Configuration View or the setting "Include Mime Types" if using Internet Sites. The server default is "text/*" (all subtypes of type text) and application/* (all subtypes of type application).
• The MIME Content-type of the file does NOT match the MIME types specified in the NOTES.INI setting "HTTPExcludeMimeTypes" if using the Web Configuration View or the "Exclude Mime Types" if you are using Internet Sites. The server default is "application/x-gzip" (gzip files) and application/x-zip* (zip files).
• The server does not support sending a range of bytes for a file that has a gzip counterpart. The server does not send "Accept-Ranges: bytes" in the HTTP header and sends the entire compressed file.

File System NOTES.INI settings

These NOTES.INI settings are applied at the server level. Use these settings if you are working in the Web Configuration view.

HTTPDisablePreCompressedGzipFiles

Allows you to disable checking for and serving gzip compressed versions of static files. When this setting is set to disable, all other file system gzip settings have no effect. The default for the server is to check for compressed files. If this setting is not present in the NOTES.INI file, it is enabled by default.

HTTPDisablePreCompressedGzipFiles=1 -- Disables checking for and serving file system compressed files.

Applies to: Servers

HTTPCreatePreCompressedGzipFiles

Causes the server to create gzip compressed files from uncompressed files when the files are requested by an HTTP client. Compressed files are created when they do not exist or the uncompressed version of the file has a time-date stamp that is later than the compressed version of the file. The default is disabled.

HTTPCreatePreCompressedGzipFiles=1 -- Enables the dynamic creation of compressed files.

Applies to: Servers

HTTPCompressWaitTime

Allows you to change the time-out for a pending HTTP request that is waiting for compression to complete. The default setting is 500 milliseconds. If two or more HTTP clients request a file that needs to be compressed, the server compresses the file for one client. While that compression takes place, all other requests for that file wait for compression to complete. If the client wait time exceeds the time-out value, the original uncompressed file is delivered to the HTTP client. It is strongly recommended that very large files be compressed off-line. Compressing large files can create a server "bottle neck" when there are many requests for the same large file while the file is being compressed by the server.

HTTPCompressWaitTime=500 -- Specifies a thread wait time of 500 milliseconds for compression to complete.

Applies to: Servers

HTTPCompressMinFileSize

Allows you to specify the minimum file size of files to be considered for compression. The default is 300 bytes. If a file is smaller than the minimum file size specified for a file, a compressed file is not created.

HTTPCompressMinFileSize=300 -- Specifies a value of 300 bytes as the minimum file size of a file to be considered for compression.

Applies to: Servers

HTTPIncludeMIMETypes

Specify the types of MIME files that can be considered for compression. MIME types that are specified in the "HTTPExcludeMIMETypes" NOTES.INI setting will not be compressed even if they fit the parameters of MIME types to be included for compression. To enter multiple MIME types, separate each type with a semicolon (;).

HTTPIncludeMimeTypes=text/*;application/*

HTTPExcludeMIMETypes

Specify the types of MIME files to be excluded from consideration for compression. File types specified here should be a subset of those types specified in the "HTTPIncludeMIMETypes" NOTES.INI setting. To enter multiple MIME types, separate each type with a semicolon (;).

HTTPExcludeMimeTypes=application/x-gzip;application/x-zip

Domino NOTES.INI settings

These NOTES.INI settings are applied at the server level. Use the Web Site document available from the Internet Sites view to apply settings to individual Web sites.

DominoGzipEnabled

Allows you to enable compression for Domino Web engine output. This option is disabled by default. Compression of output only applies to HTTP clients that support gzip (GNU zip) compression.

DominoGzipEnabled=1-- Enables compression of Domino Web engine output

Applies to: Servers

DominoGzipCompressToFileThreshold

Specify the minimum size of content that will be compressed to disk. If response content is greater than the value of this setting, the compression of the content will be done to a temporary disk file to reduce process memory usage. The default setting is 1 MB.

DominoGzipCompressToFileThreshold=1

Applies to: Servers

DominoGzipMinBytesToCompress

Specify the minimum size of content that can be compressed. The default setting is 300 bytes.

DominoGzipMinBytesToCompress

Applies to: Servers

DominoIncludeMIMETypes

Specify the MIME types to consider for compression. MIME types that are specified in the "DominoExcludeMIMETypes" NOTES.INI setting will not be compressed even if they fit the parameters of MIME types to be included for compression. To enter multiple MIME types, separate each type with a semicolon (;).

DominoIncludeMimeTypes=text/*;application/*

Applies to: Servers

DominoExcludeMIMETypes

Specify the MIME types to be excluded from consideration for compression. Output types specified here should be a subset of those types specified in the "DominoIncludeMIMETypes" NOTES.INI setting. To enter multiple MIME types, separate each type with a semicolon (;).

DominoIncludeMimeTypes=application/x-gzip;application/x-zip

Applies to: Servers

For information about setting up gzip compression for individual Web sites, see the topics "Setting up Web server gzip compression on the Web Site document" and "Setting file system compression settings on the Web Site document."

Related topics

Setting up Web server gzip compression on the Web Site document
Setting file system compression settings on the Web Site document
Hosting Web sites
The Domino Web server

Glossary