Getting Started

Installation

CoreDetection ships as a self-contained package with an installer that registers a systemd service. The whole process takes a few minutes.

1. Extract the package

Copy the package you received to the target server and extract it:

tar -xzf coredetection-<version>.tar.gz
cd coredetection-<version>

2. Run the installer

The installer copies files to /opt/coredetection, registers the coredetection systemd service, and starts it:

sudo ./install.sh
If you are deploying the bundled flow-collection stack on a fresh server, run the stack installer first (it provisions Docker containers for the collector and database). Your package includes step-by-step instructions for this.

3. Manage the service

ActionCommand
Statussystemctl status coredetection
Live logsjournalctl -u coredetection -f
Restartsystemctl restart coredetection
Stopsystemctl stop coredetection

4. License Activation

CoreDetection requires a per-server license. Activation is a one-time exchange:

Step 1 — Get your server ID

# replace YOUR_KEY with the api_key from config.ini
curl -H "X-API-Key: YOUR_KEY" \
  http://localhost:9009/CoreDetection/api/v0/license/server-id

The response contains a unique server_id (UUID).

Step 2 — Request your license

Send the server_id to CoreTech ([email protected]). You will receive a license.lic file in return.

Step 3 — Install the license

Place license.lic next to the binary and reload it without restarting:

cp license.lic /opt/coredetection/license.lic

curl -X POST -H "X-API-Key: YOUR_KEY" \
  http://localhost:9009/CoreDetection/api/v0/license/reload

Step 4 — Verify

curl -H "X-API-Key: YOUR_KEY" \
  http://localhost:9009/CoreDetection/api/v0/license/status
The license is verified locally — there is no call-home. It is bound to this server's ID and enforces an anti-rollback clock check, so keep the system clock accurate via NTP.

5. Updating

To update to a newer build, re-run the installer from the new package. Your existing config.ini is automatically backed up before being replaced, and the service is restarted for you.

Next steps