Skip to content

Installation

Installation

Prerequisites

  • Docker Engine (20.10.x or newer)
  • Docker Compose (2.x or newer)
  • Minimum 32GB RAM
  • 8+ CPU cores
  • 100GB available storage (SSD recommended)
  • Valid SSL certificates
  • Network access to required services
  • A locally running LLM with at-least 70B parameters

Installation Steps

  1. Extract the provided zip file:

  2. Run the installer script:

Basic Installation (with auto-generated self-signed certificate): 

./llminspect-cli -p /full/path/to/llminspect -o install
The installer will prompt you for an FQDN and automatically create a self-signed certificate.

Installation with Custom SSL/TLS Certificates: 

./llminspect-cli -p /full/path/to/llminspect -o install \
    --cert-file /path/to/certificate.crt \
    --cert-key /path/to/private.key \
    --domain your-domain.com

⚠️ Self-signed certificates (generated in basic installation) are suitable for testing but not recommended for production use. For production, please obtain certificates from a trusted Certificate Authority (CA).

Important Notes:

  • The installer script is designed for Linux systems only
  • The installer should only be used for initial installation
  • After installation, use standard Docker Compose commands for daily operations
  • The -p flag must point to the full path where you extracted the files

SSL/TLS Configuration:

  • The following flags must be used together for proper SSL/TLS setup:

  • --cert-file: Full path to your SSL certificate file

  • --cert-key: Full path to your SSL private key file

  • --domain: Domain name that matches the CN in your certificate

  • If any of these three SSL parameters are provided, all three must be provided

  • If none are provided, the installation will proceed with basic SSL/TLS configuration

Environment Configuration:

  • By default, the installer will prompt you for various configuration values during installation

  • To bypass interactive configuration, you can use the --env-file parameter:

./llminspect-cli -p /full/path/to/llminspect --cert-file /path/to/cert.pem --cert-key /path/to/key.pem --domain example.com -o install --env-file /path/to/env.file
- The env file should contain all required environment variables in KEY=VALUE format

  • Using an env file is recommended for automated deployments or when you want to maintain consistent configurations

For stopping the services:

./llminspect-cli -p /full/path/to/llminspect -o stop

⚠️ IMPORTANT: If Installation Fails ⚠️

If the installer encounters an error and fails to complete, you MUST run the clean operation before attempting to install again:

./llminspect-cli -p /full/path/to/llminspect -o clean

This will revert all changes made by the failed installation attempt and allow you to start fresh.

Parameter Summary:

  • -p, --project: (Required) Full path to the extracted llminspect directory

  • -o, --operation: (Required) One of:

  • 'install': Performs initial installation

  • 'stop': Stops running services

  • 'clean': Reverts all file changes made by the installer, restoring the installation directory to its original state. Useful for:

    • Starting fresh after a failed installation

    • Recovering from installer-generated configuration errors

    • Resetting the environment before attempting a new installation

    • Cleaning up partial changes if installation was interrupted

  • --env-file: (Optional) Path to environment file for automated configuration

  • SSL/TLS group (all three required if using SSL):

  • --domain: Domain name matching certificate CN

  • --cert-file: Path to SSL certificate

  • --cert-key: Path to SSL private key

  • --license: (Optional) To see the license of open-source services used in llminspect