Collector Proxy Configuration

Collectors have the ability to send all received traffic to a configured proxy address if necessary. Proxy configurations are common in situations where your organization's security policy prohibits the collector from communicating directly with the Insight Platform. You can specify your proxy address by modifying the file in your collector installation directory.

This procedure is the same for both new and existing collector installations, but verify that your intended host meets the system requirements if you’re installing a collector for the first time.

Configure a proxy address

Follow these steps to configure a proxy address for your collector:

  1. If you’re installing a new collector, proceed with the installation as you normally would, but do not activate the new collector yet.
    • Your collector will generate a new activation key after you save your proxy configuration. You’ll need to activate your collector with this new key in the final step of this procedure.
  2. Navigate to the conf directory in your collector installation. Default installation paths for this directory are as follows:
    • Linux - /opt/rapid7/collector/conf
    • Windows - C:\Program Files\rapid7\Collector\conf
  3. In the conf directory, locate and open the file with a text editor. This config file contains a series of proxy-related properties that you can modify to specify your proxy destination.

Collector Config Properties

  1. Browse to the lines that contain the https.proxyHost and https.proxyPort properties. Replace the and 443 portions in each line with the necessary values.
    • The value you assign to https.proxyHost can be a hostname or an IP address.
  2. After specifying these values, delete the preceding # from both lines to activate them.
    • The # character instructs the collector to ignore anything written to that line. Deleting them ensures that the collector can read and understand your proxy properties.

Collector Config Properties Enabled

  1. If your proxy requires basic authentication, repeat the same process with the following properties (skip this step if authentication is not necessary):
    • https.proxyUser
    • https.proxyPassword
    • https.proxyUserDomain
  2. After making all necessary changes, save and close the file.
  3. Restart the collector service.
    • For collectors on Linux hosts, run the service collector restart command in a terminal.
    • For collectors on Windows hosts, open the service manager and navigate to the Rapid7 Insight Platform Collector service. Right-click the service name and click Restart.
  4. After the collector service restarts and sees your proxy configuration, it will generate a new activation key in a file called Agent_Key.html. You can find this file in the agent-key directory. Default installation paths for this directory are as follows:
    • Linux - /opt/rapid7/collector/agent-key
    • Windows - C:\Program Files\rapid7\Collector\agent-key
  5. Copy your new activation key and open InsightIDR.
  6. In InsightIDR, click the Data Collection tab in your left menu.
  7. On the Data Collection Management screen, click the Collectors tab. The page will display your existing collectors if you have them.
  8. Click Activate Collector in the upper right corner of the screen.
  9. Give your collector a name, paste the activation key in the provided field, and click Activate.

Proxy configuration complete!

Your collector will now send all data it receives to your proxy address before it reaches the Insight Platform.