Skip to content
This repository was archived by the owner on Nov 30, 2023. It is now read-only.

Commit 328d486

Browse files
committed
Typos and clarifications
1 parent b2a5c92 commit 328d486

File tree

6 files changed

+46
-39
lines changed

6 files changed

+46
-39
lines changed

containers/dotnetcore-2.1/.devcontainer/devcontainer.json

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,20 @@
2020
// and USER_GID in .devcontainer/Dockerfile to match your user if not 1000.
2121
// "-u", "vscode",
2222

23-
// [Optional] Enable HTTPS in ASP.NET by mount a local dev cert exported the dotnet CLI locally:
24-
// Windows PowerShell:
23+
// [Optional] To reuse of your local HTTPS dev cert, first export it locally using this command:
24+
// * Windows PowerShell:
2525
// dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
26-
// macOS/Linux terminal:
27-
// dotnet dev-certs https --trust && dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
26+
// * macOS/Linux terminal:
27+
// dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
2828
//
29-
// After running the command above, uncomment the lines below and open / rebuild the container.
30-
// "-v", "${env:HOME}${env:USERPROFILE}/.aspnet/https:/home/vscode/.aspnet/https"
29+
// Next, after running the command above, uncomment the lines below and open / rebuild the container.
30+
//
31+
// "-v", "${env:HOME}${env:USERPROFILE}/.aspnet/https:/home/vscode/.aspnet/https",
3132
// "-e", "ASPNETCORE_Kestrel__Endpoints__Https__Url=https://*:5001",
3233
// "-e", "ASPNETCORE_Kestrel__Certificates__Default__Password=SecurePwdGoesHere",
3334
// "-e", "ASPNETCORE_Kestrel__Certificates__Default__Path=/home/vscode/.aspnet/https/aspnetapp.pfx",
3435

36+
3537
// [Optional] Override the default HTTP endpoints - need to listen to '*' for appPort to work
3638
"-e", "ASPNETCORE_Kestrel__Endpoints__Http__Url=http://*:5000"
3739
],

containers/dotnetcore-2.1/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,18 @@ While the definition itself works unmodified, there are some tips that can help
1616

1717
### Using appPort with ASP.NET Core
1818

19-
By default, ASP.NET Core only listens to localhost. The challenge is that ASP.NET Core thinks that localhost is inside the container. If you use the `appPort` property in `.devcontainer/devcontainer.json`, the port is [published](https://docs.docker.com/config/containers/container-networking/#published-ports) rather than forwarded. So you can override the defaults so that ASP.NET will listen to traffic from your local machine as well.
19+
By default, ASP.NET Core only listens to localhost. If you use the `appPort` property in `.devcontainer/devcontainer.json`, the port is [published](https://docs.docker.com/config/containers/container-networking/#published-ports) rather than forwarded. Unfortunately, means that ASP.NET Core only listens to localhost is inside the container itself. It needs to listen to `*` or `0.0.0.0` for the application to be accessible externally.
20+
21+
This container solves that problem by setting the environment variable `ASPNETCORE_Kestrel__Endpoints__Http__Url` to `http://*:5000` in `.devcontainer/devcontainer.json`. Using an environment variable to override this setting in the container only, which allows you to leave your actual application config as-is for use when running locally.
2022

2123
```json
2224
"appPort": [5000, 5001],
2325
"runArgs": [
24-
"-e", "ASPNETCORE_Kestrel__Endpoints__Http__Url=http://*:5000",
25-
"-e", "ASPNETCORE_Kestrel__Endpoints__Https__Url=https://*:5001"
26+
"-e", "ASPNETCORE_Kestrel__Endpoints__Http__Url=http://*:5000"
2627
]
2728
```
2829

29-
Rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) if you've already opened your folder in a container so the settings take effect.
30+
If you've already opened your folder in a container, rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) so the settings take effect.
3031

3132
### Enabling HTTPS in ASP.NET Core
3233

@@ -41,7 +42,7 @@ dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.as
4142
**macOS/Linux terminal**
4243

4344
```powershell
44-
dotnet dev-certs https --trust && dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
45+
dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
4546
```
4647

4748
Next, add the following in the `runArgs` array in `.devcontainer/devcontainer.json` (assuming port 5000 and 5001 are the correct ports):
@@ -57,7 +58,7 @@ Next, add the following in the `runArgs` array in `.devcontainer/devcontainer.js
5758
]
5859
```
5960

60-
Rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) if you've already opened your folder in a container so the settings take effect.
61+
If you've already opened your folder in a container, rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) so the settings take effect.
6162

6263
### Debug Configuration
6364

