---
title: "Web XML File Reference"
description: "This page describes the web.xml file located in the installation directory"
---

# Web XML File Reference

> This page describes the web.xml file located in the installation directory

Ignition is a Java application that comes with an embedded Java EE servlet container, implemented using the open source Eclipse Jetty library. Aspects of this servlet container can be customized using the `web.xml` file, which is an open standard configuration file.

:::caution
Keep in mind that while these attributes can be modified, most installations won't need to change them. If you are interested in changing these attributes, please read through the descriptions thoroughly, and consult with our Support department before proceeding.
:::

## Configuration File Location
The `web.xml` file can be found at:

`%IgnitionInstallationDirectory%/webserver/webapps/main/WEB-INF`

## Web XML Attributes
Many of the attributes in the `web.xml` file are contained within `servlet` annotations, and denoted using XML tags. Other annotations, such as `session-config`, `context-param`, and `filter` are also used.

:::note
The annotations below control some parts of Ignition, but not all. For example, Perspective is tracked using the servlet container session API and thus affected by these annotations, but the Gateway Webpage is not and therefore not subject to these parameters.
:::

### session-config

| Annotation | Description |
|---|---|
| session-config | Defines the session attributes for the web application. |
| session-timeout | The amount of time in minutes after which the session in the web application expires. |
| cookie-config | Defines the settings for session cookies within the web application. |
| http-only | Prevents client scripts from reading cookies. |
| tracking-mode | Indicates how a user's session is tracked. Default is COOKIE. |

### context-param

| Annotation | Description |
|---|---|
| context-param | Defines the initialization parameters for the entire web application. |
| param-name | The name to use within the `context-param` element. |
| param-value | The string value to use within the `context-param` element. |

### filter and filter-mapping

| Annotation | Description |
|---|---|
| filter | Defines a filter class and the attributes to use when the web application is initializing. |
| filter-mapping | Specifies which URLs or servlets that the filter is to be used on. |
| filter-name | The name of the filter to be mapped to a URL pattern or servlet. The `filter-name` for both `filter` and `filter-mapping` should match. |
| filter-class | The qualified class name of the filter. |
| async-supported | Allows the servlet to store requests to respond to later, giving the thread freedom to continue processing other requests. Default is true. |
| url-pattern | The pattern by which URLs are resolved. |

### servlet and servlet-mapping

| Annotation | Description |
|---|---|
| servlet | The Java program running on a web or application server that handles client and HTTP requests and generates dynamic responses. |
| servlet-mapping | Defines the mapping between a servlet and URL pattern. |
| servlet-name | The name of the servlet that the URL pattern will be mapped to. |
| servlet-class | The qualified class name of the servlet. |
| load-on-startup | Indicates the order in which the servlet should be loaded, with lower values loading before higher values. |
| url-pattern | The pattern by which URLs are resolved. |
| multipart-config | Enables file uploading capabilities within the web application. With regards to Ignition, this attribute supports the [File Upload](appendix\components\perspective-components\perspective-input-palette\perspective-file-upload\perspective-file-upload.md) component. Elements within this attribute include: `max-file-size`:  The maximum size allowed for uploading files, in bytes. This element will supercede the File Upload component's fileSizeLimit property, even if the fileSizeLimit is greater. Default is 134217728 (128 MB). Prior to 8.3.9, the default value was 20848820 (20 MB).`max-request-size`: The maximum size allowed for an entire multipart/form-data request, in bytes. Default is 418018841 (418 MB)`file-size-threshold`: The allowed file size to be held in memory before the file is written to disk, in bytes. Default is 1048576 (1 MB) |