Skip to content
Suricatavel Logo Suricatavel Logo Suricatavel

Quick start

This guide shows the fastest way to install Suricatavel using the interactive terminal installer.

For a manual installation with step-by-step control over each component, see the Installation Guide.

Prerequisites

Section titled “Prerequisites”

Automated installation

Section titled “Automated installation”

  1. Download the release package

    Terminal window
    wget https://suricatavel.org/releases/suricatavel-latest.zip

    Verify archive integrity:

    Terminal window
    wget https://suricatavel.org/releases/suricatavel-latest.zip.sha256
    read hash _ < suricatavel-latest.zip.sha256 && echo "$hash  suricatavel-latest.zip" | sha256sum -c -

    Extract the archive:

    Terminal window
    unzip suricatavel-latest.zip
    cd suricatavel

  2. Launch the interactive TUI installer

    The installer includes a guided terminal wizard that validates dependencies, configures PostgreSQL / TimescaleDB, and sets up Nginx and SSL:

    Terminal window
    # Grant execution permissions
    chmod +x support/scripts/suricatavel_install.sh
    

    # Launch the installer wizard
    sudo ./support/scripts/suricatavel_install.sh --full

    The wizard will guide you through:

    • System check: Verifies OS compatibility, memory, and CPU limits.
    • Component versions: Selects compatible versions for PHP, TimescaleDB, and Suricata.
    • Database setup: Configures PostgreSQL credentials and optimizes TimescaleDB parameters.
    • Server names & SSL: Configures your web domains and points to your TLS certificates or generates local ones.
    • Execution & summary: Provisions all services with animated progress spinners and displays initial credentials.

  3. Initialize the application

    Once the installer finishes, run the boot command to initialize database schemas and generate the administrator account:

    Terminal window
    suricatavel boot

  4. Verify the installation

    Terminal window
    # Check service status and worker health
    suricatavel status
    

    # Verify application version
    suricatavel version

Access the web interface

Section titled “Access the web interface”

Open your web browser and navigate to the configured domain or server IP address:

https://your-suricatavel-server/

Log in with the administrator credentials configured during suricatavel boot.