Quick Start

Get CloakProbe up and running on your server in just a few minutes.

Prerequisites

Linux server (Ubuntu, Debian, Fedora, etc.)
Root or sudo access
curl installed

Installation

Run the installation script
Terminal window
```
curl -fsSL https://raw.githubusercontent.com/drmckay/cloakprobe/main/install.sh | sudo bash
```
This automatically:
- Detects your system architecture (x86_64 or aarch64)
- Downloads the latest release from GitHub
- Installs to /opt/cloakprobe
- Creates configuration at /etc/cloakprobe/cloakprobe.toml
- Creates a cloakprobe system user
- Sets up the systemd service
Download the ASN database
Terminal window
```
sudo /opt/cloakprobe/scripts/update_asn_db.sh
```
This downloads the IP-to-ASN mapping database (~15MB) that enables network lookups.
Download the multi-RIR organization database (optional but recommended)
Terminal window
```
sudo /opt/cloakprobe/scripts/update_org_db.sh
```
This adds organization details (name, ID, type, country, abuse contact) from all 5 Regional Internet Registries (RIPE, APNIC, LACNIC, AFRINIC, ARIN).

Configure CloakProbe (optional)

sudo nano /etc/cloakprobe/cloakprobe.toml

Key settings:

[server]
bind_address = "127.0.0.1"  # Listen on localhost only
port = 8080
mode = "cloudflare"         # or "nginx" for direct proxy

[privacy]
mode = "strict"

Start the service
Terminal window
```
sudo systemctl start cloakprobe
```

Verify it’s running

curl http://localhost:8080/healthz
# Should return: {"status":"ok"}

Test It Out

Open http://your-server:8080 in a browser to see the HTML interface.

curl http://localhost:8080/api/v1/json | jq

curl http://localhost:8080/api/v1/plain

Service Management

# Check status
sudo systemctl status cloakprobe

# View logs
sudo journalctl -u cloakprobe -f

# Restart service
sudo systemctl restart cloakprobe

# Stop service
sudo systemctl stop cloakprobe

Configuration File

CloakProbe uses a TOML configuration file at /etc/cloakprobe/cloakprobe.toml:

[server]
bind_address = "127.0.0.1"
port = 8080
mode = "cloudflare"    # "cloudflare" or "nginx"
region = "eu-central"  # optional

[privacy]
mode = "strict"        # "strict" or "balanced"

[database]
asn_db_path = "/opt/cloakprobe/data/asn_db.bin"
org_db_path = "/opt/cloakprobe/data/orgs_db.bin"

Next Steps

Set up cron jobs to keep the databases current:

# Add to root's crontab: sudo crontab -e
# Update ASN database daily at 3:00 AM
0 3 * * * /opt/cloakprobe/scripts/update_asn_db.sh >> /var/log/cloakprobe-asn.log 2>&1
# Update multi-RIR org database weekly on Sunday at 4:00 AM
0 4 * * 0 /opt/cloakprobe/scripts/update_org_db.sh >> /var/log/cloakprobe-org.log 2>&1