@@ -82,7 +83,7 @@ If you would like to install the Azure CLI update this line in `.devcontainer/Do
8283
ARG INSTALL_AZURE_CLI="true"
8384
```
8485

85-
Rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) if you've already opened your folder in a container so the settings take effect.
86+
If you've already opened your folder in a container, rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) so the settings take effect.
8687

8788
### Adding the definition to your folder
8889

containers/dotnetcore-2.2/.devcontainer/devcontainer.json

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,15 @@
2020
// and USER_GID in .devcontainer/Dockerfile to match your user if not 1000.
2121
// "-u", "vscode",
2222

23-
// [Optional] Enable HTTPS in ASP.NET by mount a local dev cert exported the dotnet CLI locally:
24-
// Windows PowerShell:
23+
// [Optional] To reuse of your local HTTPS dev cert, first export it locally using this command:
24+
// * Windows PowerShell:
2525
// dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
26-
// macOS/Linux terminal:
27-
// dotnet dev-certs https --trust && dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
26+
// * macOS/Linux terminal:
27+
// dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
2828
//
29-
// After running the command above, uncomment the lines below and open / rebuild the container.
30-
// "-v", "${env:HOME}${env:USERPROFILE}/.aspnet/https:/home/vscode/.aspnet/https"
29+
// Next, after running the command above, uncomment the lines below and open / rebuild the container.
30+
//
31+
// "-v", "${env:HOME}${env:USERPROFILE}/.aspnet/https:/home/vscode/.aspnet/https",
3132
// "-e", "ASPNETCORE_Kestrel__Endpoints__Https__Url=https://*:5001",
3233
// "-e", "ASPNETCORE_Kestrel__Certificates__Default__Password=SecurePwdGoesHere",
3334
// "-e", "ASPNETCORE_Kestrel__Certificates__Default__Path=/home/vscode/.aspnet/https/aspnetapp.pfx",

containers/dotnetcore-2.2/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,18 @@ While the definition itself works unmodified, there are some tips that can help
1616

1717
### Using appPort with ASP.NET Core
1818

19-
By default, ASP.NET Core only listens to localhost. The challenge is that ASP.NET Core thinks that localhost is inside the container. If you use the `appPort` property in `.devcontainer/devcontainer.json`, the port is [published](https://docs.docker.com/config/containers/container-networking/#published-ports) rather than forwarded. So you can override the defaults so that ASP.NET will listen to traffic from your local machine as well.
19+
By default, ASP.NET Core only listens to localhost. If you use the `appPort` property in `.devcontainer/devcontainer.json`, the port is [published](https://docs.docker.com/config/containers/container-networking/#published-ports) rather than forwarded. Unfortunately, means that ASP.NET Core only listens to localhost is inside the container itself. It needs to listen to `*` or `0.0.0.0` for the application to be accessible externally.
20+
21+
This container solves that problem by setting the environment variable `ASPNETCORE_Kestrel__Endpoints__Http__Url` to `http://*:5000` in `.devcontainer/devcontainer.json`. Using an environment variable to override this setting in the container only, which allows you to leave your actual application config as-is for use when running locally.
2022

2123
```json
2224
"appPort": [5000, 5001],
2325
"runArgs": [
24-
"-e", "ASPNETCORE_Kestrel__Endpoints__Http__Url=http://*:5000",
25-
"-e", "ASPNETCORE_Kestrel__Endpoints__Https__Url=https://*:5001"
26+
"-e", "ASPNETCORE_Kestrel__Endpoints__Http__Url=http://*:5000"
2627
]
2728
```
2829

29-
Rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) if you've already opened your folder in a container so the settings take effect.
30+
If you've already opened your folder in a container, rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) so the settings take effect.
3031

3132
### Enabling HTTPS in ASP.NET Core
3233

@@ -41,7 +42,7 @@ dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.as
4142
**macOS/Linux terminal**
4243

4344
```powershell
44-
dotnet dev-certs https --trust && dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
45+
dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
4546
```
4647

4748
Next, add the following in the `runArgs` array in `.devcontainer/devcontainer.json` (assuming port 5000 and 5001 are the correct ports):
@@ -57,7 +58,7 @@ Next, add the following in the `runArgs` array in `.devcontainer/devcontainer.js
5758
]
5859
```
5960

60-
Rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) if you've already opened your folder in a container so the settings take effect.
61+
If you've already opened your folder in a container, rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) so the settings take effect.
6162

6263
### Debug Configuration
6364

@@ -82,7 +83,7 @@ If you would like to install the Azure CLI update this line in `.devcontainer/Do
8283
ARG INSTALL_AZURE_CLI="true"
8384
```
8485

