Skip to content

Commit de960c4

Browse files
author
Denis Fuenzalida 🐙
committed
Update entries based on offline discussion
1 parent 6e7df6a commit de960c4

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

articles/app-service/reference-app-settings.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -204,20 +204,24 @@ This section shows the configurable runtime settings for each supported language
204204
| `AZURE_LOGGING_DIR` | For Windows Apps, added to Java arguments as `-Dsite.logdir`. The default is `%HOME%\LogFiles\`. Default value in Linux is `AZURE_LOGGING_DIR=/home/LogFiles`. |
205205
| `WEBSITE_AUTH_ROLE_CLAIM_TYPE` | For Java web apps using built-in [authentication](overview-authentication-authorization.md), claims defined in Entra are available in the `HttpServletRequest.isUserInRole` API in the following format: <code>&lt;claimType&gt;&vert;&lt;claimValue&gt;</code> (e.g. <code>team&vert;contoso</code>). To add the values of claims with the type `roles` directly as role names in the `HttpServletRequest` implementation, set `WEBSITE_AUTH_ROLE_CLAIM_TYPE` to the value `roles`. |
206206
| `WEBSITE_JAVA_GC_LOGGING` | For webapps using Java 11 or later in Linux, set this to `true` or `1` to capture Java Garbage Collector logs in `/home/LogFiles/Application` which can be used to troubleshoot performance issues. |
207-
| `WEBSITE_SKIP_DUMP_ON_OUT_OF_MEMORY` | Set to `true` or `1` to disable the following error-handling options that are passed as parameters to the JVM: `-XX:ErrorFile=/home/LogFiles/java_error_XXX.log`, `-XX:+CrashOnOutOfMemoryError`, `-XX:+HeapDumpOnOutOfMemoryError` and `-XX:HeapDumpPath=/home/LogFiles/java_memdump_XXX.log` |
207+
| `WEBSITE_SKIP_DUMP_ON_OUT_OF_MEMORY` | On Linux, set this to `true` or `1` to disable the following error-handling options that, by default, are passed as parameters to the JVM: `-XX:ErrorFile=/home/LogFiles/java_error_XXX.log`, `-XX:+CrashOnOutOfMemoryError`, `-XX:+HeapDumpOnOutOfMemoryError` and `-XX:HeapDumpPath=/home/LogFiles/java_memdump_XXX.log` |
208208
| `WEBSITE_WORKING_DIR` | On Linux, set this to a path where the bootstrapping process should change before launching Java/Tomcat/JBoss. This is useful for webapps using Java 8, where Java error logs are saved to the same directory where Java was launched. |
209-
| `WEBSITE_AUTOCONFIGURE_DATABASE` | When set to `true` or `1` on a Tomcat webapp on Linux, it will enable automatic discovery of JDBC URLs in environment variables for PostgreSQL, MySQL and SQL Server. If a JDBC URL is found, a new DataSource resource will be created in the file `context.xml` before starting up Tomcat and the appropriate JDBC driver will be loaded. |
210209
| `WEBSITE_CATALINA_MAXCONNECTIONS` | If set, the value is passed as the runtime property `catalina.maxConnections` in the `JAVA_OPTS` environment variable, unless the property was already in `JAVA_OPTS`. If not set, defaults to `10000`. |
211210
| `WEBSITE_CATALINA_MAXTHREADS` | If set, the value is passed as the runtime property `catalina.maxThreads` in the `JAVA_OPTS` environment variable, unless the property was already set in `JAVA_OPTS`. If not set, defaults to `200`. |
212-
| `WEBSITE_JAVA_JAR_FILE_NAME` | If set and the web application is a standalone Java (Java web server) application, this can be used to designate the name of a JAR file if there are multiple JAR files deployed, or the location of the file is not standard (e.g. in the `wwwroot` directory). |
213-
| `WEBSITE_JAVA_WAR_FILE_NAME` | If set and the web application is a Tomcat application, this can be used to designate the name of a single WAR file if there are multiple WAR files deployed, or the location of the file is not standard (e.g. in the `wwwroot` directory). |
214-
| `WEBSITE_JAVA_KEYSTORE_PASSWORD` | The value of the keystore password to be used to store certificates with the `keytool` tool. It defaults to `changeit`. |
215-
| `WEBSITE_SKIP_AUTOCONFIGURE_DATABASE` | When set to `true` or `1` on Jboss webapps, will cause the detection of JDBC URLs during startup to be skipped. The detection of JDBC URLs is enabled by default for JBoss. When an environment variable contains a JDBC URL, a JNDI datasource based on variable name will be created, including the apropriate JDBC driver. For instance, for an environment variable with the name `APP_DB`, the associated JNDI entry will be created on `java:jboss/env/jdbc/APP_DB`. Supports PostgreSQL, MySQL, MariaDB, Azure SQL and Oracle. |
216-
| `WEBSITE_SKIP_AZMON_CONFIG` | When set to `true` or `1` on Java Linux or Tomcat Linux, this setting will skip the configuration that integrates the default logging with Logs monitoring. |
211+
| `WEBSITE_JAVA_JAR_FILE_NAME` | If set and the web application is a standalone Java (Java web server) application, this can be used to designate the name of a JAR file if there are multiple JAR files deployed, or the location of the file is not standard (e.g. in the `wwwroot` directory). Defaults to `app.jar`. |
212+
| `WEBSITE_JAVA_WAR_FILE_NAME` | If set and the web application is a Tomcat application, this can be used to designate the name of a single WAR file if there are multiple WAR files deployed, or the location of the file is not standard (e.g. in the `wwwroot` directory). Defaults to `app.war`. |
213+
| `WEBSITE_JAVA_KEYSTORE_PASSWORD` | The value of the keystore password used to store certificates with the `keytool` tool. |
217214
| `WEBSITE_TOMCAT_APPSERVICE_ERROR_PAGE` | On Tomcat webapps, when set to `1` or `true`, the default Tomcat error page is replaced with a custom App Service error page. Defaults to `true`. |
218-
| `WEBSITE_TOMCAT_ERROR_DETAILS` | Defaults to `false`. On Tomcat webapps, when set to `1` or `true`, the runtime properties `catalina.valves.showReport` and `catalina.valves.showServerInfo` are both set to true in `JAVA_OPTS`. `catalina.valves.showReport` enables the stack trace of a failed request is shown in the respose; `catalina.valves.showServerInfo` enables the server version to be included in the response. |
215+
| `WEBSITE_TOMCAT_ERROR_DETAILS` | Defaults to `false`. On Tomcat webapps, when set to `1` or `true`, the runtime properties `catalina.valves.showReport` and `catalina.valves.showServerInfo` are both set to true in `JAVA_OPTS`. Setting `catalina.valves.showReport` to `true` enables the stack trace of a failed request is shown in the respose; setting `catalina.valves.showServerInfo` to `true` causes the Tomcat version to be included in the response. |
219216
| `WEBSITE_SKIP_TROUBLESHOOT_ARCHIVE` | By default, JAR and WAR archives are scanned for common problems during application startup. This includes looking for duplicate/conflicting Java classes inside the archive, which is a common problem that causes Java apps to crash. Setting this value to `true` or `1` will skip the scanning process. Defaults to `false`. |
220217

218+
<!-- | `WEBSITE_SKIP_AZMON_CONFIG` | When set to `true` or `1` on Java Linux or Tomcat Linux, this setting will skip the configuration that integrates the default logging with Logs monitoring. | -->
219+
220+
<!-- These two will be consolidated in a single App Setting with opt-in behavior -->
221+
<!-- | `WEBSITE_AUTOCONFIGURE_DATABASE` | When set to `true` or `1` on a Tomcat webapp on Linux, it will enable automatic discovery of JDBC URLs in environment variables for PostgreSQL, MySQL and SQL Server. If a JDBC URL is found, a new DataSource resource will be created in the file `context.xml` before starting up Tomcat and the appropriate JDBC driver will be loaded. | -->
222+
<!-- | `WEBSITE_SKIP_AUTOCONFIGURE_DATABASE` | When set to `true` or `1` on Jboss webapps, will cause the detection of JDBC URLs during startup to be skipped. The detection of JDBC URLs is enabled by default for JBoss. When an environment variable contains a JDBC URL, a JNDI datasource based on variable name will be created, including the apropriate JDBC driver. For instance, for an environment variable with the name `APP_DB`, the associated JNDI entry will be created on `java:jboss/env/jdbc/APP_DB`. Supports PostgreSQL, MySQL, MariaDB, Azure SQL and Oracle. | -->
223+
224+
221225
<!--
222226
WEBSITE_JAVA_COPY_ALL
223227
AZURE_SITE_APP_BASE

0 commit comments

Comments
 (0)