Skip to main content
This guide will walk you through installing Warnly, creating your first project, sending your first error event, and viewing issues in the user interface.

​
Prerequisites

  • Docker and Docker Compose (recommended for quick start)
  • Go 1.25+ (for building from source)
  • MySQL 8.0+ or compatible database
  • ClickHouse 24+ for analytics

​
Installation

  1. Clone the repository: 
    git clone https://github.com/vk-rv/warnly.git
cd warnly
  2. Copy the environment variables file: 
    cp .env.sample .env
  3. Start the services: 
    make dev
    Or directly with Docker Compose: 
    docker compose up
    This will start:
    • MySQL on port 3326
    • ClickHouse on ports 8133 (HTTP) and 9030 (native)
    • Warnly on port 8080

​
Configuration

Warnly uses environment variables for configuration. Key settings: 
# Databases
MYSQL_DSN=warnly:root@tcp(localhost:3306)/warnly?interpolateParams=true&parseTime=true&timeout=2s&loc=UTC
CLICKHOUSE_DSN=clickhouse://root:root@localhost:9000/warnly?dial_timeout=900ms&connection_open_strategy=in_order&compress=true&max_open_conns=55&max_idle_conns=50&conn_max_lifetime=5m&max_execution_time=10

# Server
SERVER_HOST=0.0.0.0
SERVER_PORT=8080
SCHEME=http

# Auto SQL migrations
FORCE_MIGRATE=true

# Admin
ADMIN_EMAIL=[email protected]
ADMIN_PASSWORD=admin

# Sessions
SESSION_KEY=your_32_byte_secret_key

​
Accessing the Interface

After starting, open your browser and navigate to http://localhost:8080. Log in with the admin credentials:

​
Creating Your First Project

  1. In the Warnly interface, click “New Project”
  2. Fill in the project details:
    • Name: My First Project
    • Description: Project description
  3. Click “Create”

​
Sending Your First Event

Warnly accepts error events via HTTP API. You can send events using Sentry envelope format for compatibility with Sentry clients.

​
Viewing Issues

  1. In the interface, navigate to the “Issues” section
  2. You’ll see grouped errors from the sent events
  3. Click on an issue to view details, including stack traces and metadata

​
Next Steps

Congratulations! You’ve successfully set up Warnly and sent your first error event.