Configuration

CloakProbe is configured entirely through environment variables. No config files needed.

Environment Variables

Variable	Default	Description
PORT	8080	Port to bind the HTTP server
CLOAKPROBE_PRIVACY_MODE	strict	Privacy mode (strict or balanced)
CLOAKPROBE_ASN_DB_PATH	data/asn_db.bin	Path to ASN database
CLOAKPROBE_RIPE_DB_PATH	data/ripe_db.bin	Path to RIPE organization database
CLOAKPROBE_REGION	(none)	Optional region identifier shown in API

Backward Compatibility

For backward compatibility with cfdebug, the CFDEBUG_* prefix also works for all variables.

Privacy Modes

Strict Mode (Default)

CLOAKPROBE_PRIVACY_MODE=strict

• No logging of IP addresses
• Minimal server information exposed
• logs_retained: false in API response

Balanced Mode

CLOAKPROBE_PRIVACY_MODE=balanced

• Standard logging enabled
• Full server information
• logs_retained: true in API response

Systemd Configuration

Edit the service file to customize:

sudo nano /etc/systemd/system/cloakprobe.service

Example configuration:

[Unit]
Description=CloakProbe IP Information Service
After=network.target

[Service]
Type=simple
User=cloakprobe
Group=cloakprobe
WorkingDirectory=/opt/cloakprobe

# Environment variables
Environment=PORT=8080
Environment=CLOAKPROBE_PRIVACY_MODE=strict
Environment=CLOAKPROBE_ASN_DB_PATH=/opt/cloakprobe/data/asn_db.bin
Environment=CLOAKPROBE_RIPE_DB_PATH=/opt/cloakprobe/data/ripe_db.bin
Environment=CLOAKPROBE_REGION=eu-central

ExecStart=/opt/cloakprobe/cloakprobe

Restart=always
RestartSec=5

# Security hardening
NoNewPrivileges=true
ProtectSystem=strict
ProtectHome=true
PrivateTmp=true
ReadOnlyPaths=/opt/cloakprobe

[Install]
WantedBy=multi-user.target

After editing, reload and restart:

sudo systemctl daemon-reload
sudo systemctl restart cloakprobe

Running Manually

For testing or development:

Basic

./cloakprobe

Custom Config

PORT=3000 \
CLOAKPROBE_PRIVACY_MODE=strict \
CLOAKPROBE_ASN_DB_PATH=./data/asn_db.bin \
CLOAKPROBE_RIPE_DB_PATH=./data/ripe_db.bin \
CLOAKPROBE_REGION=us-east \
./cloakprobe

Docker

docker run -d \
  -p 8080:8080 \
  -e CLOAKPROBE_PRIVACY_MODE=strict \
  -v ./data:/opt/cloakprobe/data:ro \
  cloakprobe:latest

Database Paths

The database path variables support:

• Absolute paths: /opt/cloakprobe/data/asn_db.bin
• Relative paths: ./data/asn_db.bin (relative to working directory)

Working Directory

When running via systemd, the working directory is set by WorkingDirectory=. Relative paths are resolved from there.

Region Identifier

The optional CLOAKPROBE_REGION variable appears in API responses:

{
  "server": {
    "timestamp_utc": "2024-01-15T10:30:00Z",
    "region": "eu-central",
    "version": "0.1.0"
  }
}

Useful for multi-region deployments to identify which instance served the request.

Memory Usage

CloakProbe loads databases into memory for fast lookups:

Database	Approximate Size
ASN database	~50-100 MB
RIPE database	~20-40 MB

Ensure your server has sufficient RAM for the databases plus application overhead.