2018-02-08 23:16:43 -06:00 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								---
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								title: Deploying the Executable WAR
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								category: Getting Started
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								chapter: 1
							 
						 
					
						
							
								
									
										
										
										
											2024-04-07 19:37:44 +02:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								order: 3
							 
						 
					
						
							
								
									
										
										
										
											2018-02-08 23:16:43 -06:00 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								---
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								An executable WAR is a traditional Java Web Archive (WAR) that is packaged in a way where it can executed from 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								the command-line. Unlike traditional WARs which require a Servlet container already installed and 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								configured, executable WARs fast-track this process by bundling a Servlet container specifically configured to 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								execute the bundled application.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								The Dependency-Track executable WAR is delivered ready-to-run. To use the executable WAR, the only requirement 
							 
						 
					
						
							
								
									
										
										
										
											2022-09-16 15:21:42 +02:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								is to have Java 17 (or higher) installed.
							 
						 
					
						
							
								
									
										
										
										
											2018-02-08 23:16:43 -06:00 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2020-12-26 23:27:00 -06:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								>  **Deprecation Notice**
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								>
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								>  The Executable WAR is deprecated and will no longer be distributed in a future version of Dependency-Track
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								>  It is advisable that organizations migrate to a container strategy such as Docker or Kubernetes.
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								The Executable WAR is available in two variants:
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								*  API Server
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								*  Bundled
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								  
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								Refer to [distributions ](../distributions/ ) for details.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2018-09-06 11:40:30 -05:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								### Requirements
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2022-07-30 22:47:32 +02:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								| Minimum             | Recommended         |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								|:--------------------|:--------------------|
							 
						 
					
						
							
								
									
										
										
										
											2022-09-16 15:21:42 +02:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								| Java 17 (or higher) | Java 17 (or higher) |
							 
						 
					
						
							
								
									
										
										
										
											2022-07-30 22:47:32 +02:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								| 4GB RAM             | 16GB RAM            |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								| 2 CPU cores         | 4 CPU cores         |
							 
						 
					
						
							
								
									
										
										
										
											2018-09-06 11:40:30 -05:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2022-09-16 15:21:42 +02:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								If minimum requirements are not met, Dependency-Track will not start correctly. However, for systems with Java 17 
							 
						 
					
						
							
								
									
										
										
										
											2018-09-06 11:40:30 -05:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								already installed, this method of execution may provide the fastest deployment path.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2022-11-27 17:11:30 +01:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								>  These requirements can be disabled by setting the 'system.requirement.check.enabled' property or the 'SYSTEM_REQUIREMENT_CHECK_ENABLED' environment variable to 'false'.
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2018-09-06 11:40:30 -05:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								### Startup
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2018-02-08 23:16:43 -06:00 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								```bash
							 
						 
					
						
							
								
									
										
										
										
											2018-09-06 11:40:30 -05:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								# Executes Dependency-Track with default options
 
							 
						 
					
						
							
								
									
										
										
										
											2020-12-26 23:27:00 -06:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								java -Xmx8G -jar dependency-track-bundled.war
							 
						 
					
						
							
								
									
										
										
										
											2018-02-08 23:16:43 -06:00 
										
									 
								 
							 
							
								
							 
							
								 
							 
							
							
								```
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2018-09-06 11:40:30 -05:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								#### Command-Line Arguments
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								The following command-line arguments can be passed to a compiled executable WAR when executing it:
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2022-09-16 15:21:42 +02:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								| Argument | Default | Description                          |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								|:---------|:--------|:-------------------------------------|
							 
						 
					
						
							
								
									
										
										
										
											2018-09-06 11:40:30 -05:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								| -context | /       | The application context to deploy to |
							 
						 
					
						
							
								
									
										
										
										
											2022-09-16 15:21:42 +02:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								| -host    | 0.0.0.0 | The IP address to bind to            |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								| -port    | 8080    | The TCP port to listens on           |
							 
						 
					
						
							
								
									
										
										
										
											2018-09-06 11:40:30 -05:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2020-12-26 23:27:00 -06:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								**Note:** Setting the context is only supported on the API Server variant. The Frontend requires deployment to the root ('/') context.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2018-09-06 11:40:30 -05:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								#### Examples
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								```bash
							 
						 
					
						
							
								
									
										
										
										
											2020-12-26 23:27:00 -06:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								java -Xmx12G -jar dependency-track-apiserver.war -context /dtrack
							 
						 
					
						
							
								
									
										
										
										
											2018-09-06 11:40:30 -05:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								```
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								```bash
							 
						 
					
						
							
								
									
										
										
										
											2020-12-26 23:27:00 -06:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								java -Xmx12G -jar dependency-track-apiserver.war -port 8081
							 
						 
					
						
							
								
									
										
										
										
											2018-09-06 11:40:30 -05:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								```
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								```bash
							 
						 
					
						
							
								
									
										
										
										
											2020-12-26 23:27:00 -06:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								java -Xmx12G -jar dependency-track-apiserver.war -context /dtrack -host 192.168.1.16 -port 9000
							 
						 
					
						
							
								
									
										
										
										
											2019-09-28 22:59:32 -05:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								```
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								```bash
							 
						 
					
						
							
								
									
										
										
										
											2020-12-26 23:27:00 -06:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								java -XX:MaxRAMPercentage=80.0 -jar dependency-track-bundled.war
							 
						 
					
						
							
								
									
										
										
										
											2018-09-06 11:40:30 -05:00 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								```