Skip to content

Getting Started Overview

This guide walks you through deploying and running LogSys locally or in production.

Prerequisites

Requirement Version Purpose
Docker Engine 24+ Container runtime
Docker Compose v2+ Orchestration
Git 2.x Source control
RAM 8 GB minimum All services (~4 GB used)
Disk 20 GB Logs, PostgreSQL, Kafka data
Target URL (Local)
Frontend Dashboard http://localhost:5173
API Documentation (Swagger) http://localhost:8000/docs
API Health Check http://localhost:8000/health
Kafka Broker localhost:9092
PostgreSQL localhost:5432
Redis localhost:6379
Vector HTTP localhost:8686 / 8687
Collectors Webhook localhost:8080
ML Service http://localhost:8001

Default Credentials

Role Email Password
Admin admin@alertops.com Admin@2026!

⚠️ Change these immediately in production. The admin user is auto-created on first startup if the users table is empty.

Architecture at a Glance

%%{init: {'theme':'default','themeVariables':{'primaryColor':'#1a73e8'}}}%%
flowchart LR
  subgraph DEV["Development"]
    DC[docker compose up -d]
    LOGS[docker compose logs -f]
  end

  subgraph PROD["Production"]
    DC2[docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d]
    PROXY[Nginx/Caddy TLS Termination]
    VAULT[Secrets Manager]
  end

  DEV -->|Iterate| PROD

Next Steps

Step Guide Time
1 Quick Start 5 min
2 Installation 10 min
3 Configuration 15 min
4 Verification 5 min

Offline Deployment

LogSys can run without internet access if all images are pre-pulled:

# On a machine WITH internet
docker pull apache/kafka:3.7.0
docker pull postgres:16-alpine
docker pull redis:7-alpine
docker pull timberio/vector:0.45.X-debian
docker save apache/kafka:3.7.0 postgres:16-alpine redis:7-alpine timberio/vector:0.45.X-debian -o logsys-images.tar

# Transfer logsys-images.tar to offline machine
docker load -i logsys-images.tar
docker compose up -d