> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onefirewall.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Sensor Configuration

> How to configure your WCF Agent (Sensor)

## Overview

The WCF Sensor Configuration is a pre-defined JSON file that determines how your installed setup instructs your firewall, router, or IPS device to behave. OneFirewall supports two setup types:

* **API-Based**
* **Agent-Based**

## API-Based Setup

The simplest installation method. Covers systems such as Fortigate, Checkpoint, pfSense, and others.

Select your device from the menu and enable it. The system guides you through the remaining steps during installation.

## Agent-Based Setup

Applies to systems such as Checkpoint SecureXL, Sophos, Trellix, and others. To connect these with OneFirewall for real-time protection, install the **WCF Agent** — the bridge between your device and the OneFirewall platform.

When you select a device that requires an agent, the system generates a pre-compiled JSON configuration. Review and edit this JSON before completing the integration with your device.

### Step 1: Activation

1. Log in to your OneFirewall Server instance, open the main menu on the right, and click **Install Agent**.
2. Select the device you want to activate.
3. Define the following parameters:
   * **IoC Type** — Choose between *IP*, *URL*, *Domain*, or *File*.
   * **Cyber Crime Threshold** — Set the sensitivity level at which the device starts blocking threats.
   * **Sync Interval** — Define how often the agent updates its IoC data.

<img src="https://mintcdn.com/onefirewall/WDi-dI7jVFz2iVVH/images/agent-install-config.webp?fit=max&auto=format&n=WDi-dI7jVFz2iVVH&q=85&s=719abc5827b6dfb4a9e61f987aa54794" alt="" width="976" height="1170" data-path="images/agent-install-config.webp" />

If the selected device requires an Agent-Based setup, you are presented with the following form:

<img src="https://mintcdn.com/onefirewall/WDi-dI7jVFz2iVVH/images/agent-instruction.webp?fit=max&auto=format&n=WDi-dI7jVFz2iVVH&q=85&s=17c74f51fd8c4c049d059beefec9bb95" alt="" width="962" height="860" data-path="images/agent-instruction.webp" />

### Step 2: Download Configuration

1. Prepare a virtual machine with Docker and Docker Compose installed.
2. Download the `docker-compose.yml` file from the previous step and place it on the new machine. This file contains the parameters (including your certificate) the agent needs to connect securely to your OneFirewall Server.
3. Start the agent:

```bash theme={null}
docker-compose up -d
```

### Step 3: Setup Access

1. Navigate to the **Agent Status** page from the menu to see the list of installed agents.
2. Click **View & Edit** on the newly installed agent to open its JSON configuration form.
3. Scroll to the `ips` section of the JSON and set your own parameters. See the examples below.

## Notes

Below are JSON configuration examples for each supported device.

### Sophos

```json theme={null}
   "ips": {
        "sophos": {
            "active": true,
            "user": "<your device username>",
            "password": "<your device password>",
            "address": "<the address or hostname of your sophos>",
            "command": "bash artifacts/sophos/update_blacklist_sophos.sh"
        }
   }
```

### Checkpoint SecureXL

```json theme={null}
   "ips": {
        "checkpoint_securexl": {
            "active": true,
            "connections": "<your device user>@<the address or hostname of your checkpoint>",
            "password": "<your device password>",
            "command": "bash artifacts/checkpoint/install-securexl.sh",
            "vsids": "<VSID separated by comma>"
        },
   }
```