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

1. Run the installation script

   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 a cloakprobe system user
   • Sets up the systemd service

2. Download the ASN database

   sudo /opt/cloakprobe/scripts/update_asn_db.sh

   This downloads the IP-to-ASN mapping database (~15MB) that enables network lookups.

3. Download the RIPE organization database (optional but recommended)

   sudo /opt/cloakprobe/scripts/update_ripe_db.sh

   This adds organization/company names to the output.

4. Start the service

   sudo systemctl start cloakprobe

5. Verify it’s running

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

Test It Out

Web UI

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

JSON API

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

Plain Text

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

Next Steps

• Configure environment variables
• Set up Cloudflare
• Configure Nginx reverse proxy

Keep Databases Updated

Set up a daily cron job to keep the ASN and RIPE databases current:

# Add to root's crontab: sudo crontab -e
0 3 * * * /opt/cloakprobe/scripts/update_asn_db.sh >> /var/log/cloakprobe-asn.log 2>&1
0 4 * * * /opt/cloakprobe/scripts/update_ripe_db.sh >> /var/log/cloakprobe-ripe.log 2>&1