What you get
One product for everyone: the free edition has every core feature with limits on users, notes and entities. A licence removes the limits, adds the Data API, and lets you add three premium modules.
Notebook & capture
Highlights from any web page via the browser extension, with source, tags and links to actors and entities.
Entities & graph
IOCs, assets, identities and custom entities linked to threat actors, malware and techniques.
MITRE ATT&CK
Enterprise, Mobile and ICS matrices, technique library, overlays to compare actors and software.
Threat actors & software
180+ groups and 900+ tools and malware with curated origin, motivation and targeting.
Shared collections
Private and organization-wide collections; public notes are shared with everyone on the installation.
Exports & Data API
JSON, Markdown, PDF and STIX exports in every edition. Licensed editions add authenticated Data APIs that feed your SIEM or TIP.
Premium modules
Active Directory / LDAP
Directory accounts sign in directly; groups decide who may sign in and who is an admin. Accounts can be created automatically at the first sign-in.
Audit log
Sign-ins, failed attempts, user and settings changes, licence changes, API keys and exports. Searchable, exportable as CSV.
Custom branding
Your logo, product name, colour and a sign-in message, so it looks like your own internal tool.
Editions & pricing
Start with the free edition. When you need more users, the Data API or more room for notes and entities, a licence removes every limit: move the slider and pick modules for an estimate.
| Feature | Free$0 | Trial30 days | LicensedFrom $1,500/yr |
|---|---|---|---|
| Users | Up to 5 | Up to 25 | As licensed |
| Captured notes | 500 per installation | Unlimited | Unlimited |
| Entities | 100 per installation | Unlimited | Unlimited |
| Notebook, collections, ATT&CK, actors, exports | ✓Included | ✓Included | ✓Included |
| Browser extension | ✓Included | ✓Included | ✓Included |
| Data API | —Not included | ✓Included | ✓Included |
| Premium modules (AD, audit log, branding) | —Not included | All | As licensed |
| Support | Community | Included; 24/7 option | |
| Licence key | Not needed | Not needed (automatic) | Yes |
Active accounts. Disabled accounts do not count.
| Users | Per user / year | Per user / month |
|---|---|---|
| 1 – 25 | $180 | $15.00 |
| 26 – 100 | $150 | $12.50 |
| 101 – 250 | $120 | $10.00 |
| 251 and more | $96 | $8.00 |
Graduated like tax brackets: users 1–25 at the first price, 26–100 at the second, and so on. Minimum order $1,500 per year.
Download
One package with everything: the installer, the application images and the browser extension. It starts as a 30-day trial with every module, then runs as the free edition until you install a licence key. No registration, no image registry, and no internet access needed on the server.
Check a download with sha256sum -c SHA256SUMS --ignore-missing (Linux) or Get-FileHash (Windows). By downloading you accept the licence terms.
Requirements
One server is enough. Everything runs in Docker, so there is nothing else to install.
- Server
- One Linux server (Ubuntu, Debian, RHEL, Rocky…) or Windows / macOS with Docker Desktop. A virtual machine is fine.
- CPU & memory
- 2 CPU cores and 4 GB RAM; 4 cores and 8 GB for 100+ users.
- Disk
- 20 GB to start; grows with your notes and entities.
- Software
- Docker Engine 24 or newer with Docker Compose v2. Nothing else: databases and web server run in containers.
- Network
- Ports 80 and 443 (configurable) reachable by your users. No internet access needed: the package contains everything.
- Optional
- A DNS name and TLS certificate (or let the server create one), and an Active Directory service account.
Install
About 10 minutes. The installer generates every password and secret, starts the application, and on the first start sets up the databases and loads MITRE ATT&CK.
- 1
Install Docker
Skip this if Docker is already installed. Log out and in again afterwards so your user may run Docker.
curl -fsSL https://get.docker.com | sh sudo usermod -aG docker $USER - 2
Download and unpack the package
It contains the installer, every application image and the browser extension. If you have bought a licence, copy the licence file into the license folder (optional: you can also paste the key in the app later).
curl -LO https://downloads.hellocyberlab.io/on-prem/26.11.2/hclab-onprem-26.11.2.tar.gz tar -xzf hclab-onprem-26.11.2.tar.gz cd hclab-onprem-26.11.2 cp ~/acme.lic license/license.lic # optional - 3
Run the installer
It asks for the host name, how to do HTTPS and the first admin password, checks and loads the images from the package, starts everything and waits until it is ready.
./install.sh # or without questions: ./install.sh --yes --host intel.corp.local --tls internal
admin with the password from .env (or the one you typed), and choose a new password. Then remove ADMIN_PASSWORD from .env. Configure
Everything below is done by an administrator in the app, under Administration, except HTTPS, which is set in .env.
HTTPS
Choose one in .env and run docker compose up -d. With "tls internal" the server creates its own certificate authority; give your users its root certificate, or use your own certificate.
| Plain HTTP (testing, or behind your proxy) | SITE_ADDRESS=:80 TLS_DIRECTIVE= |
| Self-signed by the server | SITE_ADDRESS=intel.corp.local TLS_DIRECTIVE=tls internal |
| Your certificate (files in ./certs) | TLS_DIRECTIVE=tls /certs/fullchain.pem /certs/privkey.pem |
Users and roles
Administration > Users: add users with a username (no email or invitation needed), choose Admin or Analyst, and hand over the generated password; they change it at their first sign-in. Disable users to free a licensed seat while keeping their work. Accounts lock for 15 minutes after 5 failed sign-ins.
Active Directory
Administration > Active Directory: enter the settings, use "Test the connection" with a real account, then switch it on. Users sign in with jdoe or CORP\jdoe. Local accounts keep working, so a directory outage never locks admins out.
| Server URL | ldaps://dc01.corp.local:636 |
| Service account | CN=svc-intellab,OU=Service Accounts,DC=corp,DC=local |
| Search base | DC=corp,DC=local |
| User filter | (&(objectClass=user)(objectCategory=person)(sAMAccountName={{username}})) |
| Allowed group (optional) | CN=IntelLab Users,OU=Groups,DC=corp,DC=local |
| Admin group (optional) | CN=IntelLab Admins,OU=Groups,DC=corp,DC=local |
Licence
Administration > Licence shows the edition, users in use, modules and expiry, and in the free edition how many of the 500 notes and 100 entities are used. Paste a key there to license or renew; nothing needs reinstalling. "Download usage report" creates the small file to send with your renewal: your organisation name, licence and installation ID, user counts and modules in use, with no user names, emails or content.
Branding and audit log
Administration > Branding sets your logo, name, colour and sign-in message. Administration > Audit log lists every sign-in and change; filter it and export CSV for your SIEM or auditors. Entries are kept for 365 days (AUDIT_RETENTION_DAYS).
Browser extension
The package contains hclab-extension-<version>.zip. Unzip it, then load the folder in a Chromium-based browser: open chrome://extensions (or edge://extensions), switch on Developer mode and choose "Load unpacked". In its popup, enter your server address, e.g. https://intel.corp.local, and an API key created in the app under API Keys.
Run it
Day-to-day operation is a handful of commands, run in the installation folder.
Status and logs
See whether everything is running, and follow the server log.
docker compose ps
docker compose logs -f backendBackup and restore
Backs up both databases while the app runs. Keep .env with the backups, and copy them off the server. On Windows, run it from Git Bash (part of Git for Windows).
./backup.sh
./backup.sh --restore backups/20270115-020000Upgrade
Unpack the new package next to the current one and run its installer with --from: it takes over your settings, backs up, loads the new images and restarts. Database changes apply automatically. On Windows the automatic backup needs Git for Windows; without it, run a backup yourself first.
tar -xzf hclab-onprem-1.1.0.tar.gz && cd hclab-onprem-1.1.0
./install.sh --from ../hclab-onprem-1.0.0
# Windows: .\install.ps1 -From ..\hclab-onprem-1.0.0Support
Collects versions, status and logs with passwords and secrets removed. Attach it to your support request.
./support-bundle.sh # Windows: .\support-bundle.ps1Locked out
Resets the first admin's password from the server and prints a new one.
docker compose exec backend npm run admin:reset-passwordStop and start
Your data stays in Docker volumes when the containers stop.
docker compose down
docker compose up -dLicensing questions
What does the free edition include?
Every core feature for up to 5 users: notebook, collections, entities, MITRE ATT&CK, threat actors and software, exports and the browser extension, with up to 500 captured notes and 100 entities for the whole installation. The Data API and the premium modules need a licence. It is free to use without time limit.
What happens when we reach a free limit?
Nothing is deleted and everything stays readable and exportable. You just cannot capture more notes or add more entities until you delete some or install a licence, which removes all limits at once.
What counts as a user?
Every active account, local or from Active Directory. Disabled accounts do not count, so you can disable people who left and keep their notes. Directory users count from their first sign-in.
What happens if we go over the licensed users?
Nobody is locked out. Administrators simply cannot add or re-enable users until someone is disabled or the licence is extended.
Does the software contact your servers?
No. The licence key is checked on the server itself, with a cryptographic signature. There is no phone-home and no telemetry, so it works fully air-gapped.
How does the trial work?
It starts automatically on the first start: 30 days with every module, the Data API, no limits on notes or entities, and up to 25 users. Afterwards the installation continues as the free edition unless you install a licence key. Nothing you created is lost.
What happens when the licence expires?
Administrators are warned 30 days before. After the expiry date it keeps working normally for 14 days, then continues as the free edition. Your data is never deleted, and installing a new key restores everything immediately.
Can we run a test installation too?
Yes. A licence covers one production installation and one non-production installation for testing upgrades.
How do renewals work?
About 90 days before the end of the term we ask for the usage report from Administration > Licence. It holds your organisation name, the licence, user counts and modules in use, without user names, emails or content. We send the renewal key, which you paste into the same page.
Is there a perpetual licence?
Yes, on request: 2.5 times the annual price once, then 20% a year for updates and support.
Start free today
Download the package and install it in about 10 minutes. Every module is on for the first 30 days; after that the free edition keeps running until you add a licence.
Prefer not to run servers? The cloud plans start free.