.sh Installer (No Longer Supported)
We have limited our available installers for better security
As part of Rapid7’s continual work to improve your organization’s security, we have limited our available installers to .pkg for Mac and .deb or .rpm for Linux to better safeguard your systems. This means our .sh installer will no longer be released. Insight Agent v4.0.12 is the last available version of the Insight Agent that supports the .sh installer. Note, you can still access the documentation for the .sh installer.
We recommend that you upgrade your Insight Agent deployment procedures to utilize the industry standard installers using our Mac or Linux installation guides as soon as possible.
If you mass-deploy the Insight Agent with a previously downloaded .sh installer, or with the generic link to its latest available version, your existing mass-deployment procedures will continue to work as intended. However, any issues with .sh based installations will no longer be investigated by Rapid7’s technical support team.
Download .sh installer
| OS Architecture | URL | Insight Agent Version | Installer |
|—|—|
| MacOS ARM64 | https://us.storage.endpoint.ingress.rapid7.com/com.rapid7.razor.public/endpoint/agent/1729029427/darwin/arm64/agent_control_1729029427_arm64.sh | 4.0.12 | Download |
| MacOS x64 | https://us.storage.endpoint.ingress.rapid7.com/com.rapid7.razor.public/endpoint/agent/1729029427/darwin/x86_64/agent_control_1729029427_x64.sh | 4.0.12 | Download |
| Linux ARM64 | https://us.storage.endpoint.ingress.rapid7.com/com.rapid7.razor.public/endpoint/agent/1729029427/linux/arm64/agent_control_1729029427_arm64.sh | 4.0.12 | Download |
| Linux x64 | https://us.storage.endpoint.ingress.rapid7.com/com.rapid7.razor.public/endpoint/agent/1729029427/linux/x86_64/agent_control_1729029427_x64.sh | 4.0.12 | Download |
Linux installation
See the below guides for Linux Installation of the .sh installer.
Install using a Token (Linux)
Silent Mac and Linux installations
All Mac and Linux installations of the Insight Agent are silent by default.
Running the Mac or Linux installer from the terminal allows you to specify a custom path for the Insight Agent’s dependencies and configure any Insight Agent attributes for InsightVM. .
Running the Mac installer from the terminal allows you to specify a custom path for the Insight Agent’s dependencies and configure any Insight Agent attributes for InsightVM.
The following example command utilizes these flags:
--config_path- The absolute path where the installer downloads its dependencies.- Note that if you specify this path as a network share, the installer must have write access in order to place the files. Additionally, any local folder specified here must be a writable location that already exists.
--token- The token you generated and copied from the Insight Agent download panel.- Note that the token flag is always required. If the token is not specified, the installer will have no way to download the necessary dependencies.
Token --config_path functionality
Unlike its usage with the Certificate Package installer, the --config_path flag has a different function when used with the Token installer. In this example, the path you specify establishes the target directory where the installer will download and place its necessary configuration files.
If you omit this flag from your command line operation, all configuration files will download to the current directory of the installer.
Install the Insight Agent on Linux (Intel)
- Open a terminal and change the execute permissions of the installer script:
chmod u+x agent_installer-x86_64.sh- Copy and run the command that was formatted for you in the Linux download panel of Agent Management. This command already includes your organizational token. If you want to format the command manually, substitute
<regionalID>and<UUID>with your region code and token as shown in the following example:
sudo ./agent_installer-x86_64.sh install_start --token=<regionalID>:<UUID>Alternatively, if you wish to include the --config_path option noted previously, run the following appended command, substituting <target-directory-for-dependencies>, <regionalID>, and <UUID> with the appropriate values:
sudo ./agent_installer-x86_64.sh install_start --config_path=<target-directory-for-dependencies> --token=<regionalID>:<UUID>Your complete command should match the format shown in this example:
sudo ./agent_installer-x86_64.sh install_start --config_path=/path/to/location/ --token=us:11111111-1111-1111-1111-11111111111The Insight Agent will be installed as a service and appear with the name ir_agent in your service manager. If you prefer to install the Insight Agent without starting the service right away, modify the previous installation command by substituting install_start with install.
Install the Insight Agent on Linux (ARM64)
- Open a terminal and change the execute permissions of the installer script:
chmod u+x agent_installer-arm64.sh- Copy and run the command that was formatted for you in the Linux download panel of Agent Management. This command already includes your organizational token. If you want to format the command manually, substitute
<regionalID>and<UUID>with your region code and token as shown in the following example:
sudo ./agent_installer-arm64.sh install_start --token=<regionalID>:<UUID>Alternatively, if you wish to include the --config_path option noted previously, run the following appended command, substituting <target-directory-for-dependencies>, <regionalID>, and <UUID> with the appropriate values:
sudo ./agent_installer-arm64.sh install_start --config_path=<target-directory-for-dependencies> --token=<regionalID>:<UUID>Your complete command should match the format shown in this example:
sudo ./agent_installer-arm64.sh install_start --config_path=/path/to/location/ --token=us:11111111-1111-1111-1111-11111111111The Insight Agent will be installed as a service and appear with the name ir_agent in your service manager. If you prefer to install the Insight Agent without starting the service right away, modify the previous installation command by substituting install_start with install.
Install using the Certificate Package (Linux)
Certificate Package SSL errors
Due to additional support added for the Insight Agent, deploying with Insight Agent Certificate Packages older than October 2023 can lead to SSL errors. Ensure all deployments use certificate packages downloaded after this date to safeguard our systems. You can download the latest certificate package from insight.rapid7.com > Data Collection Management, Agents.
To successfully install the Insight Agent, ensure that the certificate and configuration files are in the same directory as the installer before you start the installation process.
Install the Insight Agent on Linux (Intel)
- Fully extract the contents of your Certificate Package ZIP file. Make sure that the
.shinstaller script and its dependencies are in the same directory. - Run the following command in a terminal to modify the permissions of the installer script to allow execution:
chmod u+x agent_installer-x86_64.sh- Lastly, run the following command to execute the installer script. The Insight Agent will be installed as a service and appear with the name ir_agent in your service manager:
sudo ./agent_installer-x86_64.sh install_startInstall the Insight Agent on Linux (ARM64)
- Fully extract the contents of your Certificate Package ZIP file. Make sure that the
.shinstaller script and its dependencies are in the same directory. - Run the following command in a terminal to modify the permissions of the installer script to allow execution:
chmod u+x agent_installer-arm64.sh- Lastly, run the following command to execute the installer script. The Insight Agent will be installed as a service and appear with the name ir_agent in your service manager:
sudo ./agent_installer-arm64.sh install_startMac installation
See the below guides for Mac Installation of the .sh installer.
Install using a Token (Mac)
Silent Mac and Linux installations
All Mac and Linux installations of the Insight Agent are silent by default.
Running the Mac or Linux installer from the terminal allows you to specify a custom path for the agent’s dependencies and configure any agent attributes for InsightVM. .
Running the Mac installer from the terminal allows you to specify a custom path for the agent’s dependencies and configure any agent attributes for InsightVM.
The following example command utilizes these flags:
--config_path- The absolute path where the installer downloads its dependencies.- Note that if you specify this path as a network share, the installer must have write access in order to place the files. Additionally, any local folder specified here must be a writable location that already exists.
--token- The token you generated and copied from the Insight Agent download panel.- Note that the token flag is always required. If the token is not specified, the installer will have no way to download the necessary dependencies.
Token --config_path functionality
Unlike its usage with the Certificate Package installer, the --config_path flag has a different function when used with the Token installer. In this example, the path you specify establishes the target directory where the installer will download and place its necessary configuration files.
If you omit this flag from your command line operation, all configuration files will download to the current directory of the installer.
Install the Insight Agent on Mac (Intel)
- Open a terminal and change the execute permissions of the installer script:
chmod u+x agent_installer-x86_64.sh- Copy and run the command that was formatted for you in the Mac download panel of Agent Management. This command already includes your organizational token. If you want to format the command manually, substitute
<regionalID>and<UUID>with your region code and token as shown in the following example:
sudo ./agent_installer-x86_64.sh install_start --token=<regionalID>:<UUID>Alternatively, if you wish to include the --config_path option noted previously, run the following appended command, substituting <target-directory-for-dependencies>, <regionalID>, and <UUID> with the appropriate values:
sudo ./agent_installer-x86_64.sh install_start --config_path=<target-directory-for-dependencies> --token=<regionalID>:<UUID>Your complete command should match the format shown in this example:
sudo ./agent_installer-x86_64.sh install_start --config_path=/path/to/location/ --token=us:11111111-1111-1111-1111-11111111111The Insight Agent will be installed as a service and appear with the name ir_agent in your service manager. If you prefer to install the agent without starting the service right away, modify the previous installation command by substituting install_start with install.
Install the Insight Agent on Mac (ARM64)
- Open a terminal and change the execute permissions of the installer script:
chmod u+x agent_installer-arm64.sh- Copy and run the command that was formatted for you in the Mac download panel of Agent Management. This command already includes your organizational token. If you want to format the command manually, substitute
<regionalID>and<UUID>with your region code and token as shown in the following example:
sudo ./agent_installer-arm64.sh install_start --token=<regionalID>:<UUID>Alternatively, if you wish to include the --config_path option noted previously, run the following appended command, substituting <target-directory-for-dependencies>, <regionalID>, and <UUID> with the appropriate values:
sudo ./agent_installer-arm64.sh install_start --config_path=<target-directory-for-dependencies> --token=<regionalID>:<UUID>- Your complete command should match the format shown in this example:
sudo ./agent_installer-arm64.sh install_start --config_path=/path/to/location/ --token=us:11111111-1111-1111-1111-11111111111The Insight Agent will be installed as a service and appear with the name ir_agent in your service manager. If you prefer to install the Insight Agent without starting the service right away, modify the previous installation command by substituting install_start with install.
Install using the Certificate Package (Mac)
Certificate Package SSL errors
Due to additional support added for the Insight Agent, deploying with Agent Certificate Packages older than October 2023 can lead to SSL errors. Ensure all deployments use certificate packages downloaded after this date to safeguard our systems. You can download the latest certificate package from insight.rapid7.com > Data Collection Management, Agents.
To successfully install the Insight Agent, ensure that the certificate and configuration files are in the same directory as the installer before you start the installation process.
Install the Insight Agent on Mac (Intel)
- Fully extract the contents of your Certificate Package ZIP file. Make sure that the
.shinstaller script and its dependencies are in the same directory. - Run the following command in a terminal to modify the permissions of the installer script to allow execution:
1
chmod u+x agent_installer-x86_64.sh- Lastly, run the following command to execute the installer script. The Insight Agent will be installed as a service and appear with the name ir_agent in your service manager:
1
sudo ./agent_installer-x86_64.sh install_startInstall the Insight Agent on Mac (ARM64)
- Fully extract the contents of your Certificate Package ZIP file. Make sure that the
.shinstaller script and its dependencies are in the same directory. - Run the following command in a terminal to modify the permissions of the installer script to allow execution:
1
chmod u+x agent_installer-arm64.sh- Lastly, run the following command to execute the installer script. The Insight Agent will be installed as a service and appear with the name ir_agent in your service manager:
1
sudo ./agent_installer-arm64.sh install_startAgent Controls
You can execute the following operations on the Insight Agent to perform several functions. The commands listed here are categorized according to the operating system of the asset.
Mac
Open a terminal to execute the following commands:
Start the agent
launchctl start com.rapid7.ir_agent#### Stop the agent
launchctl stop com.rapid7.ir_agentVerify the agent is running
ps aux | grep ir_agentCheck the version number
sudo grep "Agent Info" /opt/rapid7/ir_agent/components/insight_agent/common/agent.log | tail -n1The output should appear in the following form:
2018-03-20 18:03:02,434 [INFO] agent.agent_beacon: Agent Info -- ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX Version: 1.4.84 (1519676870)Reinstall the agent
<installer_extraction_dir>/agent_installer.sh reinstall
<installer_extraction_dir>/agent_installer.sh reinstall_startMaintaining the existing UUID of the agent
Maintaining the existing UUID ensures there are no agent duplicates in your environment.
As long as the agent is already on version 2.0 or later, reinstalling using one of these commands ensures that its previously existing UUID will remain in use.
If you want a reinstalled agent to get a new UUID, uninstall the existing agent and completely remove the agent directory first before running the install_start command again.
Note that reinstalls of any agent running a version prior to 2.0 will not retain their original UUID.
Uninstall the agent
<installer_extraction_dir>/agent_installer.sh uninstallLinux
Open a terminal to execute the following commands:
Additional commands for the Linux installer script
Run ./agent_installer --help to see an output of all installation, service, and miscellaneous options included with the agent installer script.
Start the agent
service ir_agent start
systemctl start ir_agentStop the agent
service ir_agent stop
systemctl stop ir_agentVerify the agent is running
service ir_agent status
systemctl status ir_agentCheck the version number
sudo cat /opt/rapid7/ir_agent/components/insight_agent/common/agent.log | grep "Agent Info" | tail -1lReinstall the agent
.<installer_extraction_dir>/agent_installer.sh reinstall
.<installer_extraction_dir>/agent_installer.sh reinstall_startMaintaining the existing UUID of the agent
Maintaining the existing UUID ensures there are no agent duplicates in your environment.
As long as the agent is already on version 2.0 or later, reinstalling using one of these commands ensures that its previously existing UUID will remain in use.
If you want a reinstalled agent to get a new UUID, uninstall the existing agent and completely remove the agent directory first before running the install_start command again.
Note that reinstalls of any agent running a version prior to 2.0 will not retain their original UUID.
Uninstall the agent
.<installer_extraction_dir>/agent_installer.sh uninstall