Compression schemes for Microsoft IIS
Перейти к файлу
Baris Caglar 421d5ef2ca Update iis.compression.build.dev.yml for Azure Pipelines 2019-08-13 13:41:08 -07:00
.github add CODEOWNERS 2018-04-16 17:56:41 -07:00
.pipelines Update iis.compression.build.dev.yml for Azure Pipelines 2019-08-13 13:41:08 -07:00
CustomAction Move IISCompression installer from VSTS to Github (#21) 2019-03-29 15:25:05 -07:00
IIS-Common@bde8e15a52 Update submodule reference to the latest Brotli v1.0.7 (#32) 2019-06-19 11:51:51 -07:00
IIS-Setup@c11b9dc044 Move IISCompression installer from VSTS to Github (#21) 2019-03-29 15:25:05 -07:00
Installer more type fix 2019-05-03 15:35:37 -07:00
brotli Update submodule reference to the latest Brotli v1.0.7 (#32) 2019-06-19 11:51:51 -07:00
build Move IISCompression installer from VSTS to Github (#21) 2019-03-29 15:25:05 -07:00
iisbrotli update error handling (#31) 2019-06-13 11:12:53 -07:00
iiszlib update error handling (#31) 2019-06-13 11:12:53 -07:00
submodules Update submodule reference to the latest Brotli v1.0.7 (#32) 2019-06-19 11:51:51 -07:00
zlib Excluded warnings specifically from zlib library 2019-05-08 14:12:06 -07:00
.gitattributes add submodule props and other config files 2018-04-09 18:48:01 -07:00
.gitignore Compression level validation (#17) 2018-10-01 18:44:15 -07:00
.gitmodules Move IISCompression installer from VSTS to Github (#21) 2019-03-29 15:25:05 -07:00
Compression.sln Move IISCompression installer from VSTS to Github (#21) 2019-03-29 15:25:05 -07:00
LICENSE Update file header, third party notice, and license based on the legal review (#8) 2018-04-24 22:32:31 -07:00
NuGet.config add submodule props and other config files 2018-04-09 18:48:01 -07:00
README.md Update build status badge markdown 2019-07-25 18:09:17 -07:00
ThirdPartyNotices.txt update readme and tpn (#11) 2018-05-01 13:42:49 -07:00
azure-pipelines.yml Update azure-pipelines.yml for Azure Pipelines 2019-04-17 13:53:38 -07:00
build.cmd add build.cmd 2018-04-10 18:37:34 -07:00
cgmanifest.json Update submodule reference to the latest Brotli v1.0.7 (#32) 2019-06-19 11:51:51 -07:00

README.md

Build Status

Microsoft IIS Compression

IIS Compression is a bundle of two IIS compression scheme providers iisbrotli.dll and iiszlib.dll that enable IIS to compress HTTP response contents. iisbrotli.dll supports Brotli compression, while iiszlib.dll supports both Gzip and Deflate compression.

An IIS compression scheme provider is a pluggable extension of IIS StaticCompressionModule and DynamicCompressionModule - essentially a dynamic link library (dll) that implements the compression algorithm and exposes the IIS HTTP Compression API. IIS StaticCompressionModule and DynamicCompressionModule load the registered compression scheme providers into worker process at runtime, and leverage them to perform compression for static files and dynamically-generated contents, respectively.

Documentation

Installation

Download the Microsoft IIS Compression release from the following locations:

  • Microsoft IIS Compression (x86) here.

  • Microsoft IIS Compression (x64) here.

The IIS Compression installer registers iisbrotli.dll as the br (Brotli) compression scheme provider in applicationHost.config. It also replaces the default gzip compression scheme provider gzip.dll with iiszlib.dll. A sample httpCompression section in applicationHost.config is shown below:

<httpCompression directory="%SystemDrive%\inetpub\temp\IIS Temporary Compressed Files">
    <scheme name="br" dll="%ProgramFiles%\IIS\IIS Compression\iisbrotli.dll" />
    <scheme name="gzip" dll="%ProgramFiles%\IIS\IIS Compression\iiszlib.dll" />
    <dynamicTypes>
        <add mimeType="text/*" enabled="true" />
        <add mimeType="message/*" enabled="true" />
        <add mimeType="application/x-javascript" enabled="true" />
        <add mimeType="application/javascript" enabled="true" />
        <add mimeType="*/*" enabled="false" />
    </dynamicTypes>
    <staticTypes>
        <add mimeType="text/*" enabled="true" />
        <add mimeType="message/*" enabled="true" />
        <add mimeType="application/javascript" enabled="true" />
        <add mimeType="application/atom+xml" enabled="true" />
        <add mimeType="application/xaml+xml" enabled="true" />
        <add mimeType="image/svg+xml" enabled="true" />
        <add mimeType="*/*" enabled="false" />
    </staticTypes>
</httpCompression>

Build

  1. Clone this project with submodules.
git clone --recurse-submodules https://github.com/Microsoft/IIS.Compression.git
  1. Build the code using the build.cmd (the location of msbuild.exe needs to be added into PATH environment variable).

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.