Skip to content

Commit 1bf6332

Browse files
jkotalikBrennanConroyTratchergfoidl
authored
READMEs for Servers (#31207)
* READMEs for Servers * Remove en-us * Update src/Servers/README.md Co-authored-by: Brennan <[email protected]> * Update src/Servers/Kestrel/README.md Co-authored-by: Chris Ross <[email protected]> * Update src/Servers/IIS/README.md Co-authored-by: Chris Ross <[email protected]> * Feedback * Update src/Servers/HttpSys/README.md * Quick test * HttpSys * Update README.md * Feedback * Update src/Servers/IIS/README.md Co-authored-by: Günther Foidl <[email protected]> * Update src/Servers/Kestrel/README.md Co-authored-by: Günther Foidl <[email protected]> Co-authored-by: Brennan <[email protected]> Co-authored-by: Chris Ross <[email protected]> Co-authored-by: Günther Foidl <[email protected]>
1 parent 8d79c95 commit 1bf6332

File tree

4 files changed

+155
-8
lines changed

4 files changed

+155
-8
lines changed

‎src/Servers/HttpSys/README.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,42 @@
1-
HttpSysServer
2-
=============
1+
# HttpSys
32

4-
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).
3+
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).
4+
5+
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).
6+
7+
## Description
8+
9+
This folder contains all relevant code for the HttpSys Web Server implementation.
10+
11+
- [src/](src/): Contains all production code for the HttpSys Web Server.
12+
- [src/NativeInterop/](src/NativeInterop): Contains the native interop layer between managed and native code.
13+
- [src/RequestProcessing/](src/RequestProcessing): Contains request and response processing code.
14+
- [samples/](samples/): Contains samples showing how to use HTTP.sys.
15+
16+
## Development Setup
17+
18+
### Build
19+
20+
HTTP.sys can only be used on Windows.
21+
22+
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).
23+
24+
Or for the less detailed explanation, run the following command inside this directory.
25+
```powershell
26+
> ./build.cmd
27+
```
28+
29+
### Test
30+
31+
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.
32+
33+
Or for the less detailed explanation, run the following command inside this directory.
34+
```powershell
35+
> ./build.cmd -t
36+
```
37+
38+
You can also run project specific tests by running `dotnet test` in the `tests` directory next to the `src` directory of the project.
39+
40+
## More Information
41+
42+
For more information, see the [ASP.NET Core README](../../../README.md).

‎src/Servers/IIS/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# IIS
2+
3+
ASP.NET Core IIS Web Server is a flexible secure managed Web Server to be hosted with IIS on Windows.
4+
5+
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).
6+
7+
## Description
8+
9+
This folder contains all relevant code for the IIS Web Server implementation.
10+
11+
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.
12+
13+
The following contains a description of the sub-directories.
14+
15+
- [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).
16+
- [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.
17+
- [AspNetCoreModuleV2/CommonLib/](AspNetCoreModuleV2/CommonLib/): Contains common code shared between all native components.
18+
- [AspNetCoreModuleV2/CommonLibTests/](AspNetCoreModuleV2/CommonLibTests/): Contains native tests for the ASP.NET Core Module.
19+
- [AspNetCoreModuleV2/IISLib/](AspNetCoreModuleV2/IISLib/): Contains common code for interactions with IIS.
20+
- [AspNetCoreModuleV2/InProcessRequestHandler/](AspNetCoreModuleV2/InProcessRequestHandler/): Contains native code for in-process hosting.
21+
- [AspNetCoreModuleV2/OutOfProcessRequestHandler/](AspNetCoreModuleV2/OutOfProcessRequestHandler/): Contains native code for out-of-process hosting.
22+
- [AspNetCoreModuleV2/RequestHandlerLib/](AspNetCoreModuleV2/RequestHandlerLib/): Contains shared code between in-process and out-of-process hosting.
23+
- [IIS/](IIS/): Contains managed code for hosting ASP.NET Core with in-process hosting.
24+
- [IISIntegration/](IISIntegration/): Contains managed code for hosting ASP.NET Core with out-of-process hosting.
25+
- [IntegrationTesting.IIS/](IntegrationTesting.IIS/): Contains testing infrastructure for starting IIS and IISExpress.
26+
27+
## Development Setup
28+
29+
### Build
30+
31+
IIS can only be used on Windows.
32+
33+
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).
34+
35+
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).
36+
37+
Or for the less detailed explanation, run the following command inside this directory.
38+
```powershell
39+
> ./build.cmd
40+
```
41+
42+
### Test
43+
44+
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.
45+
46+
Or for the less detailed explanation, run the following command inside this directory.
47+
```powershell
48+
> ./build.cmd -t
49+
```
50+
51+
You can also run project specific tests by running `dotnet test` in the `tests` directory next to the `src` directory of the project.
52+
53+
## More Information
54+
55+
For more information, see the [ASP.NET Core README](../../../README.md).

‎src/Servers/Kestrel/README.md

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,42 @@
1-
KestrelHttpServer
2-
=================
1+
# Kestrel
32

4-
Kestrel is a cross-platform web server for ASP.NET Core.
3+
Kestrel is our cross-platform web server that is included and enabled by default in ASP.NET Core.
54

6-
## File logging for functional test
5+
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).
76

8-
Turn on file logging for Kestrel functional tests by specifying the environment variable ASPNETCORE_TEST_LOG_DIR to the log output directory.
7+
## Description
8+
9+
The following contains a description of the sub-directories.
10+
11+
- [Core/](Core/): Contains the main server implementation for Kestrel.
12+
- [Kestrel/](Kestrel/): Contains the public API exposed to use Kestrel.
13+
- [test/](test/): Contains End to End tests for Kestrel.
14+
- [Transport.Sockets/](Transport.Sockets/):Contains the Sockets transport for connection management.
15+
- [Transport.Quic/](Transport.Quic/): Contains the QUIC transport for connection management.
16+
- [Transport.Libuv/](Transport.Libuv/): Contains the obsolete Libuv transport for connection management.
17+
18+
## Development Setup
19+
20+
### Build
21+
22+
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).
23+
24+
Or for the less detailed explanation, run the following command inside this directory.
25+
```powershell
26+
> ./build.cmd
27+
```
28+
29+
### Test
30+
31+
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.
32+
33+
Or for the less detailed explanation, run the following command inside this directory.
34+
```powershell
35+
> ./build.cmd -t
36+
```
37+
38+
You can also run project specific tests by running `dotnet test` in the `tests` directory next to the `src` directory of the project.
39+
40+
## More Information
41+
42+
For more information, see the [ASP.NET Core README](../../../README.md).

‎src/Servers/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# ASP.NET Core Servers
2+
3+
ASP.NET Core Servers contains all servers that can be used in ASP.NET Core by default. These include:
4+
5+
- [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.
6+
- [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.
7+
- [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).
8+
9+
## Description
10+
11+
This folder contains all servers implementations related abstractions for ASP.NET Core.
12+
13+
- [Kestrel/](Kestrel/): Contains the implementation of the Kestrel Web Server.
14+
- [IIS/](IIS/): Cotnains all code for the IIS Web Server and ASP.NET Core Module.
15+
- [HttpSys/](HttpSys/): Contains all code for the HTTP.sys Web Server.
16+
- [Connections.Abstractions/](Connections.Abstractions/): A set of abstractions for creating and using Connections; used in the server implementations and SignalR.
17+
18+
## More Information
19+
20+
For more information, see the [ASP.NET Core README](../../README.md).

0 commit comments

Comments
 (0)