You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/app-service/reference-app-settings.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,8 @@ The following environment variables are related to the app environment in genera
26
26
|`WEBSITE_PLATFORM_VERSION`| Read-only. App Service platform version. ||
27
27
|`HOME`| Read-only. Path to the home directory (for example, `D:\home` for Windows). ||
28
28
|`SERVER_PORT`| Read-only. The port the app should listen to. ||
29
-
|`WEBSITE_WARMUP_PATH`| A relative path to ping to warm up the app, beginning with a slash. The default is `/`, which pings the root path. The specific path can be pinged by an unauthenticated client, such as Azure Traffic Manager, even if [App Service authentication](overview-authentication-authorization.md) is set to reject unauthenticated clients. (NOTE: This app setting doesn't change the path used by AlwaysOn.) ||
29
+
|`WEBSITE_WARMUP_PATH`| A relative path to ping to warm up the app, beginning with a slash. The default is `/robots933456.txt`. Whenever the platform starts up a container, the orchestrator makes repeated requests against this endpoint. The platform considers any response from this endpoint as an indication that the container is ready. Once the platform considers the container to be ready, it starts forwarding organic traffic to the newly started container. Unless `WEBSITE_WARMUP_STATUSES` is configured, the platform will consider any response from the container at this endpoint - even error codes such as 404 or 502 - as an indication that the container is ready. Note that this appsetting doesn't change the path used by AlwaysOn. ||
30
+
| `WEBSITE_WARMUP_STATUSES` | A comma-delimited list of HTTP status codes that will be considered successful when the platform makes warmup pings against a newly started container. Used in conjunction with `WEBSITE_WARMUP_PATH`. By default, any status code is considered an indication that the container is ready for organic traffic. This appsetting can be used to require a specific response before organic traffic is routed to the container. `Example: 200,202`. If pings against the app's configured warmup path receive a response with a 200 or 202 status code, organic traffic will be routed to the container. If a status code that is not in the list is received (such as 502), the platform will continue making pings until (1) a 200 or 202 is received, or (2) the container startup timeout limit is reached (see `WEBSITES_CONTAINER_START_TIME_LIMIT`). Note that if the container doesn't respond with an HTTP status code that is in the list, the platform will eventually fail the startup attempt and retry, which will result in 503 errors. ||
30
31
|`WEBSITE_COMPUTE_MODE`| Read-only. Specifies whether app runs on dedicated (`Dedicated`) or shared (`Shared`) VM/s. ||
31
32
|`WEBSITE_SKU`| Read-only. SKU of the app. Possible values are `Free`, `Shared`, `Basic`, and `Standard`. ||
32
33
|`SITE_BITNESS`| Read-only. Shows whether the app is 32-bit (`x86`) or 64-bit (`AMD64`). ||
@@ -49,6 +50,9 @@ The following environment variables are related to the app environment in genera
49
50
|`WEBSITE_SCM_SEPARATE_STATUS`| Read-only. Shows whether the Kudu app is running in a separate process (`1`) or not (`0`). ||
50
51
|`WEBSITE_DNS_ATTEMPTS`| Number of times to try name resolve. ||
51
52
|`WEBSITE_DNS_TIMEOUT`| Number of seconds to wait for name resolve ||
53
+
|`WEBSITES_CONTAINER_START_TIME_LIMIT`| The amount of time (in seconds) that the platform will wait for a container to become ready on startup. This setting applies to both code-based and container-based apps on App Service for Linux. The default value is `230`. When a container starts up, repeated pings are made against the container to gauge its readiness to serve organic traffic (see `WEBSITE_WARMUP_PATH` and `WEBSITE_WARMUP_STATUSES`). These pings are continuously made until either of the following is true: (1) a successful response is received, or (2) the start time limit is reached. If the container isn't deemed ready within the configured timeout, the platform will fail the startup attempt and retry, which will result in 503 errors. For App Service for Windows Containers, the default start time limit is `10 mins`. You can change the start time limit by specifying a timespan like this `00:05:00`, which indicates 5 minutes.||
54
+
55
+
52
56
<!--
53
57
WEBSITE_PROACTIVE_STACKTRACING_ENABLED
54
58
WEBSITE_CLOUD_NAME
@@ -336,8 +340,7 @@ For more information on custom containers, see [Run a custom container in Azure]
336
340
337
341
| Setting name| Description | Example |
338
342
|-|-|-|
339
-
|`WEBSITES_ENABLE_APP_SERVICE_STORAGE`| For Linux custom containers: set to `true` to enable the `/home` directory to be shared across scaled instances. The default is `false` for Linux custom containers.<br/><br/>For Windows containers: set to `true` to enable the `c:\home` directory to be shared across scaled instances. The default is `true` for Windows containers.||
340
-
|`WEBSITES_CONTAINER_START_TIME_LIMIT`| Amount of time in seconds to wait for the container to complete start-up before restarting the container. Default is `230`. You can increase it up to the maximum of `1800`. ||
343
+
|`WEBSITES_ENABLE_APP_SERVICE_STORAGE`| For Linux containers, if this app setting is not specified, the `/home` directory is shared across scaled instances by default. You can set it to `false` to disable sharing.<br/><br/>For Windows containers: set to `true` to enable the `c:\home` directory to be shared across scaled instances. The default is `true` for Windows containers.||
341
344
|`WEBSITES_CONTAINER_STOP_TIME_LIMIT`| Amount of time in seconds to wait for the container to terminate gracefully. Default is `5`. You can increase to a maximum of `120`||
342
345
|`DOCKER_REGISTRY_SERVER_URL`| URL of the registry server, when running a custom container in App Service. For security, this variable isn't passed on to the container. |`https://<server-name>.azurecr.io`|
343
346
|`DOCKER_REGISTRY_SERVER_USERNAME`| Username to authenticate with the registry server at `DOCKER_REGISTRY_SERVER_URL`. For security, this variable isn't passed on to the container. ||
0 commit comments