Skip to main content
this document is for:

Deployment: Invicti Platform on-demand

Install internal agent on Docker

Invicti Platform lets you use internal agents to scan targets in your internal environment that are not publicly accessible from the internet or when you do not want to trustlist Invicti cloud agents.

This document explains how to install the Invicti internal agent using Docker CLI. For other installation methods, refer to:

Limitations for internal agents

When the site is internal, and you prefer using internal agents for the scan, you can't create a new Login Sequence Record (LSR) or Business Logic Record. However, you can import them. For further information about recording and downloading an LSR, refer to the Standalone login sequence recorder overview.

Prerequisites

System requirements

To run scans successfully, the agent requires sufficient system resources. The agent only initiates a new scan if the following minimum resources are available:

  • CPU: 2 free core CPU 64-bit processor
  • Memory (RAM): 6 GB available
  • Disk Space: 50 GB of free disk space

Access requirements

  • Ensure you have Docker Desktop installed on your host OS by verifying with the command docker -v in Terminal. If the Terminal shows you the version information, you're all set. Otherwise, refer to the Docker support documentation for installation guidance.
  • Administrator privileges for command execution.
  • Invicti Platform Administrator role.

Trustlisting requirements

Resource allocation behavior

When the agent starts, it checks the available system resources and allocates scan slots accordingly. Each scan slot requires:

  • 6 GB of available RAM
  • 2 CPU cores
  • 50 GB of free disk space

The agent determines how many scans can run in parallel based on these requirements.

info

If a machine has 15 GB RAM, 5 CPU cores, and 500 GB free disk space, the agent allocates 2 scan slots. This means up to 2 scans can run simultaneously, while any additional scans remain queued until a slot becomes available.

The agent dynamically manages resources before and during scan execution. If system resources drop to less than the required threshold, new scans aren't going to begin until sufficient resources are available.

Steps to install an agent using Docker

  1. Select Scans > Agents from the left-side menu.
  2. Click Add new agent.
Add a new agent buttonAdd a new aget button
  1. Enter a name for the agent and click the Docker tile. The token that's displayed here is then used in the installation command.
Add a new agent buttonAdd a new aget button
  1. Copy the command from the on-screen instructions.

  2. Open Terminal and execute the command copied from the Docker installation instructions.

In this table you can see the parameters necessary to configure a Docker container for installing the agent.

ParameterDescription
-dThis indicates detached mode, allowing the container to operate in the background.
--nameAssigns a name to the container.
--urlSpecifies the Invicti URL.
--agentnameDefines the agent name in the Invicti UI, changeable later. If installing multiple agent instances, assign a unique agent name for each instance. (Max 50 characters)
--registration-tokenIf you run the command from the UI, the token is prefilled for you. If you need to copy the token, you can get it from Invicti Scans > Agents > Add new agents > Docker > Token.
  1. Click Done to complete the process.

  2. Your agent is now successfully installed. Access the Agents page to view and manage your internal agents.

You can now assign targets to the installed agent and commence testing your website.


Need help?

Invicti Support team is ready to provide you with technical help. Go to Help Center

Was this page useful?