Skip to content

Installing the Burp Agent on your remote server

Miu edited this page Jul 1, 2023 · 2 revisions

Preparing for the installation

To prepare for the installation of Burp, follow these steps:

  1. Install the Burp CLI on your server.

  2. Create a new folder named burp on your server.

  3. Copy the following files into the burp folder:

  4. Rename the .env.example file to .env.

  5. Configure the .env file:

    • Set the BURP_SECRET variable to an argon2id-hashed password. You can generate the hash by using the burp hash [text] command, where [text] is your desired password. Remember to keep a non-hashed version of the password for later use during burp login.
    • Set the BURP_SIGNATURE variable to a long and randomized value. You can generate a random signature using the CLI command: burp eval "[burp: Random(256)]". Save this signature for later use during burp login.

Installing the agent

Once you have configured everything, you can proceed with installing the agent:

  1. Run the following command:

    burp here

    Note: Depending on your Docker setup, you may need to use sudo for certain operations, such as updating or reinstalling, especially if Docker uses root privileges. The burp here command will build the agent locally and start the containers in Docker.

  2. Make sure to expose the port of Burp to the public, as you will need to connect to it from your development environment.

Please refer to the visual reference for a better understanding of the installation process.

Visual Reference

burp-here

To get started with Burp, we recommend reading the following in chronological:

  1. Installing the Burp Agent on your remote server
  2. Setting up Burp CLI on your development machine
  3. Creating your first Burp.toml
  4. Deploying your first application

You may want to read a specific part of configuring a Burp file:

You can also read the list of available functions of Burp:

Clone this wiki locally