This document has been created to provide MSSPs and Customers with comprehensive guidance on the installation of the agent for end-customers. To successfully complete the installation process, MSSPs must ensure that they have an active account on CYFOX Cloud.
Preparation:
Reminder: To ensure the Agent functions correctly, clients might need to configure their firewall to allow outbound traffic from the device or network's device to the following addresses and ports:
cloud.cyfox.com:4242 (cloud service) - This will allow the unit/agents to communicate with the cloud, transmitting unit/agent data over port 4242.
validate.cyfox.com:443 (licensing service) - This will enable the unit/agents to activate or validate the unit/agent license.
updates.cyfox.com:443 (update service) - This is for updating the product software and repositories.
cloud.cyfox.com:443 (UI access) - This provides access to the CyFox cloud interface.
If you are using additional security software such as EDR (Endpoint Detection and Response) or antivirus, you may need to whitelist the installation path and all the files included within our agent. This will ensure that the agent can communicate freely and function properly.
Clients using another EDR solution on the same device may require additional configuration beyond whitelisting. This might involve adjusting settings or policies within your EDR software.
Two Installation Modes - Manual and By Script
There are two installation options for the CYFOX agent: manual GUI (relevant only for endpoints) and script-based (relevant to all devices, including servers). The manual option is suitable for installing the agent on a single computer. However, if you need to install the agent on multiple devices within your organization, the script-based approach, which typically involves using a .bat file or similar tools, is recommended.
Script installation enables you to efficiently deploy the agent across multiple devices with speed and in the background, making it a convenient choice for large-scale deployments.
Manual Installation - Endpoint Devices Only
Step 1: Accessing Downloads
Begin by clicking on your username located in the top-right panel.
From the dropdown menu that appears, select "Downloads."
Step 2: Selecting Agent Version
Pick the appropriate agent version for installation, specifically the Agent 64-bit for Windows.
Step 3: Downloading the Agent
Click on the file within the Web Browser Downloads section.
Once the agent installation process begins, proceed by clicking the "Next" button.
Step 4: Selecting Agent Mode
EDR Mode: Recommended for comprehensive detection and response.
Functionality: Responds in real-time to detected threats, reacting based on the level of protection required.
Sensor Mode: For monitoring only.
Functionality: Detects and reports potential threats but does not actively respond to them.
Step 5: Enter the License Key and Activation Key
Enter exactly as displayed in the license information.
2. To access the license information, navigate to the 'Companies' section and click on 'View/Upgrade.' Retrieve the required information from this location.
Step 6: Establish a Password
Set a Password:
Change the 'Password' value from 'None' to a valid password.
Ensure the password is a minimum of 8 characters.
The password must include at least one lowercase letter, one uppercase letter, and one number.
Do not use special characters (e.g., !, @, #).
No Password Option:
If you choose not to use a password, select 'No password.'
Setting a strong password enhances security by preventing unauthorized access.
Step 7: Checking the Agent Status
Locate the Agent: Find the agent icon on the bottom right side of the application panel (system tray).
Check Status: Click on the agent icon. A window like the one shown will appear.
Verify:
Ensure the "Service Status" is "Running."
Check the "Last Sync" date and time to confirm the agent is synchronizing correctly with the server.
Script File
First, you need to have the installation script (.exe file); This will be provided by the support team as part of the installation process.
Step 1: Open Command Prompt
Press Win + R, enter cmd in the dialog box, and press "Enter" to open the Command Prompt.
Step 2: Navigate to the directory
Use the cd command to navigate to the directory containing the executable file. For example: cd path\to\directory
Step 3: Run the Executable File with Arguments
Enter the name of the executable file followed by the necessary arguments, then press "Enter."
For instance:
<path to installationScript.exe> msiPath="C:\Path\to\Your.msi" serverAddress="0.0.0.0" activationKey="" license="" password="" agentMode= machineType=
Each argument should be in the format key=value.
Step 4: Argument Conditions:
msiPath: Specify the full path to the MSI file. The file must exist.serverAddress: Specify the server address. It must be in either IPv4 or IPv6 format.activationKeyandlicense: Enter these values exactly as displayed in the license information. To access the license information, go to the 'Companies' section and click on 'View/Upgrade.' Retrieve the required information from this location.Note that both values may be empty strings but must be included in the arguments.
password: The password should consist of alphanumeric characters or "NONE" if installing the agent without a pa ssword. Prevent using special characters (e.g., !, @, #).agentMode: The setting must be either 1 for sensor mode or 2 for EDR mode.machineType: The setting must be either 1 for server or 2 for Endpoint.
Step 5: Execute the Script
The script will verify the arguments. Upon meeting all conditions, it executes the MSI command. If a condition is not fulfilled, it will indicate the cause of the failure.
Script Installations Notes:
Replace placeholder values (such as C:\Path\to\Your.msi) with the actual paths and values applicable to your configuration.
FAQ & Support
This guide helps MSSPs install the CYFOX Agent on customer devices.
Need an Account?
Yes, you'll need a CYFOX Cloud account to install the Agent.
How to Install?
Manual Installation (Single Device):
Download the Agent from CYFOX Cloud ("Downloads").
Choose your installation mode (EDR or Sensor).
Enter your license details.
Set a password (optional).
Follow on-screen instructions.
Script Installation (Multiple Devices):
Get the script file from CYFOX support.
Open Command Prompt and navigate to the script location.
Run the script with provided arguments (details from support).
Need More Help?
Refer to the script arguments explanation or contact CYFOX support for further assistance.
If you are having any installation issues, please don't hesitate to reach out to our support team either by phone at +1 646 666 0680 or by email at [email protected].