Skip to content

Commit 15589d4

Browse files
mthalmanmthalman
authored
Define READMEs for Docker Hub (#1142)
1 parent 409f1b0 commit 15589d4

19 files changed

+534
-39
lines changed

‎.portal-docs/docker-hub/README.aspnet.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Featured tags
2+
3+
* `4.8.1`
4+
* `docker pull mcr.microsoft.com/dotnet/framework/aspnet:4.8.1`
5+
* `4.8`
6+
* `docker pull mcr.microsoft.com/dotnet/framework/aspnet:4.8`
7+
* `3.5`
8+
* `docker pull mcr.microsoft.com/dotnet/framework/aspnet:3.5`
9+
10+
# About
11+
12+
ASP.NET is a high productivity framework for building Web Applications using Web Forms, MVC, Web API and SignalR.
13+
14+
This image contains:
15+
16+
* Windows Server Core as the base OS
17+
* IIS 10 as Web Server
18+
* .NET Framework (multiple versions available)
19+
* .NET Extensibility for IIS
20+
21+
Watch [discussions](https://github.com/microsoft/dotnet-framework-docker/discussions/categories/announcements) for Docker-related .NET announcements.
22+
23+
# Usage
24+
25+
The [.NET Framework Docker samples](https://github.com/microsoft/dotnet-framework-docker/blob/main/samples/README.md) show various ways to use .NET Framework and Docker together.
26+
27+
## Container sample: Run an ASP.NET application
28+
You can quickly run a container with a pre-built [sample ASP.NET Docker image](https://hub.docker.com/_/microsoft-dotnet-framework-samples/), based on the [ASP.NET Docker sample].
29+
30+
Type the following [Docker](https://www.docker.com/products/docker) command:
31+
32+
```console
33+
docker run --name aspnet_sample --rm -it -p 8000:80 mcr.microsoft.com/dotnet/framework/samples:aspnetapp
34+
```
35+
36+
After the application starts, navigate to `http://localhost:8000` in your web browser. You need to navigate to the application via IP address instead of `localhost` for earlier Windows versions, which is demonstrated in [View the ASP.NET app in a running container on Windows](https://github.com/microsoft/dotnet-framework-docker/blob/main/samples/aspnetapp/README.md#view-the-aspnet-app-in-a-running-container-on-windows).
37+
38+
## Version Compatibility
39+
40+
Version Tag | OS Version | Supported .NET Versions
41+
-- | -- | --
42+
4.8.1 | windowsservercore-ltsc2022 | 4.8.1
43+
4.8 | windowsservercore-ltsc2022, windowsservercore-ltsc2019, windowsservercore-ltsc2016 | 4.8
44+
4.7.2 | windowsservercore-ltsc2019, windowsservercore-ltsc2016 | 4.7.2
45+
4.7.1 | windowsservercore-ltsc2016 | 4.7.1
46+
4.7 | windowsservercore-ltsc2016 | 4.7
47+
4.6.2 | windowsservercore-ltsc2016 | 4.6.2
48+
3.5 | windowsservercore-ltsc2022 | 4.7.2, 3.5, 3.0, 2.5
49+
3.5 | windowsservercore-ltsc2019 | 4.7.2, 3.5, 3.0, 2.5
50+
3.5 | windowsservercore-ltsc2016 | 4.6.2, 3.5, 3.0, 2.5
51+
52+
# Related repositories
53+
54+
.NET Framework:
55+
56+
* [dotnet/framework/sdk](https://hub.docker.com/_/microsoft-dotnet-framework-sdk/): .NET Framework SDK
57+
* [dotnet/framework/runtime](https://hub.docker.com/_/microsoft-dotnet-framework-runtime/): .NET Framework Runtime
58+
* [dotnet/framework/wcf](https://hub.docker.com/_/microsoft-dotnet-framework-wcf/): Windows Communication Foundation (WCF)
59+
* [dotnet/framework/samples](https://hub.docker.com/_/microsoft-dotnet-framework-samples/): .NET Framework, ASP.NET and WCF Samples
60+
61+
.NET:
62+
63+
* [dotnet](https://hub.docker.com/_/microsoft-dotnet/): .NET
64+
* [dotnet-nightly](https://hub.docker.com/_/microsoft-dotnet-nightly/): .NET (Preview)
65+
* [dotnet/samples](https://hub.docker.com/_/microsoft-dotnet-samples/): .NET Samples
66+
67+
# Full Tag Listing
68+
69+
View the current tags at the [Microsoft Artifact Registry portal](https://mcr.microsoft.com/product/dotnet/framework/aspnet/tags) or on [GitHub](https://github.com/microsoft/dotnet-framework-docker/blob/main/README.aspnet.md#full-tag-listing).
70+
71+
# Support
72+
73+
## Lifecycle
74+
75+
* [.NET Framework Lifecycle FAQ](https://support.microsoft.com/help/17455/lifecycle-faq-net-framework)
76+
* [Supported Tags Policy](https://github.com/microsoft/dotnet-framework-docker/blob/main/documentation/supported-tags.md)
77+
78+
## Image Update Policy
79+
80+
* We update the supported .NET Framework images within 12 hours of any updates to their base images (e.g. windows/servercore:ltsc2019, windows/servercore:ltsc2022, etc.).
81+
* We publish .NET Framework images as part of releasing new versions of .NET Framework including major/minor and servicing.
82+
83+
## Feedback
84+
85+
* [File an issue](https://github.com/microsoft/dotnet-framework-docker/issues/new/choose)
86+
* [Contact Microsoft Support](https://support.microsoft.com/contactus/)
87+
88+
# License
89+
90+
* [Microsoft Container Images Legal Notice](https://aka.ms/mcr/osslegalnotice): applies to all [.NET Framework container images](https://hub.docker.com/_/microsoft-dotnet-framework/)
91+
* [Microsoft Software Supplemental License for Windows Container Base Image](https://hub.docker.com/_/microsoft-windows-servercore/): applies to all [.NET Framework container images](https://hub.docker.com/_/microsoft-dotnet-framework/)
92+
* [Visual Studio Tools License](https://visualstudio.microsoft.com/license-terms/mlt031519/): applies to all [.NET Framework SDK container images](https://hub.docker.com/_/microsoft-dotnet-framework-sdk/)

‎.portal-docs/docker-hub/README.runtime.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Featured tags
2+
3+
* `4.8.1`
4+
* `docker pull mcr.microsoft.com/dotnet/framework/runtime:4.8.1`
5+
* `4.8`
6+
* `docker pull mcr.microsoft.com/dotnet/framework/runtime:4.8`
7+
* `3.5`
8+
* `docker pull mcr.microsoft.com/dotnet/framework/runtime:3.5`
9+
10+
# About
11+
12+
This image contains the .NET Framework runtimes and libraries and is optimized for running .NET Framework apps in production.
13+
14+
Watch [discussions](https://github.com/microsoft/dotnet-framework-docker/discussions/categories/announcements) for Docker-related .NET announcements.
15+
16+
# Usage
17+
18+
The [.NET Framework Docker samples](https://github.com/microsoft/dotnet-framework-docker/blob/main/samples/README.md) show various ways to use .NET Framework and Docker together.
19+
20+
## Container sample: Run a simple application
21+
22+
You can quickly run a container with a pre-built [.NET Framework Docker image](https://hub.docker.com/_/microsoft-dotnet-framework-samples/), based on the [.NET Framework console sample](https://github.com/microsoft/dotnet-framework-docker/blob/main/samples/dotnetapp/README.md).
23+
24+
Type the following command to run a sample console application:
25+
26+
```console
27+
docker run --rm mcr.microsoft.com/dotnet/framework/samples:dotnetapp
28+
```
29+
30+
## Version Compatibility
31+
32+
Version Tag | OS Version | Supported .NET Versions
33+
-- | -- | --
34+
4.8.1 | windowsservercore-ltsc2022 | 4.8.1
35+
4.8 | windowsservercore-ltsc2022, windowsservercore-ltsc2019, windowsservercore-ltsc2016 | 4.8
36+
4.7.2 | windowsservercore-ltsc2019, windowsservercore-ltsc2016 | 4.7.2
37+
4.7.1 | windowsservercore-ltsc2016 | 4.7.1
38+
4.7 | windowsservercore-ltsc2016 | 4.7
39+
4.6.2 | windowsservercore-ltsc2016 | 4.6.2
40+
3.5 | windowsservercore-ltsc2022 | 4.7.2, 3.5, 3.0, 2.5
41+
3.5 | windowsservercore-ltsc2019 | 4.7.2, 3.5, 3.0, 2.5
42+
3.5 | windowsservercore-ltsc2016 | 4.6.2, 3.5, 3.0, 2.5
43+
44+
# Related repositories
45+
46+
.NET Framework:
47+
48+
* [dotnet/framework/sdk](https://hub.docker.com/_/microsoft-dotnet-framework-sdk/): .NET Framework SDK
49+
* [dotnet/framework/aspnet](https://hub.docker.com/_/microsoft-dotnet-framework-aspnet/): ASP.NET Web Forms and MVC
50+
* [dotnet/framework/wcf](https://hub.docker.com/_/microsoft-dotnet-framework-wcf/): Windows Communication Foundation (WCF)
51+
* [dotnet/framework/samples](https://hub.docker.com/_/microsoft-dotnet-framework-samples/): .NET Framework, ASP.NET and WCF Samples
52+
53+
.NET:
54+
55+
* [dotnet](https://hub.docker.com/_/microsoft-dotnet/): .NET
56+
* [dotnet-nightly](https://hub.docker.com/_/microsoft-dotnet-nightly/): .NET (Preview)
57+
* [dotnet/samples](https://hub.docker.com/_/microsoft-dotnet-samples/): .NET Samples
58+
59+
# Full Tag Listing
60+
61+
View the current tags at the [Microsoft Artifact Registry portal](https://mcr.microsoft.com/product/dotnet/framework/runtime/tags) or on [GitHub](https://github.com/microsoft/dotnet-framework-docker/blob/main/README.runtime.md#full-tag-listing).
62+
63+
# Support
64+
65+
## Lifecycle
66+
67+
* [.NET Framework Lifecycle FAQ](https://support.microsoft.com/help/17455/lifecycle-faq-net-framework)
68+
* [Supported Tags Policy](https://github.com/microsoft/dotnet-framework-docker/blob/main/documentation/supported-tags.md)
69+
70+
## Image Update Policy
71+
72+
* We update the supported .NET Framework images within 12 hours of any updates to their base images (e.g. windows/servercore:ltsc2019, windows/servercore:ltsc2022, etc.).
73+
* We publish .NET Framework images as part of releasing new versions of .NET Framework including major/minor and servicing.
74+
75+
## Feedback
76+
77+
* [File an issue](https://github.com/microsoft/dotnet-framework-docker/issues/new/choose)
78+
* [Contact Microsoft Support](https://support.microsoft.com/contactus/)
79+
80+
# License
81+
82+
* [Microsoft Container Images Legal Notice](https://aka.ms/mcr/osslegalnotice): applies to all [.NET Framework container images](https://hub.docker.com/_/microsoft-dotnet-framework/)
83+
* [Microsoft Software Supplemental License for Windows Container Base Image](https://hub.docker.com/_/microsoft-windows-servercore/): applies to all [.NET Framework container images](https://hub.docker.com/_/microsoft-dotnet-framework/)
84+
* [Visual Studio Tools License](https://visualstudio.microsoft.com/license-terms/mlt031519/): applies to all [.NET Framework SDK container images](https://hub.docker.com/_/microsoft-dotnet-framework-sdk/)

‎.portal-docs/docker-hub/README.samples.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Featured tags
2+
3+
* `dotnetapp`
4+
* `docker pull mcr.microsoft.com/dotnet/framework/samples:dotnetapp`
5+
* `aspnetapp`
6+
* `docker pull mcr.microsoft.com/dotnet/framework/samples:aspnetapp`
7+
* `wcfservice`
8+
* `docker pull mcr.microsoft.com/dotnet/framework/samples:wcfservice`
9+
* `wcfclient`
10+
* `docker pull mcr.microsoft.com/dotnet/framework/samples:wcfclient`
11+
12+
# About
13+
14+
These images contain sample .NET Framework, ASP.NET and WCF applications.
15+
16+
Watch [discussions](https://github.com/microsoft/dotnet-framework-docker/discussions/categories/announcements) for Docker-related .NET announcements.
17+
18+
# Usage
19+
20+
The [.NET Framework Docker samples](https://github.com/microsoft/dotnet-framework-docker/blob/main/samples/README.md) show various ways to use .NET Framework and Docker together.
21+
22+
## Container sample: Run a simple application
23+
24+
Type the following command to run a sample console application with Docker:
25+
26+
```console
27+
docker run --rm mcr.microsoft.com/dotnet/framework/samples:dotnetapp
28+
```
29+
30+
## Container sample: Run a web application
31+
32+
Type the following command to run a sample web application with Docker:
33+
34+
```console
35+
docker run -it --rm -p 8000:80 --name aspnet_sample mcr.microsoft.com/dotnet/framework/samples:aspnetapp
36+
```
37+
38+
After the application starts, navigate to `http://localhost:8000` in your web browser. You need to navigate to the application via IP address instead of `localhost` for earlier Windows versions, which is demonstrated in [View the ASP.NET app in a running container on Windows](https://github.com/microsoft/dotnet-framework-docker/blob/main/samples/aspnetapp/README.md#view-the-aspnet-app-in-a-running-container-on-windows).
39+
40+
## Container sample: Run WCF service and client applications
41+
42+
Type the following command to run a sample WCF service application with Docker:
43+
44+
```console
45+
docker run -it --rm --name wcfservice_sample mcr.microsoft.com/dotnet/framework/samples:wcfservice
46+
```
47+
48+
After the container starts, find the IP address of the container instance:
49+
50+
```console
51+
docker inspect --format="{{.NetworkSettings.Networks.nat.IPAddress}}" wcfservice_sample
52+
172.26.236.119
53+
```
54+
55+
Type the following Docker command to start a WCF client container, set environment variable HOST to the IP address of the wcfservice_sample container:
56+
57+
```console
58+
docker run --name wcfclient_sample --rm -it -e HOST=172.26.236.119 mcr.microsoft.com/dotnet/framework/samples:wcfclient
59+
```
60+
61+
# Related repositories
62+
63+
.NET Framework:
64+
65+
* [dotnet/framework/sdk](https://hub.docker.com/_/microsoft-dotnet-framework-sdk/): .NET Framework SDK
66+
* [dotnet/framework/aspnet](https://hub.docker.com/_/microsoft-dotnet-framework-aspnet/): ASP.NET Web Forms and MVC
67+
* [dotnet/framework/runtime](https://hub.docker.com/_/microsoft-dotnet-framework-runtime/): .NET Framework Runtime
68+
* [dotnet/framework/wcf](https://hub.docker.com/_/microsoft-dotnet-framework-wcf/): Windows Communication Foundation (WCF)
69+
70+
.NET:
71+
72+
* [dotnet](https://hub.docker.com/_/microsoft-dotnet/): .NET
73+
* [dotnet-nightly](https://hub.docker.com/_/microsoft-dotnet-nightly/): .NET (Preview)
74+
* [dotnet/samples](https://hub.docker.com/_/microsoft-dotnet-samples/): .NET Samples
75+
76+
# Full Tag Listing
77+
78+
View the current tags at the [Microsoft Artifact Registry portal](https://mcr.microsoft.com/product/dotnet/framework/samples/tags) or on [GitHub](https://github.com/microsoft/dotnet-framework-docker/blob/main/README.samples.md#full-tag-listing).
79+
80+
# Support
81+
82+
## Lifecycle
83+
84+
* [.NET Framework Lifecycle FAQ](https://support.microsoft.com/help/17455/lifecycle-faq-net-framework)
85+
* [Supported Tags Policy](https://github.com/microsoft/dotnet-framework-docker/blob/main/documentation/supported-tags.md)
86+
87+
## Image Update Policy
88+
89+
* We update the supported .NET Framework images within 12 hours of any updates to their base images (e.g. windows/servercore:ltsc2019, windows/servercore:ltsc2022, etc.).
90+
* We publish .NET Framework images as part of releasing new versions of .NET Framework including major/minor and servicing.
91+
92+
## Feedback
93+
94+
* [File an issue](https://github.com/microsoft/dotnet-framework-docker/issues/new/choose)
95+
* [Contact Microsoft Support](https://support.microsoft.com/contactus/)
96+
97+
# License
98+
99+
* [Microsoft Container Images Legal Notice](https://aka.ms/mcr/osslegalnotice): applies to all [.NET Framework container images](https://hub.docker.com/_/microsoft-dotnet-framework/)
100+
* [Microsoft Software Supplemental License for Windows Container Base Image](https://hub.docker.com/_/microsoft-windows-servercore/): applies to all [.NET Framework container images](https://hub.docker.com/_/microsoft-dotnet-framework/)
101+
* [Visual Studio Tools License](https://visualstudio.microsoft.com/license-terms/mlt031519/): applies to all [.NET Framework SDK container images](https://hub.docker.com/_/microsoft-dotnet-framework-sdk/)

‎.portal-docs/docker-hub/README.sdk.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Featured tags
2+
3+
* `4.8.1`
4+
* `docker pull mcr.microsoft.com/dotnet/framework/sdk:4.8.1`
5+
* `4.8`
6+
* `docker pull mcr.microsoft.com/dotnet/framework/sdk:4.8`
7+
* `3.5`
8+
* `docker pull mcr.microsoft.com/dotnet/framework/sdk:3.5`
9+
10+
# About
11+
12+
This image contains the .NET Framework SDK which is comprised of the following parts:
13+
14+
1. .NET Framework Runtime
15+
1. Visual Studio Build Tools
16+
1. Visual Studio Test Agent
17+
1. NuGet CLI
18+
1. .NET Framework Targeting Packs
19+
1. ASP.NET Web Targets
20+
21+
Use this image for your development process (developing, building and testing applications).
22+
23+
Watch [discussions](https://github.com/microsoft/dotnet-framework-docker/discussions/categories/announcements) for Docker-related .NET announcements.
24+
25+
# Usage
26+
27+
The [.NET Framework Docker samples](https://github.com/microsoft/dotnet-framework-docker/blob/main/samples/README.md) show various ways to use .NET Framework and Docker together.
28+
29+
## Building .NET Framework Apps with Docker
30+
31+
* [.NET Framework Console Docker Sample](dotnetapp/README.md) - This [sample](dotnetapp/Dockerfile) builds, tests, and runs the sample. It includes and builds multiple projects.
32+
* [ASP.NET Web Forms Docker Sample](aspnetapp/README.md) - This [sample](aspnetapp/Dockerfile) demonstrates using Docker with an ASP.NET Web Forms app.
33+
* [ASP.NET MVC Docker Sample](aspnetmvcapp/README.md) - This [sample](aspnetmvcapp/Dockerfile) demonstrates using Docker with an ASP.NET MVC app.
34+
* [WCF Docker Sample](wcfapp/README.md) - This [sample](wcfapp/) demonstrates using Docker with a WCF app.
35+
36+
## Version Compatibility
37+
38+
Version Tag | OS Version | Supported .NET Versions
39+
-- | -- | --
40+
4.8.1 | windowsservercore-ltsc2022 | 4.8.1*
41+
4.8 | windowsservercore-ltsc2022, windowsservercore-ltsc2019, windowsservercore-ltsc2016 | 4.8*
42+
4.7.2 | windowsservercore-ltsc2019, windowsservercore-ltsc2016 | 4.7.2
43+
4.7.1 | windowsservercore-ltsc2016 | 4.7.1
44+
4.7 | windowsservercore-ltsc2016 | 4.7
45+
4.6.2 | windowsservercore-ltsc2016 | 4.6.2
46+
3.5 | windowsservercore-ltsc2022 | 4.7.2, 3.5, 3.0, 2.5
47+
3.5 | windowsservercore-ltsc2019 | 4.7.2, 3.5, 3.0, 2.5
48+
3.5 | windowsservercore-ltsc2016 | 4.6.2, 3.5, 3.0, 2.5
49+
50+
\* The 4.8 and 4.8.1 SDKs are also capable of building 4.8.1, 4.8, 4.7.2, 4.7.1, 4.7, and 4.6.2 projects.
51+
52+
# Related repositories
53+
54+
.NET Framework:
55+
56+
* [dotnet/framework/aspnet](https://hub.docker.com/_/microsoft-dotnet-framework-aspnet/): ASP.NET Web Forms and MVC
57+
* [dotnet/framework/runtime](https://hub.docker.com/_/microsoft-dotnet-framework-runtime/): .NET Framework Runtime
58+
* [dotnet/framework/wcf](https://hub.docker.com/_/microsoft-dotnet-framework-wcf/): Windows Communication Foundation (WCF)
59+
* [dotnet/framework/samples](https://hub.docker.com/_/microsoft-dotnet-framework-samples/): .NET Framework, ASP.NET and WCF Samples
60+
61+
.NET:
62+
63+
* [dotnet](https://hub.docker.com/_/microsoft-dotnet/): .NET
64+
* [dotnet-nightly](https://hub.docker.com/_/microsoft-dotnet-nightly/): .NET (Preview)
65+
* [dotnet/samples](https://hub.docker.com/_/microsoft-dotnet-samples/): .NET Samples
66+
67+
# Full Tag Listing
68+
69+
View the current tags at the [Microsoft Artifact Registry portal](https://mcr.microsoft.com/product/dotnet/framework/sdk/tags) or on [GitHub](https://github.com/microsoft/dotnet-framework-docker/blob/main/README.sdk.md#full-tag-listing).
70+
71+
# Support
72+
73+
## Lifecycle
74+
75+
* [.NET Framework Lifecycle FAQ](https://support.microsoft.com/help/17455/lifecycle-faq-net-framework)
76+
* [Supported Tags Policy](https://github.com/microsoft/dotnet-framework-docker/blob/main/documentation/supported-tags.md)
77+
78+
## Image Update Policy
79+
80+
* We update the supported .NET Framework images within 12 hours of any updates to their base images (e.g. windows/servercore:ltsc2019, windows/servercore:ltsc2022, etc.).
81+
* We publish .NET Framework images as part of releasing new versions of .NET Framework including major/minor and servicing.
82+
83+
## Feedback
84+
85+
* [File an issue](https://github.com/microsoft/dotnet-framework-docker/issues/new/choose)
86+
* [Contact Microsoft Support](https://support.microsoft.com/contactus/)
87+
88+
# License
89+
90+
* [Microsoft Container Images Legal Notice](https://aka.ms/mcr/osslegalnotice): applies to all [.NET Framework container images](https://hub.docker.com/_/microsoft-dotnet-framework/)
91+
* [Microsoft Software Supplemental License for Windows Container Base Image](https://hub.docker.com/_/microsoft-windows-servercore/): applies to all [.NET Framework container images](https://hub.docker.com/_/microsoft-dotnet-framework/)
92+
* [Visual Studio Tools License](https://visualstudio.microsoft.com/license-terms/mlt031519/): applies to all [.NET Framework SDK container images](https://hub.docker.com/_/microsoft-dotnet-framework-sdk/)

0 commit comments

Comments
 (0)