diff --git a/aspnetcore/host-and-deploy/iis/modules.md b/aspnetcore/host-and-deploy/iis/modules.md index ebc209aaa4..0a1e5333b2 100644 --- a/aspnetcore/host-and-deploy/iis/modules.md +++ b/aspnetcore/host-and-deploy/iis/modules.md @@ -4,52 +4,52 @@ author: guardrex description: Discover active and inactive IIS modules for ASP.NET Core apps and how to manage IIS modules. ms.author: riande ms.custom: mvc -ms.date: 04/04/2018 +ms.date: 10/12/2018 uid: host-and-deploy/iis/modules --- # IIS modules with ASP.NET Core By [Luke Latham](https://github.com/guardrex) -ASP.NET Core apps are hosted by IIS in a reverse proxy configuration. Some of the native IIS modules and all of the IIS managed modules aren't available to process requests for ASP.NET Core apps. In many cases, ASP.NET Core offers an alternative to the features of IIS native and managed modules. +Some of the native IIS modules and all of the IIS managed modules aren't able to process requests for ASP.NET Core apps. In many cases, ASP.NET Core offers an alternative to the scenarios addressed by IIS native and managed modules. ## Native modules The table indicates native IIS modules that are functional on reverse proxy requests to ASP.NET Core apps. | Module | Functional with ASP.NET Core apps | ASP.NET Core Option | -| ------ | :-------------------------------: | ------------------- | -| **Anonymous Authentication**
`AnonymousAuthenticationModule` | Yes | | -| **Basic Authentication**
`BasicAuthenticationModule` | Yes | | -| **Client Certification Mapping Authentication**
`CertificateMappingAuthenticationModule` | Yes | | -| **CGI**
`CgiModule` | No | | -| **Configuration Validation**
`ConfigurationValidationModule` | Yes | | -| **HTTP Errors**
`CustomErrorModule` | No | [Status Code Pages Middleware](xref:fundamentals/error-handling#configure-status-code-pages) | -| **Custom Logging**
`CustomLoggingModule` | Yes | | -| **Default Document**
`DefaultDocumentModule` | No | [Default Files Middleware](xref:fundamentals/static-files#serve-a-default-document) | -| **Digest Authentication**
`DigestAuthenticationModule` | Yes | | -| **Directory Browsing**
`DirectoryListingModule` | No | [Directory Browsing Middleware](xref:fundamentals/static-files#enable-directory-browsing) | -| **Dynamic Compression**
`DynamicCompressionModule` | Yes | [Response Compression Middleware](xref:performance/response-compression) | -| **Tracing**
`FailedRequestsTracingModule` | Yes | [ASP.NET Core Logging](xref:fundamentals/logging/index#tracesource-provider) | -| **File Caching**
`FileCacheModule` | No | [Response Caching Middleware](xref:performance/caching/middleware) | -| **HTTP Caching**
`HttpCacheModule` | No | [Response Caching Middleware](xref:performance/caching/middleware) | -| **HTTP Logging**
`HttpLoggingModule` | Yes | [ASP.NET Core Logging](xref:fundamentals/logging/index)
Implementations: [elmah.io](https://github.com/elmahio/Elmah.Io.Extensions.Logging), [Loggr](https://github.com/imobile3/Loggr.Extensions.Logging), [NLog](https://github.com/NLog/NLog.Extensions.Logging), [Sentry](https://github.com/getsentry/sentry-dotnet), [Serilog](https://github.com/serilog/serilog-extensions-logging) -| **HTTP Redirection**
`HttpRedirectionModule` | Yes | [URL Rewriting Middleware](xref:fundamentals/url-rewriting) | +| --- | :---: | --- | +| **Anonymous Authentication**
`AnonymousAuthenticationModule` | Yes | | +| **Basic Authentication**
`BasicAuthenticationModule` | Yes | | +| **Client Certification Mapping Authentication**
`CertificateMappingAuthenticationModule` | Yes | | +| **CGI**
`CgiModule` | No | | +| **Configuration Validation**
`ConfigurationValidationModule` | Yes | | +| **HTTP Errors**
`CustomErrorModule` | No | [Status Code Pages Middleware](xref:fundamentals/error-handling#configure-status-code-pages) | +| **Custom Logging**
`CustomLoggingModule` | Yes | | +| **Default Document**
`DefaultDocumentModule` | No | [Default Files Middleware](xref:fundamentals/static-files#serve-a-default-document) | +| **Digest Authentication**
`DigestAuthenticationModule` | Yes | | +| **Directory Browsing**
`DirectoryListingModule` | No | [Directory Browsing Middleware](xref:fundamentals/static-files#enable-directory-browsing) | +| **Dynamic Compression**
`DynamicCompressionModule` | Yes | [Response Compression Middleware](xref:performance/response-compression) | +| **Tracing**
`FailedRequestsTracingModule` | Yes | [ASP.NET Core Logging](xref:fundamentals/logging/index#tracesource-provider) | +| **File Caching**
`FileCacheModule` | No | [Response Caching Middleware](xref:performance/caching/middleware) | +| **HTTP Caching**
`HttpCacheModule` | No | [Response Caching Middleware](xref:performance/caching/middleware) | +| **HTTP Logging**
`HttpLoggingModule` | Yes | [ASP.NET Core Logging](xref:fundamentals/logging/index) | +| **HTTP Redirection**
`HttpRedirectionModule` | Yes | [URL Rewriting Middleware](xref:fundamentals/url-rewriting) | | **IIS Client Certificate Mapping Authentication**
`IISCertificateMappingAuthenticationModule` | Yes | | -| **IP and Domain Restrictions**
`IpRestrictionModule` | Yes | | -| **ISAPI Filters**
`IsapiFilterModule` | Yes | [Middleware](xref:fundamentals/middleware/index) | -| **ISAPI**
`IsapiModule` | Yes | [Middleware](xref:fundamentals/middleware/index) | -| **Protocol Support**
`ProtocolSupportModule` | Yes | | -| **Request Filtering**
`RequestFilteringModule` | Yes | [URL Rewriting Middleware `IRule`](xref:fundamentals/url-rewriting#irule-based-rule) | -| **Request Monitor**
`RequestMonitorModule` | Yes | | -| **URL Rewriting**
`RewriteModule` | Yes† | [URL Rewriting Middleware](xref:fundamentals/url-rewriting) | -| **Server-Side Includes**
`ServerSideIncludeModule` | No | | -| **Static Compression**
`StaticCompressionModule` | No | [Response Compression Middleware](xref:performance/response-compression) | -| **Static Content**
`StaticFileModule` | No | [Static File Middleware](xref:fundamentals/static-files) | -| **Token Caching**
`TokenCacheModule` | Yes | | -| **URI Caching**
`UriCacheModule` | Yes | | -| **URL Authorization**
`UrlAuthorizationModule` | Yes | [ASP.NET Core Identity](xref:security/authentication/identity) | -| **Windows Authentication**
`WindowsAuthenticationModule` | Yes | | +| **IP and Domain Restrictions**
`IpRestrictionModule` | Yes | | +| **ISAPI Filters**
`IsapiFilterModule` | Yes | [Middleware](xref:fundamentals/middleware/index) | +| **ISAPI**
`IsapiModule` | Yes | [Middleware](xref:fundamentals/middleware/index) | +| **Protocol Support**
`ProtocolSupportModule` | Yes | | +| **Request Filtering**
`RequestFilteringModule` | Yes | [URL Rewriting Middleware `IRule`](xref:fundamentals/url-rewriting#irule-based-rule) | +| **Request Monitor**
`RequestMonitorModule` | Yes | | +| **URL Rewriting**†
`RewriteModule` | Yes | [URL Rewriting Middleware](xref:fundamentals/url-rewriting) | +| **Server-Side Includes**
`ServerSideIncludeModule` | No | | +| **Static Compression**
`StaticCompressionModule` | No | [Response Compression Middleware](xref:performance/response-compression) | +| **Static Content**
`StaticFileModule` | No | [Static File Middleware](xref:fundamentals/static-files) | +| **Token Caching**
`TokenCacheModule` | Yes | | +| **URI Caching**
`UriCacheModule` | Yes | | +| **URL Authorization**
`UrlAuthorizationModule` | Yes | [ASP.NET Core Identity](xref:security/authentication/identity) | +| **Windows Authentication**
`WindowsAuthenticationModule` | Yes | | †The URL Rewrite Module's `isFile` and `isDirectory` match types don't work with ASP.NET Core apps due to the changes in [directory structure](xref:host-and-deploy/directory-structure). @@ -83,12 +83,12 @@ If an IIS module is configured at the server level that must be disabled for an ### Module deactivation -Many modules offer a configuration setting that allows them to be disabled without removing the module from the app. This is the simplest and quickest way to deactivate a module. For example, the HTTP Redirection Module can be disabled with the **\** element in *web.config*: +Many modules offer a configuration setting that allows them to be disabled without removing the module from the app. This is the simplest and quickest way to deactivate a module. For example, the HTTP Redirection Module can be disabled with the `` element in *web.config*: ```xml - + ``` @@ -97,23 +97,23 @@ For more information on disabling modules with configuration settings, follow th ### Module removal -If opting to remove a module with a setting in *web.config*, unlock the module and unlock the **\** section of *web.config* first: +If opting to remove a module with a setting in *web.config*, unlock the module and unlock the `` section of *web.config* first: 1. Unlock the module at the server level. Select the IIS server in the IIS Manager **Connections** sidebar. Open the **Modules** in the **IIS** area. Select the module in the list. In the **Actions** sidebar on the right, select **Unlock**. Unlock as many modules as you plan to remove from *web.config* later. -2. Deploy the app without a **\** section in *web.config*. If an app is deployed with a *web.config* containing the **\** section without having unlocked the section first in the IIS Manager, the Configuration Manager throws an exception when attempting to unlock the section. Therefore, deploy the app without a **\** section. +2. Deploy the app without a `` section in *web.config*. If an app is deployed with a *web.config* containing the `` section without having unlocked the section first in the IIS Manager, the Configuration Manager throws an exception when attempting to unlock the section. Therefore, deploy the app without a `` section. -3. Unlock the **\** section of *web.config*. In the **Connections** sidebar, select the website in **Sites**. In the **Management** area, open the **Configuration Editor**. Use the navigation controls to select the `system.webServer/modules` section. In the **Actions** sidebar on the right, select to **Unlock** the section. +3. Unlock the `` section of *web.config*. In the **Connections** sidebar, select the website in **Sites**. In the **Management** area, open the **Configuration Editor**. Use the navigation controls to select the `system.webServer/modules` section. In the **Actions** sidebar on the right, select to **Unlock** the section. -4. At this point, a **\** section can be added to the *web.config* file with a **\** element to remove the module from the app. Multiple **\** elements can be added to remove multiple modules. If *web.config* changes are made on the server, immediately make the same changes to the project's *web.config* file locally. Removing a module this way won't affect the use of the module with other apps on the server. +4. At this point, a `` section can be added to the *web.config* file with a `` element to remove the module from the app. Multiple `` elements can be added to remove multiple modules. If *web.config* changes are made on the server, immediately make the same changes to the project's *web.config* file locally. Removing a module this way won't affect the use of the module with other apps on the server. ```xml - - - - - - + + + + + + ``` @@ -133,15 +133,13 @@ For example, remove the `DynamicCompressionModule` from the Default Web Site: The only modules required to run an ASP.NET Core app are the Anonymous Authentication Module and the ASP.NET Core Module. -![IIS Manager open to Modules with the minimum module configuration shown](modules/_static/modules.png) - The URI Caching Module (`UriCacheModule`) allows IIS to cache website configuration at the URL level. Without this module, IIS must read and parse configuration on every request, even when the same URL is repeatedly requested. Parsing the configuration every request results in a significant performance penalty. *Although the URI Caching Module isn't strictly required for a hosted ASP.NET Core app to run, we recommend that the URI Caching Module be enabled for all ASP.NET Core deployments.* The HTTP Caching Module (`HttpCacheModule`) implements the IIS output cache and also the logic for caching items in the HTTP.sys cache. Without this module, content is no longer cached in kernel mode, and cache profiles are ignored. Removing the HTTP Caching Module usually has adverse effects on performance and resource usage. *Although the HTTP Caching Module isn't strictly required for a hosted ASP.NET Core app to run, we recommend that the HTTP Caching Module be enabled for all ASP.NET Core deployments.* ## Additional resources -* [Host on Windows with IIS](xref:host-and-deploy/iis/index) +* * [Introduction to IIS Architectures: Modules in IIS](/iis/get-started/introduction-to-iis/introduction-to-iis-architecture#modules-in-iis) * [IIS Modules Overview](/iis/get-started/introduction-to-iis/iis-modules-overview) * [Customizing IIS 7.0 Roles and Modules](https://technet.microsoft.com/library/cc627313.aspx) diff --git a/aspnetcore/host-and-deploy/iis/modules/_static/modules.png b/aspnetcore/host-and-deploy/iis/modules/_static/modules.png deleted file mode 100644 index 034dd9ed25..0000000000 Binary files a/aspnetcore/host-and-deploy/iis/modules/_static/modules.png and /dev/null differ