Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Generate readmes for MCR portal (#3784)
(cherry picked from commit 729ad97)
- Loading branch information
Showing
32 changed files
with
715 additions
and
178 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
## About | ||
|
||
This image contains the ASP.NET Core and .NET runtimes and libraries and is optimized for running ASP.NET Core apps in production. | ||
|
||
Watch [discussions](https://github.com/dotnet/dotnet-docker/discussions/categories/announcements) for Docker-related .NET announcements. | ||
|
||
## Featured Tags | ||
|
||
* `6.0` (Current, LTS) | ||
* `docker pull mcr.microsoft.com/dotnet/aspnet:6.0` | ||
|
||
## Related Repos | ||
|
||
.NET: | ||
|
||
* [dotnet](https://hub.docker.com/_/microsoft-dotnet/): .NET | ||
* [dotnet/sdk](https://hub.docker.com/_/microsoft-dotnet-sdk/): .NET SDK | ||
* [dotnet/runtime](https://hub.docker.com/_/microsoft-dotnet-runtime/): .NET Runtime | ||
* [dotnet/runtime-deps](https://hub.docker.com/_/microsoft-dotnet-runtime-deps/): .NET Runtime Dependencies | ||
* [dotnet/monitor](https://hub.docker.com/_/microsoft-dotnet-monitor/): .NET Monitor Tool | ||
* [dotnet/samples](https://hub.docker.com/_/microsoft-dotnet-samples/): .NET Samples | ||
* [dotnet/nightly/aspnet](https://hub.docker.com/_/microsoft-dotnet-nightly-aspnet/): ASP.NET Core Runtime (Preview) | ||
|
||
.NET Framework: | ||
|
||
* [dotnet/framework](https://hub.docker.com/_/microsoft-dotnet-framework/): .NET Framework, ASP.NET and WCF | ||
* [dotnet/framework/samples](https://hub.docker.com/_/microsoft-dotnet-framework-samples/): .NET Framework, ASP.NET and WCF Samples | ||
|
||
## Usage | ||
|
||
The [.NET Docker samples](https://github.com/dotnet/dotnet-docker/blob/main/samples/README.md) show various ways to use .NET and Docker together. See [Building Docker Images for .NET Applications](https://docs.microsoft.com/dotnet/core/docker/building-net-docker-images) to learn more. | ||
|
||
### Container sample: Run a web application | ||
|
||
You can quickly run a container with a pre-built [.NET Docker image](https://hub.docker.com/_/microsoft-dotnet-samples/), based on the [ASP.NET Core sample](https://github.com/dotnet/dotnet-docker/blob/main/samples/aspnetapp/README.md). | ||
|
||
Type the following command to run a sample web application: | ||
|
||
```console | ||
docker run -it --rm -p 8000:80 --name aspnetcore_sample mcr.microsoft.com/dotnet/samples:aspnetapp | ||
``` | ||
|
||
After the application starts, navigate to `http://localhost:8000` in your web browser. | ||
|
||
See [Hosting ASP.NET Core Images with Docker over HTTPS](https://github.com/dotnet/dotnet-docker/blob/main/samples/host-aspnetcore-https.md) to use HTTPS with this image. | ||
|
||
## Support | ||
|
||
### Lifecycle | ||
|
||
* [Microsoft Support for .NET](https://github.com/dotnet/core/blob/main/microsoft-support.md) | ||
* [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md) | ||
* [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md) | ||
|
||
### Image Update Policy | ||
|
||
* We update the supported .NET images within 12 hours of any updates to their base images (e.g. debian:buster-slim, windows/nanoserver:ltsc2022, buildpack-deps:bionic-scm, etc.). | ||
* We publish .NET images as part of releasing new versions of .NET including major/minor and servicing. | ||
|
||
### Feedback | ||
|
||
* [File an issue](https://github.com/dotnet/dotnet-docker/issues/new/choose) | ||
* [Contact Microsoft Support](https://support.microsoft.com/contactus/) | ||
|
||
## License | ||
|
||
* Legal Notice: [Container License Information](https://aka.ms/mcr/osslegalnotice) | ||
* [.NET license](https://github.com/dotnet/dotnet-docker/blob/main/LICENSE) | ||
* [Discover licensing for Linux image contents](https://github.com/dotnet/dotnet-docker/blob/main/documentation/image-artifact-details.md) | ||
* [Windows base image license](https://docs.microsoft.com/virtualization/windowscontainers/images-eula) (only applies to Windows containers) | ||
* [Pricing and licensing for Windows Server 2019](https://www.microsoft.com/cloud-platform/windows-server-pricing) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
## About | ||
|
||
This image contains the .NET Monitor tool. | ||
|
||
Use this image as a sidecar container to collect diagnostic information from other containers running .NET Core 3.1 or later processes. | ||
|
||
Watch [discussions](https://github.com/dotnet/dotnet-docker/discussions/categories/announcements) for Docker-related .NET announcements. | ||
|
||
## Featured Tags | ||
|
||
* `6` (Current) | ||
* `docker pull mcr.microsoft.com/dotnet/monitor:6` | ||
|
||
## Related Repos | ||
|
||
.NET: | ||
|
||
* [dotnet](https://hub.docker.com/_/microsoft-dotnet/): .NET | ||
* [dotnet/sdk](https://hub.docker.com/_/microsoft-dotnet-sdk/): .NET SDK | ||
* [dotnet/aspnet](https://hub.docker.com/_/microsoft-dotnet-aspnet/): ASP.NET Core Runtime | ||
* [dotnet/runtime](https://hub.docker.com/_/microsoft-dotnet-runtime/): .NET Runtime | ||
* [dotnet/runtime-deps](https://hub.docker.com/_/microsoft-dotnet-runtime-deps/): .NET Runtime Dependencies | ||
* [dotnet/samples](https://hub.docker.com/_/microsoft-dotnet-samples/): .NET Samples | ||
* [dotnet/nightly/monitor](https://hub.docker.com/_/microsoft-dotnet-nightly-monitor/): .NET Monitor Tool (Preview) | ||
|
||
.NET Framework: | ||
|
||
* [dotnet/framework](https://hub.docker.com/_/microsoft-dotnet-framework/): .NET Framework, ASP.NET and WCF | ||
* [dotnet/framework/samples](https://hub.docker.com/_/microsoft-dotnet-framework-samples/): .NET Framework, ASP.NET and WCF Samples | ||
|
||
## Usage | ||
|
||
The [.NET Docker samples](https://github.com/dotnet/dotnet-docker/blob/main/samples/README.md) show various ways to use .NET and Docker together. See [Building Docker Images for .NET Applications](https://docs.microsoft.com/dotnet/core/docker/building-net-docker-images) to learn more. | ||
|
||
### Container sample: Run the tool | ||
|
||
You can run a container with a pre-built [.NET Docker Image](https://hub.docker.com/_/microsoft-dotnet-monitor/), based on the dotnet-monitor global tool. | ||
|
||
See the [documentation](https://go.microsoft.com/fwlink/?linkid=2158052) for how to configure the image to be run in a Docker or Kubernetes environment, including how to configure authentication and certificates for https bindings. | ||
|
||
## Support | ||
|
||
### Lifecycle | ||
|
||
* [Microsoft Support for .NET](https://github.com/dotnet/core/blob/main/microsoft-support.md) | ||
* [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md) | ||
* [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md) | ||
|
||
### Image Update Policy | ||
|
||
* We update the supported .NET images within 12 hours of any updates to their base images (e.g. debian:buster-slim, windows/nanoserver:ltsc2022, buildpack-deps:bionic-scm, etc.). | ||
* We publish .NET images as part of releasing new versions of .NET including major/minor and servicing. | ||
|
||
### Feedback | ||
|
||
* [File an issue](https://github.com/dotnet/dotnet-docker/issues/new/choose) | ||
* [Contact Microsoft Support](https://support.microsoft.com/contactus/) | ||
|
||
## License | ||
|
||
* Legal Notice: [Container License Information](https://aka.ms/mcr/osslegalnotice) | ||
* [.NET license](https://github.com/dotnet/dotnet-docker/blob/main/LICENSE) | ||
* [Discover licensing for Linux image contents](https://github.com/dotnet/dotnet-docker/blob/main/documentation/image-artifact-details.md) | ||
* [Windows base image license](https://docs.microsoft.com/virtualization/windowscontainers/images-eula) (only applies to Windows containers) | ||
* [Pricing and licensing for Windows Server 2019](https://www.microsoft.com/cloud-platform/windows-server-pricing) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
## About | ||
|
||
This image contains the native dependencies needed by .NET. It does not include .NET. It is for [self-contained](https://docs.microsoft.com/dotnet/articles/core/deploying/index) applications. | ||
|
||
Watch [discussions](https://github.com/dotnet/dotnet-docker/discussions/categories/announcements) for Docker-related .NET announcements. | ||
|
||
## Featured Tags | ||
|
||
* `6.0` (Current, LTS) | ||
* `docker pull mcr.microsoft.com/dotnet/runtime-deps:6.0` | ||
|
||
## Related Repos | ||
|
||
.NET: | ||
|
||
* [dotnet](https://hub.docker.com/_/microsoft-dotnet/): .NET | ||
* [dotnet/sdk](https://hub.docker.com/_/microsoft-dotnet-sdk/): .NET SDK | ||
* [dotnet/aspnet](https://hub.docker.com/_/microsoft-dotnet-aspnet/): ASP.NET Core Runtime | ||
* [dotnet/runtime](https://hub.docker.com/_/microsoft-dotnet-runtime/): .NET Runtime | ||
* [dotnet/monitor](https://hub.docker.com/_/microsoft-dotnet-monitor/): .NET Monitor Tool | ||
* [dotnet/samples](https://hub.docker.com/_/microsoft-dotnet-samples/): .NET Samples | ||
* [dotnet/nightly/runtime-deps](https://hub.docker.com/_/microsoft-dotnet-nightly-runtime-deps/): .NET Runtime Dependencies (Preview) | ||
|
||
.NET Framework: | ||
|
||
* [dotnet/framework](https://hub.docker.com/_/microsoft-dotnet-framework/): .NET Framework, ASP.NET and WCF | ||
* [dotnet/framework/samples](https://hub.docker.com/_/microsoft-dotnet-framework-samples/): .NET Framework, ASP.NET and WCF Samples | ||
|
||
## Usage | ||
|
||
The [.NET Docker samples](https://github.com/dotnet/dotnet-docker/blob/main/samples/README.md) show various ways to use .NET and Docker together. See [Building Docker Images for .NET Applications](https://docs.microsoft.com/dotnet/core/docker/building-net-docker-images) to learn more. | ||
|
||
* [.NET self-contained Sample](https://github.com/dotnet/dotnet-docker/blob/main/samples/dotnetapp/dotnet-docker-selfcontained.md) - This [sample](https://github.com/dotnet/dotnet-docker/blob/main/samples/dotnetapp/Dockerfile.debian-x64-selfcontained) builds and runs an application as a self-contained application. | ||
|
||
## Support | ||
|
||
### Lifecycle | ||
|
||
* [Microsoft Support for .NET](https://github.com/dotnet/core/blob/main/microsoft-support.md) | ||
* [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md) | ||
* [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md) | ||
|
||
### Image Update Policy | ||
|
||
* We update the supported .NET images within 12 hours of any updates to their base images (e.g. debian:buster-slim, windows/nanoserver:ltsc2022, buildpack-deps:bionic-scm, etc.). | ||
* We publish .NET images as part of releasing new versions of .NET including major/minor and servicing. | ||
|
||
### Feedback | ||
|
||
* [File an issue](https://github.com/dotnet/dotnet-docker/issues/new/choose) | ||
* [Contact Microsoft Support](https://support.microsoft.com/contactus/) | ||
|
||
## License | ||
|
||
* Legal Notice: [Container License Information](https://aka.ms/mcr/osslegalnotice) | ||
* [.NET license](https://github.com/dotnet/dotnet-docker/blob/main/LICENSE) | ||
* [Discover licensing for Linux image contents](https://github.com/dotnet/dotnet-docker/blob/main/documentation/image-artifact-details.md) | ||
* [Windows base image license](https://docs.microsoft.com/virtualization/windowscontainers/images-eula) (only applies to Windows containers) | ||
* [Pricing and licensing for Windows Server 2019](https://www.microsoft.com/cloud-platform/windows-server-pricing) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
## About | ||
|
||
This image contains the .NET runtimes and libraries and is optimized for running .NET apps in production. | ||
|
||
Watch [discussions](https://github.com/dotnet/dotnet-docker/discussions/categories/announcements) for Docker-related .NET announcements. | ||
|
||
## Featured Tags | ||
|
||
* `6.0` (Current, LTS) | ||
* `docker pull mcr.microsoft.com/dotnet/runtime:6.0` | ||
|
||
## Related Repos | ||
|
||
.NET: | ||
|
||
* [dotnet](https://hub.docker.com/_/microsoft-dotnet/): .NET | ||
* [dotnet/sdk](https://hub.docker.com/_/microsoft-dotnet-sdk/): .NET SDK | ||
* [dotnet/aspnet](https://hub.docker.com/_/microsoft-dotnet-aspnet/): ASP.NET Core Runtime | ||
* [dotnet/runtime-deps](https://hub.docker.com/_/microsoft-dotnet-runtime-deps/): .NET Runtime Dependencies | ||
* [dotnet/monitor](https://hub.docker.com/_/microsoft-dotnet-monitor/): .NET Monitor Tool | ||
* [dotnet/samples](https://hub.docker.com/_/microsoft-dotnet-samples/): .NET Samples | ||
* [dotnet/nightly/runtime](https://hub.docker.com/_/microsoft-dotnet-nightly-runtime/): .NET Runtime (Preview) | ||
|
||
.NET Framework: | ||
|
||
* [dotnet/framework](https://hub.docker.com/_/microsoft-dotnet-framework/): .NET Framework, ASP.NET and WCF | ||
* [dotnet/framework/samples](https://hub.docker.com/_/microsoft-dotnet-framework-samples/): .NET Framework, ASP.NET and WCF Samples | ||
|
||
## Usage | ||
|
||
The [.NET Docker samples](https://github.com/dotnet/dotnet-docker/blob/main/samples/README.md) show various ways to use .NET and Docker together. See [Building Docker Images for .NET Applications](https://docs.microsoft.com/dotnet/core/docker/building-net-docker-images) to learn more. | ||
|
||
### Container sample: Run a simple application | ||
|
||
You can quickly run a container with a pre-built [.NET Docker image](https://hub.docker.com/_/microsoft-dotnet-samples/), based on the [.NET console sample](https://github.com/dotnet/dotnet-docker/blob/main/samples/dotnetapp/README.md). | ||
|
||
Type the following command to run a sample console application: | ||
|
||
```console | ||
docker run --rm mcr.microsoft.com/dotnet/samples | ||
``` | ||
|
||
## Support | ||
|
||
### Lifecycle | ||
|
||
* [Microsoft Support for .NET](https://github.com/dotnet/core/blob/main/microsoft-support.md) | ||
* [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md) | ||
* [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md) | ||
|
||
### Image Update Policy | ||
|
||
* We update the supported .NET images within 12 hours of any updates to their base images (e.g. debian:buster-slim, windows/nanoserver:ltsc2022, buildpack-deps:bionic-scm, etc.). | ||
* We publish .NET images as part of releasing new versions of .NET including major/minor and servicing. | ||
|
||
### Feedback | ||
|
||
* [File an issue](https://github.com/dotnet/dotnet-docker/issues/new/choose) | ||
* [Contact Microsoft Support](https://support.microsoft.com/contactus/) | ||
|
||
## License | ||
|
||
* Legal Notice: [Container License Information](https://aka.ms/mcr/osslegalnotice) | ||
* [.NET license](https://github.com/dotnet/dotnet-docker/blob/main/LICENSE) | ||
* [Discover licensing for Linux image contents](https://github.com/dotnet/dotnet-docker/blob/main/documentation/image-artifact-details.md) | ||
* [Windows base image license](https://docs.microsoft.com/virtualization/windowscontainers/images-eula) (only applies to Windows containers) | ||
* [Pricing and licensing for Windows Server 2019](https://www.microsoft.com/cloud-platform/windows-server-pricing) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
## About | ||
|
||
These images contain sample .NET and ASP.NET Core applications. | ||
|
||
Watch [discussions](https://github.com/dotnet/dotnet-docker/discussions/categories/announcements) for Docker-related .NET announcements. | ||
|
||
## Featured Tags | ||
|
||
* `dotnetapp` [(*Dockerfile*)](https://github.com/dotnet/dotnet-docker/blob/main/samples/dotnetapp/Dockerfile) | ||
* `docker pull mcr.microsoft.com/dotnet/samples:dotnetapp` | ||
* `aspnetapp` [(*Dockerfile*)](https://github.com/dotnet/dotnet-docker/blob/main/samples/aspnetapp/Dockerfile) | ||
* `docker pull mcr.microsoft.com/dotnet/samples:aspnetapp` | ||
|
||
## Related Repos | ||
|
||
.NET: | ||
|
||
* [dotnet](https://hub.docker.com/_/microsoft-dotnet/): .NET | ||
* [dotnet/sdk](https://hub.docker.com/_/microsoft-dotnet-sdk/): .NET SDK | ||
* [dotnet/aspnet](https://hub.docker.com/_/microsoft-dotnet-aspnet/): ASP.NET Core Runtime | ||
* [dotnet/runtime](https://hub.docker.com/_/microsoft-dotnet-runtime/): .NET Runtime | ||
* [dotnet/runtime-deps](https://hub.docker.com/_/microsoft-dotnet-runtime-deps/): .NET Runtime Dependencies | ||
* [dotnet/monitor](https://hub.docker.com/_/microsoft-dotnet-monitor/): .NET Monitor Tool | ||
|
||
.NET Framework: | ||
|
||
* [dotnet/framework](https://hub.docker.com/_/microsoft-dotnet-framework/): .NET Framework, ASP.NET and WCF | ||
* [dotnet/framework/samples](https://hub.docker.com/_/microsoft-dotnet-framework-samples/): .NET Framework, ASP.NET and WCF Samples | ||
|
||
## Usage | ||
|
||
The [.NET Docker samples](https://github.com/dotnet/dotnet-docker/blob/main/samples/README.md) show various ways to use .NET and Docker together. See [Building Docker Images for .NET Applications](https://docs.microsoft.com/dotnet/core/docker/building-net-docker-images) to learn more. | ||
|
||
### Container sample: Run a simple application | ||
|
||
You can quickly run a container with a pre-built [.NET Docker image](https://hub.docker.com/_/microsoft-dotnet-samples/), based on the [.NET console sample](https://github.com/dotnet/dotnet-docker/blob/main/samples/dotnetapp/README.md). | ||
|
||
Type the following command to run a sample console application: | ||
|
||
```console | ||
docker run --rm mcr.microsoft.com/dotnet/samples | ||
``` | ||
|
||
### Container sample: Run a web application | ||
|
||
You can quickly run a container with a pre-built [.NET Docker image](https://hub.docker.com/_/microsoft-dotnet-samples/), based on the [ASP.NET Core sample](https://github.com/dotnet/dotnet-docker/blob/main/samples/aspnetapp/README.md). | ||
|
||
Type the following command to run a sample web application: | ||
|
||
```console | ||
docker run -it --rm -p 8000:80 --name aspnetcore_sample mcr.microsoft.com/dotnet/samples:aspnetapp | ||
``` | ||
|
||
After the application starts, navigate to `http://localhost:8000` in your web browser. | ||
|
||
See [Hosting ASP.NET Core Images with Docker over HTTPS](https://github.com/dotnet/dotnet-docker/blob/main/samples/host-aspnetcore-https.md) to use HTTPS with this image. | ||
|
||
## Support | ||
|
||
### Lifecycle | ||
|
||
* [Microsoft Support for .NET](https://github.com/dotnet/core/blob/main/microsoft-support.md) | ||
* [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md) | ||
* [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md) | ||
|
||
### Image Update Policy | ||
|
||
* We update the supported .NET images within 12 hours of any updates to their base images (e.g. debian:buster-slim, windows/nanoserver:ltsc2022, buildpack-deps:bionic-scm, etc.). | ||
* We publish .NET images as part of releasing new versions of .NET including major/minor and servicing. | ||
|
||
### Feedback | ||
|
||
* [File an issue](https://github.com/dotnet/dotnet-docker/issues/new/choose) | ||
* [Contact Microsoft Support](https://support.microsoft.com/contactus/) | ||
|
||
## License | ||
|
||
* Legal Notice: [Container License Information](https://aka.ms/mcr/osslegalnotice) | ||
* [.NET license](https://github.com/dotnet/dotnet-docker/blob/main/LICENSE) | ||
* [Discover licensing for Linux image contents](https://github.com/dotnet/dotnet-docker/blob/main/documentation/image-artifact-details.md) | ||
* [Windows base image license](https://docs.microsoft.com/virtualization/windowscontainers/images-eula) (only applies to Windows containers) | ||
* [Pricing and licensing for Windows Server 2019](https://www.microsoft.com/cloud-platform/windows-server-pricing) |
Oops, something went wrong.