Container Tools launch settings

  • 2 minutes to read

In the Properties folder in an ASP.NET Core project, you can find the launchSettings.json file, which contains settings that control how your web app is started on your development machine. For detailed information on how this file is used in ASP.NET development, see Use multiple environments in ASP.NET Core. In launchSettings.json, the settings in the Docker section are related to how Visual Studio handles containerized apps.

    "Docker": {
      "commandName": "Docker",
      "launchBrowser": true,
      "launchUrl": "{Scheme}://{ServiceHost}:{ServicePort}"
    }

    "Docker": {
      "commandName": "Docker",
      "launchBrowser": true,
      "launchUrl": "{Scheme}://{ServiceHost}:{ServicePort}",
      "environmentVariables": {
        "ASPNETCORE_URLS": "https://+:443;http://+:80",
        "ASPNETCORE_HTTPS_PORT": "44360"
      },
      "httpPort": 51803,
      "useSSL": true,
      "sslPort": 44360
    }

The commandName setting identifies that this section applies to Container Tools. The following table shows the properties that can be set in this section:

Setting name Version Example Description
launchBrowser Visual Studio 2017 "launchBrowser": true Indicates whether to launch the browser after successfully launching the project.
launchUrl Visual Studio 2017 "launchUrl": "{Scheme}://{ServiceHost}:{ServicePort}" This URL is used when launching the browser. Supported replacement tokens for this string are:
{Scheme} - Replaced with either "http" or "https" depending on whether SSL is used.
{ServiceHost} - Usually replaced with "localhost". When targeting Windows containers on Windows 10 RS3 or older, though, it is replaced with the container's IP.
{ServicePort} - Usually replaced with either sslPort or httpPort, depending on whether SSL is used. When targeting Windows containers on Windows 10 RS3 or older, though, it is replaced with either "443" or "80", depending on whether SSL is used.
Setting name Example Description
commandLineArgs "commandLineArgs": "--mysetting myvalue" These command-line arguments are used when launching your project in the container.
environmentVariables "environmentVariables": { These environment variable values are passed to the process when it is launched in the container.
"ASPNETCORE_URLS": "https://+:443;http://+:80",
"ASPNETCORE_HTTPS_PORT": "44381"
}
httpPort "httpPort": 24051 This port on the host is mapped to the container's port 80 when launching the container.
If unspecified, the value is taken from the iisSettings value.
launchBrowser "launchBrowser": true Indicates whether to launch the browser after successfully launching the project.
launchUrl "launchUrl": "{Scheme}://{ServiceHost}:{ServicePort}" This URL is used when launching the browser. Supported replacement tokens for this string are:
- {Scheme} - Replaced with either "http" or "https" depending on whether SSL is used.
- {ServiceHost} - Usually replaced with "localhost".
When targeting Windows containers on Windows 10 RS3 or older, though, it is replaced with the container's IP.
- {ServicePort} - Usually replaced with either sslPort or httpPort, depending on whether SSL is used.
When targeting Windows containers on Windows 10 RS3 or older, though, it is replaced with either "443" or "80",
depending on whether SSL is used.
sslPort "sslPort": 44381 This port on the host is mapped to the container's port 443 when launching the container.
If unspecified, the value is taken from the iisSettings value.
useSSL "useSSL": true Indicates whether to use SSL when launching the project. If useSSL is not specified, then SSL is used when sslPort > 0.

Next steps

Configure your project by setting the Container Tools build properties.

See also

Docker Compose build properties