85-
Rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) if you've already opened your folder in a container so the settings take effect.
86+
If you've already opened your folder in a container, rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) so the settings take effect.
8687

8788
### Adding the definition to your folder
8889

containers/dotnetcore-3.0/.devcontainer/devcontainer.json

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,15 @@
2020
// and USER_GID in .devcontainer/Dockerfile to match your user if not 1000.
2121
// "-u", "vscode",
2222

23-
// [Optional] Enable HTTPS in ASP.NET by mount a local dev cert exported the dotnet CLI locally:
24-
// Windows PowerShell:
23+
// [Optional] To reuse of your local HTTPS dev cert, first export it locally using this command:
24+
// * Windows PowerShell:
2525
// dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
26-
// macOS/Linux terminal:
27-
// dotnet dev-certs https --trust && dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
26+
// * macOS/Linux terminal:
27+
// dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
2828
//
29-
// After running the command above, uncomment the lines below and open / rebuild the container.
30-
// "-v", "${env:HOME}${env:USERPROFILE}/.aspnet/https:/home/vscode/.aspnet/https"
29+
// Next, after running the command above, uncomment the lines below and open / rebuild the container.
30+
//
31+
// "-v", "${env:HOME}${env:USERPROFILE}/.aspnet/https:/home/vscode/.aspnet/https",
3132
// "-e", "ASPNETCORE_Kestrel__Endpoints__Https__Url=https://*:5001",
3233
// "-e", "ASPNETCORE_Kestrel__Certificates__Default__Password=SecurePwdGoesHere",
3334
// "-e", "ASPNETCORE_Kestrel__Certificates__Default__Path=/home/vscode/.aspnet/https/aspnetapp.pfx",

containers/dotnetcore-3.0/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,18 @@ While the definition itself works unmodified, there are some tips that can help
1616

1717
### Using appPort with ASP.NET Core
1818

19-
By default, ASP.NET Core only listens to localhost. The challenge is that ASP.NET Core thinks that localhost is inside the container. If you use the `appPort` property in `.devcontainer/devcontainer.json`, the port is [published](https://docs.docker.com/config/containers/container-networking/#published-ports) rather than forwarded. So you can override the defaults so that ASP.NET will listen to traffic from your local machine as well.
19+
By default, ASP.NET Core only listens to localhost. If you use the `appPort` property in `.devcontainer/devcontainer.json`, the port is [published](https://docs.docker.com/config/containers/container-networking/#published-ports) rather than forwarded. Unfortunately, means that ASP.NET Core only listens to localhost is inside the container itself. It needs to listen to `*` or `0.0.0.0` for the application to be accessible externally.
20+
21+
This container solves that problem by setting the environment variable `ASPNETCORE_Kestrel__Endpoints__Http__Url` to `http://*:5000` in `.devcontainer/devcontainer.json`. Using an environment variable to override this setting in the container only, which allows you to leave your actual application config as-is for use when running locally.
2022

2123
```json
2224
"appPort": [5000, 5001],
2325
"runArgs": [
24-
"-e", "ASPNETCORE_Kestrel__Endpoints__Http__Url=http://*:5000",
25-
"-e", "ASPNETCORE_Kestrel__Endpoints__Https__Url=https://*:5001"
26+
"-e", "ASPNETCORE_Kestrel__Endpoints__Http__Url=http://*:5000"
2627
]
2728
```
2829

29-
Rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) if you've already opened your folder in a container so the settings take effect.
30+
If you've already opened your folder in a container, rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) so the settings take effect.
3031

3132
### Enabling HTTPS in ASP.NET Core
3233

@@ -41,7 +42,7 @@ dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.as
4142
**macOS/Linux terminal**
4243

4344
```powershell
44-
dotnet dev-certs https --trust && dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
45+
dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
4546
```
4647

4748
Next, add the following in the `runArgs` array in `.devcontainer/devcontainer.json` (assuming port 5000 and 5001 are the correct ports):
@@ -57,7 +58,7 @@ Next, add the following in the `runArgs` array in `.devcontainer/devcontainer.js
5758
]
5859
```
5960

60-
Rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) if you've already opened your folder in a container so the settings take effect.
61+
If you've already opened your folder in a container, rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) so the settings take effect.
6162

6263
### Debug Configuration
6364

@@ -82,7 +83,7 @@ If you would like to install the Azure CLI update this line in `.devcontainer/Do
8283
ARG INSTALL_AZURE_CLI="true"
8384
```
8485

85-
Rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) if you've already opened your folder in a container so the settings take effect.
86+
If you've already opened your folder in a container, rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) so the settings take effect.
8687

8788
### Adding the definition to your folder
8889

0 commit comments

Comments
 (0)