Black Friday offer! Buy your Burp Suite certified exam for just $9, pass before 15 Dec, and we'll refund your $9.  –   Find out more

ENTERPRISE

Unattended installation of Burp Suite Enterprise Edition

  • Last updated: November 11, 2021

  • Read time: 4 Minutes

Instead of installing Burp Suite Enterprise Edition manually via the installation wizard, you can perform an unattended / silent installation via the command line, passing the required input in a varfile. This is much more efficient when installing on multiple machines.

The easiest way to prepare the varfile is to perform the installation once manually. This will generate a varfile containing most of the required parameters already. You can then reuse this file to perform future installations unattended.

Performing an unattended installation for agent machines

To perform an unattended installation for an agent machine, you can simply copy a response.varfile from an existing agent machine installation and pass it to the installer from the command line.

Generate a response.varfile for agent machine deployment

Perform a manual installation using the same options that you want to use for your unattended installations. This generates the response.varfile in the .install4j subdirectory of your installation directory.

Note

If you have already deployed an agent machine, you can just copy the existing response.varfile.

The default installation directory depends on the operating system you are using:

MacOS

/Applications/Burp Suite Enterprise Edition/.install4j

Windows

C:\Program Files\burpsuite_enterprise\.install4j

Linux

/opt/burpsuite_enterprise/.install4j

Perform an unattended agent machine deployment using the response.varfile

Perform an unattended installation by running the installer from the command line using your response.varfile.

Burpsuite_enterprise_linux_v2021_8_1.sh -c -q -varfile response.varfile

-c runs the installer in command line mode
-q runs the installer in unattended mode
-varfile allows you to specify a response file

The agent fingerprint is sent to standard output (stdout).

Performing an unattended installation of the Enterprise server

To perform an unattended installation of the Enterprise server, you need to add some values into the response.varfile that are not stored by the installer. You can then pass the edited file to the installer from the command line.

Generate a response.varfile for Enterprise server deployment

Perform a manual installation using the same options that you want to use for your unattended installations. This generates the response.varfile in the .install4j subdirectory of your installation directory.

Note

If you have already deployed an enterprise server, you can just copy the existing response.varfile.

The default installation directory depends on the operating system you are using:

MacOS

/Applications/Burp Suite Enterprise Edition/.install4j

Windows

C:\Program Files\burpsuite_enterprise\.install4j

Linux

/opt/burpsuite_enterprise/.install4j

Add missing parameters to the response.varfile

The response.varfile generated by the installer intentionally omits some parameter values to avoid storing sensitive data in a plain text file.

To use the file for unattended installations that include the Enterprise server, add the following parameters to the file manually. Note that some of these are dependent on whether you want to use the bundled H2 database or an external database.

Database logins for agent machines are handled by the Enterprise server, so are included in the varfile for the Enterprise server deployment rather than the one for agent machines.

Parameter

Description

admin_email

The email address that you want to set for the administrator user.

admin_user_name

The username that you want to set for the administrator user.

admin_user_password

The password that you want to set for the administrator user. This must match the admin_user_confirm_password.

admin_user_confirm_password

This must match the admin_user_password.

db_agent_password

The password that the agent machine must use to access your database. If you've forgotten this, you can retrieve it from the Enterprise server's configuration file. Go to /<your-installation-directory>/enterpriseServer/<version-number>/enterprise-server.config and copy the agent_repository.password property.

db_agent_username

The username that the agent machine must use to access your database. If you've forgotten this, you can retrieve it from the Enterprise server's configuration file. Go to /<your-installation-directory>/enterpriseServer/<version-number>/enterprise-server.config and copy the agent_repository.username property.

db_es_password

The password that the Enterprise server must use to access your database. If you've forgotten this, you can retrieve it from the Enterprise server's configuration file. Go to /<your-installation-directory>/enterpriseServer/<version-number>/enterprise-server.config and copy the admin_repository.password property.

db_es_username

The username the Enterprise server must use to access your database. If you've forgotten this, you can retrieve it from the Enterprise server's configuration file. Go to /<your-installation-directory>/enterpriseServer/<version-number>/enterprise-server.config and copy the admin_repository.username property.

db_url_suffix

The connection URL of your database, excluding the scheme/protocol prefix (e.g. jdbc:postgresql://). This is not required if you are using the bundled database.

Example response.varfile

The following is an example of a response.varfile with the additional entries added in.

admin_email=user@emailhost.com
admin_user_name=administrator
admin_user_password=administratorpassword
admin_user_confirm_password=administratorpassword
beuser=burpsuite
beuserandgroup=burpsuite\:burpsuite
dataDirectory=/var/lib/BurpSuiteEnterpriseEdition
dbType=postgres
db_agent_username=beagent
db_agent_password=beagentpassword
db_es_username=beserver
db_es_password=beserverpassword
db_url_suffix=databaseurl:5432
escapedDataDir=/var/lib/BurpSuiteEnterpriseEdition
escapedInstallationDir=/usr/local/burpsuite_enterprise
jreHome=/usr/local/burpsuite_enterprise/jre
logsDirectory=/var/log/BurpSuiteEnterpriseEdition
platformScriptSuffix=sh
sys.adminRights$Boolean=true
sys.component.agent$Boolean=true
sys.component.db$Boolean=true
sys.component.enterprise$Boolean=true
sys.component.web$Boolean=true
sys.installationDir=/usr/local/burpsuite_enterprise
sys.languageId=en
sys.programGroupDisabled$Boolean=true
webserver_port$Integer=8080

Perform an unattended Enterprise server deployment using the response.varfile

Perform an unattended installation by running the installer from the command line using your response.varfile.

Burpsuite_enterprise_linux_v2021_8_1.sh -c -q -varfile response.varfile

  • -c runs the installer in command line mode
  • -q runs the installer in unattended mode
  • -varfile allows you to specify a response file