From 129e00847ededa8e2868ce4b2310791dfad7f213 Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Wed, 24 Mar 2021 13:51:14 -0700 Subject: [PATCH 01/13] READMEs for Servers --- src/Servers/HttpSys/README.md | 44 ++++++++++++++++++++++++++-- src/Servers/IIS/README.md | 55 +++++++++++++++++++++++++++++++++++ src/Servers/Kestrel/README.md | 41 ++++++++++++++++++++++---- src/Servers/README.md | 20 +++++++++++++ 4 files changed, 152 insertions(+), 8 deletions(-) create mode 100644 src/Servers/IIS/README.md create mode 100644 src/Servers/README.md diff --git a/src/Servers/HttpSys/README.md b/src/Servers/HttpSys/README.md index 380919f82868..5b0856867c31 100644 --- a/src/Servers/HttpSys/README.md +++ b/src/Servers/HttpSys/README.md @@ -1,4 +1,42 @@ -HttpSysServer -============= +# HttpSys -This repo contains a web server for ASP.NET Core based on the Windows [Http Server API](https://msdn.microsoft.com/en-us/library/windows/desktop/aa364510.aspx). +ASP.NET Core HttpSys Web Server is a web server that uses the [Windows Hypertext Transfer Protocol Stack](https://docs.microsoft.com/en-us/iis/get-started/introduction-to-iis/introduction-to-iis-architecture#hypertext-transfer-protocol-stack-httpsys). + +Documentation for ASP.NET Core HttpSys can be found in the [ASP.NET Core HTTP.sys Docs](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/httpsys). + +## Description + +This folder contains all relevant code for the HttpSys Web Server implementation. + +- `src/`: Contains all production code for the HttpSys Web Server. +- `src/NativeInterop`: Contains the native interop layer between managed and native code. +- `src/RequestProcessing`: Contains request and response processing code. +- `samples`: Contains samples showing how to use HTTP.sys. + +## Development Setup + +### Build + +HTTP.sys can only be used on Windows. + +To build this specific project from source, you can follow the instructions [on building a subset of the code](https://github.com/dotnet/aspnetcore/blob/main/docs/BuildFromSource.md#building-a-subset-of-the-code). + +Or for the less detailed explanation, run the following command inside this directory. +```powershell +> ./build.cmd +``` + +### Test + +To run the tests for this project, you can [run the tests on the command line](https://github.com/dotnet/aspnetcore/blob/main/docs/BuildFromSource.md#running-tests-on-command-line) in this directory. + +Or for the less detailed explanation, run the following command inside this directory. +```powershell +> ./build.cmd -t +``` + +You can also run project specific tests by running `dotnet test` in the `tests` directory next to the `src` directory of the project. + +## More Information + +For more information, see the [ASP.NET Core README](../../../README.md). diff --git a/src/Servers/IIS/README.md b/src/Servers/IIS/README.md new file mode 100644 index 000000000000..478b572340cc --- /dev/null +++ b/src/Servers/IIS/README.md @@ -0,0 +1,55 @@ +# IIS + +ASP.NET Core IIS Web Server is a flexible secure managed Web Server to be hosted with IIS on Windows. + +Documentation for ASP.NET Core IIS can be found in the [ASP.NET Core IIS Docs](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/iis/). + +## Description + +This folder contains all relevant code for the IIS Web Server implementation. + +There are two modes for hosting application with IIS: in-process and out-of-process. In-process will run all managed code inside of the IIS worker process, while out-of-process will use IIS as a reverse-proxy to a dotnet app running Kestrel. + +The following contains a description of the sub-directories. + +- `AspNetCoreModuleV2`: Contains all native code that is part of the [ASP.NET Core Module](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/aspnet-core-module?view=aspnetcore-5.0). +- `AspNetCoreModuleV2/AspNetCore`: Contains the ASP.NET Core Module shim, a minimal layer for IIS to interact with the in-process and out-of-process modules. +- `AspNetCoreModuleV2/CommonLib`: Contains common code shared between all native components. +- `AspNetCoreModuleV2/CommonLibTests`: Contains native tests for the ASP.NET Core Module. +- `AspNetCoreModuleV2/IISLib`: Contains common code for interactions with IIS. +- `AspNetCoreModuleV2/InProcessRequestHandler`: Contains native code for in-process hosting. +- `AspNetCoreModuleV2/OutOfProcessRequestHandler`: Contains native code for out-of-process hosting. +- `AspNetCoreModuleV2/RequestHandlerLib`: Contains shared code between in-process and out-of-process hosting. +- `IIS`: Contains managed code for hosting ASP.NET Core with in-process hosting. +- `IISIntegration`: Contains managed code for hosting ASP.NET Core with out-of-process hosting. +- `IntegrationTesting.IIS`: Contains testing infrastructure for starting IIS and IISExpress. + +## Development Setup + +### Build + +IIS can only be used on Windows. + +IIS requires VS C++ native components to build. VS C++ native components can be installed by following the [Build From Source instructions](https://github.com/dotnet/aspnetcore/blob/main/docs/BuildFromSource.md#on-windows). + +To build this specific project from source, you can follow the instructions [on building a subset of the code](https://github.com/dotnet/aspnetcore/blob/main/docs/BuildFromSource.md#building-a-subset-of-the-code). + +Or for the less detailed explanation, run the following command inside this directory. +```powershell +> ./build.cmd +``` + +### Test + +To run the tests for this project, you can [run the tests on the command line](https://github.com/dotnet/aspnetcore/blob/main/docs/BuildFromSource.md#running-tests-on-command-line) in this directory. + +Or for the less detailed explanation, run the following command inside this directory. +```powershell +> ./build.cmd -t +``` + +You can also run project specific tests by running `dotnet test` in the `tests` directory next to the `src` directory of the project. + +## More Information + +For more information, see the [ASP.NET Core README](../../../README.md). diff --git a/src/Servers/Kestrel/README.md b/src/Servers/Kestrel/README.md index 5aaf71c466d3..869a1ccb76a2 100644 --- a/src/Servers/Kestrel/README.md +++ b/src/Servers/Kestrel/README.md @@ -1,8 +1,39 @@ -KestrelHttpServer -================= +# Kestrel -Kestrel is a cross-platform web server for ASP.NET Core. +Kestrel is our cross-platform web server that is included and enabled by default in ASP.NET Core. -## File logging for functional test +## Description -Turn on file logging for Kestrel functional tests by specifying the environment variable ASPNETCORE_TEST_LOG_DIR to the log output directory. +The following contains a description of the sub-directories. + +- `Core`: Contains the main server implementation for Kestrel. +- `Kestrel`: Contains the public API exposed to use Kestrel. +- `Transport.Libuv`: Contains the Libuv transport for connection management. +- `Transport.Quic`: Contains the QUIC transport for connection management. +- `Transport.Sockets`:Contains the Sockets transport for connection management. + +## Development Setup + +### Build + +To build this specific project from source, you can follow the instructions [on building a subset of the code](https://github.com/dotnet/aspnetcore/blob/main/docs/BuildFromSource.md#building-a-subset-of-the-code). + +Or for the less detailed explanation, run the following command inside this directory. +```powershell +> ./build.cmd +``` + +### Test + +To run the tests for this project, you can [run the tests on the command line](https://github.com/dotnet/aspnetcore/blob/main/docs/BuildFromSource.md#running-tests-on-command-line) in this directory. + +Or for the less detailed explanation, run the following command inside this directory. +```powershell +> ./build.cmd -t +``` + +You can also run project specific tests by running `dotnet test` in the `tests` directory next to the `src` directory of the project. + +## More Information + +For more information, see the [ASP.NET Core README](../../../README.md). diff --git a/src/Servers/README.md b/src/Servers/README.md new file mode 100644 index 000000000000..8af44408784a --- /dev/null +++ b/src/Servers/README.md @@ -0,0 +1,20 @@ +# ASP.NET Core Servers + +ASP.NET Core Servers contains all servers that can be used in ASP.NET Core by default. These include: + +- [Kestrel](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel), our cross-platform web server that is included and enabled by default in ASP.NET Core. +- [IIS Server/ASP.NET Core Module](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/), a flexible secure managed Web Server to be hosted with IIS on Windows. +- [HTTP.sys](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/httpsys), a web server that uses the [Windows Hypertext Transfer Protocol Stack](https://docs.microsoft.com/en-us/iis/get-started/introduction-to-iis/introduction-to-iis-architecture#hypertext-transfer-protocol-stack-httpsys). + +## Description + +This folder contains all servers implementations related abstractions for ASP.NET Core. + +- `Kestrel`: Contains the implementation of the Kestrel Web Server. +- `IIS`: Cotnains all code for the IIS Web Server and ASP.NET Core Module. +- `HttpSys`: Contains all code for the HTTP.sys Web Server. +- `Connections.Abstractions`: A set of abstractions for creating and using Connections; used in Kestrel. + +## More Information + +For more information, see the [ASP.NET Core README](../../README.md). From 6f7a4eb4ad031624861835e046b257660f7b0e7e Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Wed, 24 Mar 2021 14:16:20 -0700 Subject: [PATCH 02/13] Remove en-us --- src/Servers/HttpSys/README.md | 4 ++-- src/Servers/IIS/README.md | 4 ++-- src/Servers/README.md | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/Servers/HttpSys/README.md b/src/Servers/HttpSys/README.md index 5b0856867c31..0d27241e01f6 100644 --- a/src/Servers/HttpSys/README.md +++ b/src/Servers/HttpSys/README.md @@ -1,8 +1,8 @@ # HttpSys -ASP.NET Core HttpSys Web Server is a web server that uses the [Windows Hypertext Transfer Protocol Stack](https://docs.microsoft.com/en-us/iis/get-started/introduction-to-iis/introduction-to-iis-architecture#hypertext-transfer-protocol-stack-httpsys). +ASP.NET Core HttpSys Web Server is a web server that uses the [Windows Hypertext Transfer Protocol Stack](https://docs.microsoft.com/iis/get-started/introduction-to-iis/introduction-to-iis-architecture#hypertext-transfer-protocol-stack-httpsys). -Documentation for ASP.NET Core HttpSys can be found in the [ASP.NET Core HTTP.sys Docs](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/httpsys). +Documentation for ASP.NET Core HttpSys can be found in the [ASP.NET Core HTTP.sys Docs](https://docs.microsoft.com/aspnet/core/fundamentals/servers/httpsys). ## Description diff --git a/src/Servers/IIS/README.md b/src/Servers/IIS/README.md index 478b572340cc..e81c9f9b1ba1 100644 --- a/src/Servers/IIS/README.md +++ b/src/Servers/IIS/README.md @@ -2,7 +2,7 @@ ASP.NET Core IIS Web Server is a flexible secure managed Web Server to be hosted with IIS on Windows. -Documentation for ASP.NET Core IIS can be found in the [ASP.NET Core IIS Docs](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/iis/). +Documentation for ASP.NET Core IIS can be found in the [ASP.NET Core IIS Docs](https://docs.microsoft.com/aspnet/core/fundamentals/servers/iis/). ## Description @@ -12,7 +12,7 @@ There are two modes for hosting application with IIS: in-process and out-of-proc The following contains a description of the sub-directories. -- `AspNetCoreModuleV2`: Contains all native code that is part of the [ASP.NET Core Module](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/aspnet-core-module?view=aspnetcore-5.0). +- `AspNetCoreModuleV2`: Contains all native code that is part of the [ASP.NET Core Module](https://docs.microsoft.com/aspnet/core/host-and-deploy/aspnet-core-module?view=aspnetcore-5.0). - `AspNetCoreModuleV2/AspNetCore`: Contains the ASP.NET Core Module shim, a minimal layer for IIS to interact with the in-process and out-of-process modules. - `AspNetCoreModuleV2/CommonLib`: Contains common code shared between all native components. - `AspNetCoreModuleV2/CommonLibTests`: Contains native tests for the ASP.NET Core Module. diff --git a/src/Servers/README.md b/src/Servers/README.md index 8af44408784a..41ac4a3deae1 100644 --- a/src/Servers/README.md +++ b/src/Servers/README.md @@ -2,9 +2,9 @@ ASP.NET Core Servers contains all servers that can be used in ASP.NET Core by default. These include: -- [Kestrel](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel), our cross-platform web server that is included and enabled by default in ASP.NET Core. -- [IIS Server/ASP.NET Core Module](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/), a flexible secure managed Web Server to be hosted with IIS on Windows. -- [HTTP.sys](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/httpsys), a web server that uses the [Windows Hypertext Transfer Protocol Stack](https://docs.microsoft.com/en-us/iis/get-started/introduction-to-iis/introduction-to-iis-architecture#hypertext-transfer-protocol-stack-httpsys). +- [Kestrel](https://docs.microsoft.com/aspnet/core/fundamentals/servers/kestrel), our cross-platform web server that is included and enabled by default in ASP.NET Core. +- [IIS Server/ASP.NET Core Module](https://docs.microsoft.com/aspnet/core/host-and-deploy/iis/), a flexible secure managed Web Server to be hosted with IIS on Windows. +- [HTTP.sys](https://docs.microsoft.com/aspnet/core/fundamentals/servers/httpsys), a web server that uses the [Windows Hypertext Transfer Protocol Stack](https://docs.microsoft.com/iis/get-started/introduction-to-iis/introduction-to-iis-architecture#hypertext-transfer-protocol-stack-httpsys). ## Description From d07bfdf7fcc7653268aef04f6ce20927dd6a0d71 Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Wed, 24 Mar 2021 14:26:17 -0700 Subject: [PATCH 03/13] Update src/Servers/README.md Co-authored-by: Brennan --- src/Servers/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Servers/README.md b/src/Servers/README.md index 41ac4a3deae1..566bcea3e6af 100644 --- a/src/Servers/README.md +++ b/src/Servers/README.md @@ -13,7 +13,7 @@ This folder contains all servers implementations related abstractions for ASP.NE - `Kestrel`: Contains the implementation of the Kestrel Web Server. - `IIS`: Cotnains all code for the IIS Web Server and ASP.NET Core Module. - `HttpSys`: Contains all code for the HTTP.sys Web Server. -- `Connections.Abstractions`: A set of abstractions for creating and using Connections; used in Kestrel. +- `Connections.Abstractions`: A set of abstractions for creating and using Connections; used in the server implementations and SignalR. ## More Information From 31949446119e3f69f3f902e89bf2291e15370155 Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Wed, 24 Mar 2021 14:28:22 -0700 Subject: [PATCH 04/13] Update src/Servers/Kestrel/README.md Co-authored-by: Chris Ross --- src/Servers/Kestrel/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Servers/Kestrel/README.md b/src/Servers/Kestrel/README.md index 869a1ccb76a2..a3c1836e355a 100644 --- a/src/Servers/Kestrel/README.md +++ b/src/Servers/Kestrel/README.md @@ -8,7 +8,7 @@ The following contains a description of the sub-directories. - `Core`: Contains the main server implementation for Kestrel. - `Kestrel`: Contains the public API exposed to use Kestrel. -- `Transport.Libuv`: Contains the Libuv transport for connection management. +- `Transport.Libuv`: Contains the obsolete Libuv transport for connection management. - `Transport.Quic`: Contains the QUIC transport for connection management. - `Transport.Sockets`:Contains the Sockets transport for connection management. From f38070ad2a6714d5324a098c548e83169613c38e Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Wed, 24 Mar 2021 14:28:29 -0700 Subject: [PATCH 05/13] Update src/Servers/IIS/README.md Co-authored-by: Chris Ross --- src/Servers/IIS/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Servers/IIS/README.md b/src/Servers/IIS/README.md index e81c9f9b1ba1..f0447a505295 100644 --- a/src/Servers/IIS/README.md +++ b/src/Servers/IIS/README.md @@ -8,7 +8,7 @@ Documentation for ASP.NET Core IIS can be found in the [ASP.NET Core IIS Docs](h This folder contains all relevant code for the IIS Web Server implementation. -There are two modes for hosting application with IIS: in-process and out-of-process. In-process will run all managed code inside of the IIS worker process, while out-of-process will use IIS as a reverse-proxy to a dotnet app running Kestrel. +There are two modes for hosting application with IIS: in-process and out-of-process. In-process will run all managed code inside of the IIS worker process, while out-of-process will use IIS as a reverse-proxy to a dotnet process running Kestrel. The following contains a description of the sub-directories. From 40e02dba5231fb497881b57ef3dca54a90c52a22 Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Wed, 24 Mar 2021 14:38:04 -0700 Subject: [PATCH 06/13] Feedback --- src/Servers/HttpSys/README.md | 8 ++++---- src/Servers/IIS/README.md | 22 +++++++++++----------- src/Servers/Kestrel/README.md | 11 ++++++----- src/Servers/README.md | 8 ++++---- 4 files changed, 25 insertions(+), 24 deletions(-) diff --git a/src/Servers/HttpSys/README.md b/src/Servers/HttpSys/README.md index 0d27241e01f6..8d7e77821a0c 100644 --- a/src/Servers/HttpSys/README.md +++ b/src/Servers/HttpSys/README.md @@ -8,10 +8,10 @@ Documentation for ASP.NET Core HttpSys can be found in the [ASP.NET Core HTTP.sy This folder contains all relevant code for the HttpSys Web Server implementation. -- `src/`: Contains all production code for the HttpSys Web Server. -- `src/NativeInterop`: Contains the native interop layer between managed and native code. -- `src/RequestProcessing`: Contains request and response processing code. -- `samples`: Contains samples showing how to use HTTP.sys. +- `[src/](src/)`: Contains all production code for the HttpSys Web Server. +- `[src/NativeInterop](src/NativeInterop)`: Contains the native interop layer between managed and native code. +- `[src/RequestProcessing](src/RequestProcessing)`: Contains request and response processing code. +- `[samples](samples/)`: Contains samples showing how to use HTTP.sys. ## Development Setup diff --git a/src/Servers/IIS/README.md b/src/Servers/IIS/README.md index f0447a505295..f1a63b673a1f 100644 --- a/src/Servers/IIS/README.md +++ b/src/Servers/IIS/README.md @@ -12,17 +12,17 @@ There are two modes for hosting application with IIS: in-process and out-of-proc The following contains a description of the sub-directories. -- `AspNetCoreModuleV2`: Contains all native code that is part of the [ASP.NET Core Module](https://docs.microsoft.com/aspnet/core/host-and-deploy/aspnet-core-module?view=aspnetcore-5.0). -- `AspNetCoreModuleV2/AspNetCore`: Contains the ASP.NET Core Module shim, a minimal layer for IIS to interact with the in-process and out-of-process modules. -- `AspNetCoreModuleV2/CommonLib`: Contains common code shared between all native components. -- `AspNetCoreModuleV2/CommonLibTests`: Contains native tests for the ASP.NET Core Module. -- `AspNetCoreModuleV2/IISLib`: Contains common code for interactions with IIS. -- `AspNetCoreModuleV2/InProcessRequestHandler`: Contains native code for in-process hosting. -- `AspNetCoreModuleV2/OutOfProcessRequestHandler`: Contains native code for out-of-process hosting. -- `AspNetCoreModuleV2/RequestHandlerLib`: Contains shared code between in-process and out-of-process hosting. -- `IIS`: Contains managed code for hosting ASP.NET Core with in-process hosting. -- `IISIntegration`: Contains managed code for hosting ASP.NET Core with out-of-process hosting. -- `IntegrationTesting.IIS`: Contains testing infrastructure for starting IIS and IISExpress. +- `[AspNetCoreModuleV2](AspNetCoreModuleV2/)`: Contains all native code that is part of the [ASP.NET Core Module](https://docs.microsoft.com/aspnet/core/host-and-deploy/aspnet-core-module?view=aspnetcore-5.0). +- `[AspNetCoreModuleV2/AspNetCore](AspNetCoreModuleV2/AspNetCore/)`: Contains the ASP.NET Core Module shim, a minimal layer for IIS to interact with the in-process and out-of-process modules. +- `[AspNetCoreModuleV2/CommonLib](AspNetCoreModuleV2/CommonLib/)`: Contains common code shared between all native components. +- `[AspNetCoreModuleV2/CommonLibTests](AspNetCoreModuleV2/CommonLibTests/)`: Contains native tests for the ASP.NET Core Module. +- `[AspNetCoreModuleV2/IISLib](AspNetCoreModuleV2/IISLib/)`: Contains common code for interactions with IIS. +- `[AspNetCoreModuleV2/InProcessRequestHandler](AspNetCoreModuleV2/InProcessRequestHandler/)`: Contains native code for in-process hosting. +- `[AspNetCoreModuleV2/OutOfProcessRequestHandler](AspNetCoreModuleV2/OutOfProcessRequestHandler/)`: Contains native code for out-of-process hosting. +- `[AspNetCoreModuleV2/RequestHandlerLib](AspNetCoreModuleV2/RequestHandlerLib/)`: Contains shared code between in-process and out-of-process hosting. +- `[IIS](IIS/)`: Contains managed code for hosting ASP.NET Core with in-process hosting. +- `[IISIntegration](IISIntegration/)`: Contains managed code for hosting ASP.NET Core with out-of-process hosting. +- `[IntegrationTesting.IIS](IntegrationTesting.IIS/)`: Contains testing infrastructure for starting IIS and IISExpress. ## Development Setup diff --git a/src/Servers/Kestrel/README.md b/src/Servers/Kestrel/README.md index a3c1836e355a..e7293975fa73 100644 --- a/src/Servers/Kestrel/README.md +++ b/src/Servers/Kestrel/README.md @@ -6,11 +6,12 @@ Kestrel is our cross-platform web server that is included and enabled by default The following contains a description of the sub-directories. -- `Core`: Contains the main server implementation for Kestrel. -- `Kestrel`: Contains the public API exposed to use Kestrel. -- `Transport.Libuv`: Contains the obsolete Libuv transport for connection management. -- `Transport.Quic`: Contains the QUIC transport for connection management. -- `Transport.Sockets`:Contains the Sockets transport for connection management. +- `[Core](Core/)`: Contains the main server implementation for Kestrel. +- `[Kestrel](Kestrel/)`: Contains the public API exposed to use Kestrel. +- `[test](test/)`: Contains End to End tests for Kestrel. +- `[Transport.Libuv](Transport.Libuv/)`: Contains the obsolete Libuv transport for connection management. +- `[Transport.Quic](Transport.Quic/)`: Contains the QUIC transport for connection management. +- `[Transport.Sockets](Transport.Sockets/)`:Contains the Sockets transport for connection management. ## Development Setup diff --git a/src/Servers/README.md b/src/Servers/README.md index 566bcea3e6af..b06eb74c155b 100644 --- a/src/Servers/README.md +++ b/src/Servers/README.md @@ -10,10 +10,10 @@ ASP.NET Core Servers contains all servers that can be used in ASP.NET Core by de This folder contains all servers implementations related abstractions for ASP.NET Core. -- `Kestrel`: Contains the implementation of the Kestrel Web Server. -- `IIS`: Cotnains all code for the IIS Web Server and ASP.NET Core Module. -- `HttpSys`: Contains all code for the HTTP.sys Web Server. -- `Connections.Abstractions`: A set of abstractions for creating and using Connections; used in the server implementations and SignalR. +- `[Kestrel](Kestrel/)`: Contains the implementation of the Kestrel Web Server. +- `[IIS](IIS/)`: Cotnains all code for the IIS Web Server and ASP.NET Core Module. +- `[HttpSys](HttpSys/)`: Contains all code for the HTTP.sys Web Server. +- `[Connections.Abstractions](Connections.Abstractions/)`: A set of abstractions for creating and using Connections; used in the server implementations and SignalR. ## More Information From 11d9249e229d3fc5f51221b1a4e26efe4ec5f138 Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Wed, 24 Mar 2021 14:38:47 -0700 Subject: [PATCH 07/13] Update src/Servers/HttpSys/README.md --- src/Servers/HttpSys/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Servers/HttpSys/README.md b/src/Servers/HttpSys/README.md index 8d7e77821a0c..cf18209a3445 100644 --- a/src/Servers/HttpSys/README.md +++ b/src/Servers/HttpSys/README.md @@ -8,7 +8,7 @@ Documentation for ASP.NET Core HttpSys can be found in the [ASP.NET Core HTTP.sy This folder contains all relevant code for the HttpSys Web Server implementation. -- `[src/](src/)`: Contains all production code for the HttpSys Web Server. +- `[src](src/)`: Contains all production code for the HttpSys Web Server. - `[src/NativeInterop](src/NativeInterop)`: Contains the native interop layer between managed and native code. - `[src/RequestProcessing](src/RequestProcessing)`: Contains request and response processing code. - `[samples](samples/)`: Contains samples showing how to use HTTP.sys. From 669b9664eece895cb7bf0413dd0f5446e9f83c3d Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Wed, 24 Mar 2021 14:53:31 -0700 Subject: [PATCH 08/13] Quick test --- src/Servers/HttpSys/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Servers/HttpSys/README.md b/src/Servers/HttpSys/README.md index cf18209a3445..5bd662abafc8 100644 --- a/src/Servers/HttpSys/README.md +++ b/src/Servers/HttpSys/README.md @@ -8,7 +8,7 @@ Documentation for ASP.NET Core HttpSys can be found in the [ASP.NET Core HTTP.sy This folder contains all relevant code for the HttpSys Web Server implementation. -- `[src](src/)`: Contains all production code for the HttpSys Web Server. +- [src](src/): Contains all production code for the HttpSys Web Server. - `[src/NativeInterop](src/NativeInterop)`: Contains the native interop layer between managed and native code. - `[src/RequestProcessing](src/RequestProcessing)`: Contains request and response processing code. - `[samples](samples/)`: Contains samples showing how to use HTTP.sys. From 6a75980d38a5f2cd80e7ba46972ff7de6fd79d20 Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Wed, 24 Mar 2021 14:54:40 -0700 Subject: [PATCH 09/13] HttpSys --- src/Servers/HttpSys/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Servers/HttpSys/README.md b/src/Servers/HttpSys/README.md index 5bd662abafc8..38be4c94c5fe 100644 --- a/src/Servers/HttpSys/README.md +++ b/src/Servers/HttpSys/README.md @@ -8,10 +8,10 @@ Documentation for ASP.NET Core HttpSys can be found in the [ASP.NET Core HTTP.sy This folder contains all relevant code for the HttpSys Web Server implementation. -- [src](src/): Contains all production code for the HttpSys Web Server. -- `[src/NativeInterop](src/NativeInterop)`: Contains the native interop layer between managed and native code. -- `[src/RequestProcessing](src/RequestProcessing)`: Contains request and response processing code. -- `[samples](samples/)`: Contains samples showing how to use HTTP.sys. +- [src/](src/): Contains all production code for the HttpSys Web Server. +- [src/NativeInterop/](src/NativeInterop)`: Contains the native interop layer between managed and native code. +- [src/RequestProcessing/](src/RequestProcessing): Contains request and response processing code. +- [samples/](samples/)`: Contains samples showing how to use HTTP.sys. ## Development Setup From cf55b1fee33dd10b242df4fc05ac5f685d5c8fd7 Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Wed, 24 Mar 2021 14:54:59 -0700 Subject: [PATCH 10/13] Update README.md --- src/Servers/HttpSys/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Servers/HttpSys/README.md b/src/Servers/HttpSys/README.md index 38be4c94c5fe..e51c8b2fad50 100644 --- a/src/Servers/HttpSys/README.md +++ b/src/Servers/HttpSys/README.md @@ -9,9 +9,9 @@ Documentation for ASP.NET Core HttpSys can be found in the [ASP.NET Core HTTP.sy This folder contains all relevant code for the HttpSys Web Server implementation. - [src/](src/): Contains all production code for the HttpSys Web Server. -- [src/NativeInterop/](src/NativeInterop)`: Contains the native interop layer between managed and native code. +- [src/NativeInterop/](src/NativeInterop): Contains the native interop layer between managed and native code. - [src/RequestProcessing/](src/RequestProcessing): Contains request and response processing code. -- [samples/](samples/)`: Contains samples showing how to use HTTP.sys. +- [samples/](samples/): Contains samples showing how to use HTTP.sys. ## Development Setup From 9849b29c688795e97333c461e395bdfc8bc10631 Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Wed, 24 Mar 2021 14:57:48 -0700 Subject: [PATCH 11/13] Feedback --- src/Servers/IIS/README.md | 22 +++++++++++----------- src/Servers/Kestrel/README.md | 12 ++++++------ src/Servers/README.md | 8 ++++---- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/src/Servers/IIS/README.md b/src/Servers/IIS/README.md index f1a63b673a1f..b1bf4c78d7bb 100644 --- a/src/Servers/IIS/README.md +++ b/src/Servers/IIS/README.md @@ -12,17 +12,17 @@ There are two modes for hosting application with IIS: in-process and out-of-proc The following contains a description of the sub-directories. -- `[AspNetCoreModuleV2](AspNetCoreModuleV2/)`: Contains all native code that is part of the [ASP.NET Core Module](https://docs.microsoft.com/aspnet/core/host-and-deploy/aspnet-core-module?view=aspnetcore-5.0). -- `[AspNetCoreModuleV2/AspNetCore](AspNetCoreModuleV2/AspNetCore/)`: Contains the ASP.NET Core Module shim, a minimal layer for IIS to interact with the in-process and out-of-process modules. -- `[AspNetCoreModuleV2/CommonLib](AspNetCoreModuleV2/CommonLib/)`: Contains common code shared between all native components. -- `[AspNetCoreModuleV2/CommonLibTests](AspNetCoreModuleV2/CommonLibTests/)`: Contains native tests for the ASP.NET Core Module. -- `[AspNetCoreModuleV2/IISLib](AspNetCoreModuleV2/IISLib/)`: Contains common code for interactions with IIS. -- `[AspNetCoreModuleV2/InProcessRequestHandler](AspNetCoreModuleV2/InProcessRequestHandler/)`: Contains native code for in-process hosting. -- `[AspNetCoreModuleV2/OutOfProcessRequestHandler](AspNetCoreModuleV2/OutOfProcessRequestHandler/)`: Contains native code for out-of-process hosting. -- `[AspNetCoreModuleV2/RequestHandlerLib](AspNetCoreModuleV2/RequestHandlerLib/)`: Contains shared code between in-process and out-of-process hosting. -- `[IIS](IIS/)`: Contains managed code for hosting ASP.NET Core with in-process hosting. -- `[IISIntegration](IISIntegration/)`: Contains managed code for hosting ASP.NET Core with out-of-process hosting. -- `[IntegrationTesting.IIS](IntegrationTesting.IIS/)`: Contains testing infrastructure for starting IIS and IISExpress. +- [AspNetCoreModuleV2/](AspNetCoreModuleV2/): Contains all native code that is part of the [ASP.NET Core Module/](https://docs.microsoft.com/aspnet/core/host-and-deploy/aspnet-core-module?view=aspnetcore-5.0). +- [AspNetCoreModuleV2/AspNetCore/](AspNetCoreModuleV2/AspNetCore/): Contains the ASP.NET Core Module shim, a minimal layer for IIS to interact with the in-process and out-of-process modules. +- [AspNetCoreModuleV2/CommonLib/](AspNetCoreModuleV2/CommonLib/): Contains common code shared between all native components. +- [AspNetCoreModuleV2/CommonLibTests/](AspNetCoreModuleV2/CommonLibTests/): Contains native tests for the ASP.NET Core Module. +- [AspNetCoreModuleV2/IISLib/](AspNetCoreModuleV2/IISLib/): Contains common code for interactions with IIS. +- [AspNetCoreModuleV2/InProcessRequestHandler/](AspNetCoreModuleV2/InProcessRequestHandler/): Contains native code for in-process hosting. +- [AspNetCoreModuleV2/OutOfProcessRequestHandler/](AspNetCoreModuleV2/OutOfProcessRequestHandler/): Contains native code for out-of-process hosting. +- [AspNetCoreModuleV2/RequestHandlerLib/](AspNetCoreModuleV2/RequestHandlerLib/): Contains shared code between in-process and out-of-process hosting. +- [IIS/](IIS/): Contains managed code for hosting ASP.NET Core with in-process hosting. +- [IISIntegration/](IISIntegration/): Contains managed code for hosting ASP.NET Core with out-of-process hosting. +- [IntegrationTesting.IIS/](IntegrationTesting.IIS/): Contains testing infrastructure for starting IIS and IISExpress. ## Development Setup diff --git a/src/Servers/Kestrel/README.md b/src/Servers/Kestrel/README.md index e7293975fa73..20584d494f9b 100644 --- a/src/Servers/Kestrel/README.md +++ b/src/Servers/Kestrel/README.md @@ -6,12 +6,12 @@ Kestrel is our cross-platform web server that is included and enabled by default The following contains a description of the sub-directories. -- `[Core](Core/)`: Contains the main server implementation for Kestrel. -- `[Kestrel](Kestrel/)`: Contains the public API exposed to use Kestrel. -- `[test](test/)`: Contains End to End tests for Kestrel. -- `[Transport.Libuv](Transport.Libuv/)`: Contains the obsolete Libuv transport for connection management. -- `[Transport.Quic](Transport.Quic/)`: Contains the QUIC transport for connection management. -- `[Transport.Sockets](Transport.Sockets/)`:Contains the Sockets transport for connection management. +- [Core/](Core/): Contains the main server implementation for Kestrel. +- [Kestrel/](Kestrel/): Contains the public API exposed to use Kestrel. +- [test/](test/): Contains End to End tests for Kestrel. +- [Transport.Sockets/](Transport.Sockets/):Contains the Sockets transport for connection management. +- [Transport.Quic/](Transport.Quic/): Contains the QUIC transport for connection management. +- [Transport.Libuv/](Transport.Libuv/): Contains the obsolete Libuv transport for connection management. ## Development Setup diff --git a/src/Servers/README.md b/src/Servers/README.md index b06eb74c155b..a3daf34160ec 100644 --- a/src/Servers/README.md +++ b/src/Servers/README.md @@ -10,10 +10,10 @@ ASP.NET Core Servers contains all servers that can be used in ASP.NET Core by de This folder contains all servers implementations related abstractions for ASP.NET Core. -- `[Kestrel](Kestrel/)`: Contains the implementation of the Kestrel Web Server. -- `[IIS](IIS/)`: Cotnains all code for the IIS Web Server and ASP.NET Core Module. -- `[HttpSys](HttpSys/)`: Contains all code for the HTTP.sys Web Server. -- `[Connections.Abstractions](Connections.Abstractions/)`: A set of abstractions for creating and using Connections; used in the server implementations and SignalR. +- [Kestrel/](Kestrel/): Contains the implementation of the Kestrel Web Server. +- [IIS/](IIS/): Cotnains all code for the IIS Web Server and ASP.NET Core Module. +- [HttpSys/](HttpSys/): Contains all code for the HTTP.sys Web Server. +- [Connections.Abstractions/](Connections.Abstractions/): A set of abstractions for creating and using Connections; used in the server implementations and SignalR. ## More Information From b76f8c8776011c9bd1ad5dcf0d22339fdf998d1c Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Thu, 25 Mar 2021 09:41:31 -0700 Subject: [PATCH 12/13] Update src/Servers/IIS/README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Günther Foidl --- src/Servers/IIS/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Servers/IIS/README.md b/src/Servers/IIS/README.md index b1bf4c78d7bb..abd9ca262e62 100644 --- a/src/Servers/IIS/README.md +++ b/src/Servers/IIS/README.md @@ -2,7 +2,7 @@ ASP.NET Core IIS Web Server is a flexible secure managed Web Server to be hosted with IIS on Windows. -Documentation for ASP.NET Core IIS can be found in the [ASP.NET Core IIS Docs](https://docs.microsoft.com/aspnet/core/fundamentals/servers/iis/). +Documentation for ASP.NET Core IIS can be found in the [ASP.NET Core IIS Docs](https://docs.microsoft.com/aspnet/core/host-and-deploy/iis). ## Description From 5d431b65b39e93d62481ba9bdea41c0233ba234d Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Thu, 25 Mar 2021 09:41:37 -0700 Subject: [PATCH 13/13] Update src/Servers/Kestrel/README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Günther Foidl --- src/Servers/Kestrel/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/Servers/Kestrel/README.md b/src/Servers/Kestrel/README.md index 20584d494f9b..f38718cd006e 100644 --- a/src/Servers/Kestrel/README.md +++ b/src/Servers/Kestrel/README.md @@ -2,6 +2,8 @@ Kestrel is our cross-platform web server that is included and enabled by default in ASP.NET Core. +Documentation for ASP.NET Core Kestrel can be found in the [ASP.NET Core Kestrel Docs](https://docs.microsoft.com/aspnet/core/fundamentals/servers/kestrel). + ## Description The following contains a description of the sub-directories.