This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Getting Started

Quick guide to install and start using HeartSuite Core Secure.

HeartSuite Core Secure uses a 7-phase guided model to take your system from initial observation to full enforcement. The Dashboard tracks your progress and suggests each next step.

Overview: This guide covers both the Cloud Path and the Local Path for getting HeartSuite Core Secure running, verified, and ready for allowlisting.

The 7-Phase Model

HeartSuite Core Secure guides you through seven phases:

  1. System Verification — confirm HeartSuite Core Secure is active and in Setup Mode
  2. Program Allowlisting — approve the programs your system needs
  3. Script Launchers (if applicable) — configure Secure Script Launchers for interpreted scripts
  4. File Access Allowlisting — approve file read and write access
  5. Internet Access Allowlisting — approve internet destinations
  6. Alert Configuration — set up at least one notification channel
  7. Secure Mode — locked until phases 2-6 are complete

The Dashboard displays your current phase, pending event counts, and a Suggested Next Step at all times.

Cloud Path Quick Start

Users launching a pre-installed HeartSuite Core Secure cloud instance (AWS AMI, GCP image) boot directly into Setup Mode.

  1. Launch your cloud instance and log in.

  2. The Dashboard appears automatically on first login with a welcome message:

    HeartSuite Core Secure is active.
    Current mode: Setup Mode — events are logged, nothing is blocked.
    Suggested: Review 1 pending program event → [p] Programs
    
  3. Phase 1 (System Verification) completes automatically — no manual steps required.

  4. Follow the Suggested Next Step on the Dashboard to begin Phase 2: Program Allowlisting.

Local Path Quick Start

Users installing HeartSuite Core Secure on bare-metal or custom VMs follow a longer installation sequence before reaching the Dashboard.

Download and Install

  1. Download the tar file from heartsecsuite.com.

  2. Extract and run the installer (as root):

    tar xvf 6.18-HeartSuite-1.6.4.tar -m
    sudo bash heartsuite-install-bundle.sh
    
  3. Reboot, then select the HeartSuite Core Secure kernel from the GRUB menu:

    reboot
    

    At GRUB: Advanced options for Debian GNU/LinuxLinux 5.19.6-HeartSuite-1.0

    If the GRUB menu does not show the HeartSuite Core Secure kernel, run update-grub and reboot again. See Installation for details.

OS Boot Setup

  1. After booting into the HeartSuite Core Secure kernel, the management UI appears on the console automatically. The System Setup screen opens.

    Press [a] to run the setup step. The UI reboots the system when the step completes — select the HeartSuite Core Secure kernel from GRUB each time and repeat until the setup screen shows Setup Complete (usually 3–5 cycles). This builds the initial allowlist for startup programs, preventing boot issues when Secure Mode is activated later.

Verify and Proceed

  1. Once the Installation screen confirms completion, the Dashboard shows your current phase. From here, the Cloud Path and Local Path merge — follow the Suggested Next Step to begin allowlisting.

The Dashboard

The Dashboard is your orientation point throughout the entire HeartSuite Core Secure journey. It displays:

  • Safety Banner — current protection state (Setup Mode, Secure Mode, or Non-HS kernel)
  • Phase Progress — which of the 7 phases are complete, in progress, or not started
  • Pending/Denied counts — events grouped by category (Programs, File reads, File writes, Network)
  • Suggested Next Step — one clear, actionable recommendation
  • System Info Strip — kernel type, current mode, time in mode, lockdown status

The Suggested Next Step is always the recommended action. Follow it to proceed through each phase.

The Review Queues

The Dashboard organizes allowlisting into three review queues, each presented as a screen within the Dashboard:

  • Programs queue ([p]) — review pending program execution events (Phase 2)
  • File Access queue ([f]) — review pending file read and write events (Phase 4)
  • Internet Access queue ([i]) — review pending network connection events (Phase 5)

The Suggested Next Step directs you to the queue that needs attention. Select it to navigate directly to the review screen. For browsing or editing existing allowlist entries, use the Allowlist screen ([a]).

Switching to Secure Mode

When phases 2-6 are complete, the Dashboard unlocks Phase 7 and shows Secure Mode activation as the Suggested Next Step. Activation requires typing YES (case-sensitive) to confirm. After confirmation, the Dashboard offers two reboot options:

  • [r] Reboot — enforcement active, configuration remains editable
  • [l] Reboot + Lockdown — enforcement active, configuration sealed with filesystem immutability

Both are valid configurations depending on your threat model. If the system does not boot correctly, reboot into the Non-HS kernel — the Dashboard resumes there and guides you through recovery.

Next Steps

1 - Before You Begin

System requirements and prerequisites for installing HeartSuite Core Secure.

Overview: Review system requirements and prerequisites before installing HeartSuite Core Secure, whether using a Cloud Path or Local Path.

System Requirements

  • Operating System: Debian 11, 12, or 13; Ubuntu-derived; Alpine Linux; or RPM-based (RHEL, Fedora, CentOS, Rocky Linux, AlmaLinux, SUSE) — on x86 architecture.
  • Access Level: Root access (sudo privileges).
  • Skills: Basic familiarity with the Linux command line.

If your setup differs, check the Introduction for compatibility details.

Cloud Path vs Local Path

  • Cloud Path: Launch a pre-installed HeartSuite Core Secure cloud instance (AWS AMI, GCP image). No download or kernel installation required — you boot directly into Setup Mode and the Dashboard appears on first login.
  • Local Path: Download the installation package from heartsecsuite.com, extract, install the HeartSuite Core Secure kernel, and complete the Installation screen setup through multiple reboot cycles before reaching the Dashboard.

Both paths merge at the Dashboard after Phase 1 (System Verification) is complete.