056a9b7823
Due to various optimisations in recent releases, the previous system requirements are no longer accurate. As a result, the system requirements check that prevents startup if less than 4GB heap is available is no longer practical either. Resource requirements largely depend on portfolio size and concurrent users. Signed-off-by: nscuro <nscuro@protonmail.com>
2.2 KiB
Executable file
| title | category | chapter | order |
|---|---|---|---|
| Deploying the Executable WAR | Getting Started | 1 | 3 |
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 is to have Java 17 (or higher) installed.
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 for details.
Requirements
| Minimum | Recommended |
|---|---|
| Java 21 (or higher) | Java 21 (or higher) |
| 2GB RAM | 8GB RAM |
| 2 CPU cores | 4 CPU cores |
Startup
# Executes Dependency-Track with default options
java -Xmx8G -jar dependency-track-bundled.war
Command-Line Arguments
The following command-line arguments can be passed to a compiled executable WAR when executing it:
| Argument | Default | Description |
|---|---|---|
| -context | / | The application context to deploy to |
| -host | 0.0.0.0 | The IP address to bind to |
| -port | 8080 | The TCP port to listens on |
Note: Setting the context is only supported on the API Server variant. The Frontend requires deployment to the root ('/') context.
Examples
java -Xmx8G -jar dependency-track-apiserver.jar -context /dtrack
java -Xmx8G -jar dependency-track-apiserver.jar -port 8081
java -Xmx8G -jar dependency-track-apiserver.jar -context /dtrack -host 192.168.1.16 -port 9000
java -XX:MaxRAMPercentage=80.0 -jar dependency-track-bundled.jar