Quick Start

Quick Start

Get SilentPulse up and running locally in minutes using Docker Compose.

Prerequisites

• Docker 20.10+
• Docker Compose 2.0+
• 4GB RAM available

1. Clone the Deploy Repository

git clone https://github.com/silentpulse-io/deploy.git
cd deploy

2. Configure

cp deploy/docker-compose/.env.example deploy/docker-compose/.env

Edit .env to set at minimum:

• JWT_SECRET - generate with openssl rand -hex 32
• POSTGRES_PASSWORD - change from default

3. Start the Stack

docker compose -f deploy/docker-compose/docker-compose.yml up -d

This starts:

• PostgreSQL with Apache AGE (graph database)
• Redis (observation cache)
• API Server (REST API)
• CMDB Sync (asset synchronization)
• Health (health monitoring)
• Notifications (alert dispatcher)
• Reporting (report generation)
• Frontend (React dashboard)

4. Access the Dashboard

Open http://localhost:3000 in your browser.

Default credentials:

• Email: [email protected]
• Password: admin123

WARNING: Change the default admin password immediately after first login.

5. Create Your First Pulse

1. Click Pulses → New Pulse in the sidebar
2. Name it (e.g., “Production Splunk”)
3. Select connector type (Splunk, Kafka, Elasticsearch, etc.)
4. Enter connection details (URL, credentials)
5. Choose Discovery Mode — the system will auto-learn which assets report
6. Click Create Pulse

That’s it. The system starts learning your baseline. After the learning phase (default 24h), monitoring activates automatically and you’ll be alerted when any asset goes silent.

Even faster with the API

curl -X POST http://localhost:8080/api/v1/pulses \
  -H "Content-Type: application/json" \
  -d '{"name":"My Splunk","connector_type":"splunk",
       "connection_config":{"base_url":"https://splunk:8089","token":"..."},
       "discovery_mode":true,"learning_duration":"24h"}'

Optional: Enable MCP Server

docker compose -f deploy/docker-compose/docker-compose.yml --profile mcp up -d

The MCP server will be available at http://localhost:8090.

Next Steps

• Installation Guide - Production deployment with Helm
• Architecture - Understand how SilentPulse works
• Integrations - Connect to your security stack