> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flexagon.com/llms.txt
> Use this file to discover all available pages before exploring further.

# deploy

> Deploys a web application (WAR) to a running Tomcat server. The WAR can be produced from any Build operation. Target Properties Property Name Property

Deploys a web application (WAR) to a running Tomcat server. The WAR can be produced from any Build operation.

# Target Properties

<table><colgroup><col /><col /><col /><col /></colgroup><tbody><tr><th>**Property Name**</th><th>**Property Code**</th><th>**Required**</th><th>**Description**</th></tr><tr><td>Tomcat Catalina Home</td><td>`FDTOM_CATALINA_HOME`</td><td>Yes</td><td>The CATALINA\_HOME directory for the Tomcat installation.</td></tr><tr><td>Tomcat Catalina Base</td><td>`FDTOM_CATALINA_BASE`</td><td>No</td><td>The CATALINA\_BASE directory for the Tomcat server for Instance specific information like conf, bin, webapps etc. Defaults to Tomcat Catalina Home.</td></tr><tr><td>Tomcat Manager URL</td><td>`FDTOM_MANAGER_URL`</td><td>No</td><td>The url of the Manager web application within the Tomcat server. In Tomcat 6, the manager url is likely[[http://localhost:8080/manager](http://localhost:8080/manager)](http://localhost:8080/manager). In Tomcat 7+, the manager url is likely [[http://localhost:8080/manager/text](http://localhost:8080/manager/text)](http://localhost:8080/manager/text).Be aware that the manager app must be running on the endpoint that you are connecting to for the deploy operation.</td></tr><tr><td>Tomcat Username</td><td>`FDTOM_USERNAME`</td><td>No</td><td>The name of the Tomcat user with which to connect to the Manager web application. This user must be configured with the manager-script role.</td></tr><tr><td>Tomcat Password</td><td>`FDTOM_PASSWORD`</td><td>No</td><td>The password for the `FDTOM_USERNAME` user.</td></tr></tbody></table>

# Project Properties

<table><colgroup><col /><col /><col /><col /></colgroup><tbody><tr><th>**Property Name**</th><th>**Property Code**</th><th>**Required**</th><th>**Description**</th></tr><tr><td>Tomcat Context Root</td><td>`FDTOM_CONTEXT_ROOT`</td><td>No</td><td>The context root path for the application. Required if using the Tomcat Manager, otherwise war name will be context root.</td></tr><tr><td>Tomcat War Name</td><td>`FDTOM_WAR_NAME`</td><td>No</td><td>The name of the web application archive in the artifacts directory (e.g. sample.war). If a relative path is provided, it is assumed relative to the Host appBase directory. If not provided, then it will search for a single war file in the artifacts directory.</td></tr></tbody></table>

# Artifacts

This operation consumes a web application archive (WAR) artifact from the artifacts repository.

# Endpoint Selection

This operation delegates the selection to the workflow developer to determine.

# Endpoint Execution

This operation delegates the execution to the workflow developer to determine.

# Special Considerations

This plugin has the following pre-requisites:

* The `JAVA_HOME` environment variable must be set to a supported JDK for the version of Tomcat being used.

* The Tomcat user specified by property `FDTOM_USERNAME` must be granted the manager (Tomcat 6.0.x) or manager-script (Tomcat 7+) role.

* The target Tomcat server must be running prior to calling this operation.

* The specified WAR file must exist in the artifact repository.