FLUX NOTIFY

// OVERVIEW

Flux Notify is the notification engine at the heart of the Flux Suite. It organizes alerts around incident threads — allowing your team to send initial notifications, updates, and resolutions while maintaining a complete audit trail.

Every message sent through Flux Notify is logged with a cryptographic hash chain, ensuring tamper-evident records for compliance and post-incident review.

// QUICK START

1. Clone & configure — Copy .env.example to .env and set your SMTP, AWS, and Slack credentials.
2. Launch containers — Run docker-compose up -d to start all five containers (web, db, worker, websocket, adminer).
3. Access the interface — Navigate to http://localhost:8080 and log in with the default admin credentials.
4. Configure channels — Go to Settings → Channels and verify each delivery method (SMTP test, AWS SNS test, Slack webhook test).
5. Create a contact list — Add contacts under Contact Lists, assigning delivery preferences per person.
6. Send your first incident — Click "New Incident", select message type "Initial", pick a contact list, and click Send.

# Linux / Mac
docker-compose up -d

# Windows (PowerShell)
docker-compose.exe up -d

# Check status
docker-compose ps
docker-compose logs -f worker

// REQUIREMENTS

// INCIDENT MANAGEMENT

MESSAGE TYPES

INCIDENT LIFECYCLE

An incident progresses through states: Open → Monitoring → Resolved. The system tracks time-in-state and can trigger escalations if an incident remains Open without acknowledgment past a configured threshold.

// DELIVERY CHANNELS

DELIVERY QUEUE

All messages are queued in MariaDB and processed by the background worker container. This ensures delivery even under high load and allows automatic retry on failure. Failed deliveries are retried up to 3 times with exponential backoff.

// ROLE-BASED ACCESS

// AUDIT LOGGING

Every action in Flux Notify — incident creation, message send, user login, setting change — is recorded in the audit log with a cryptographic hash chain. Each entry contains:

• Timestamp (UTC, microsecond precision)
• User ID and IP address
• Action type and resource affected
• SHA-256 hash linking to previous log entry
• Full before/after JSON for setting changes

// AWS SNS CONFIGURATION

# .env configuration
AWS_ACCESS_KEY_ID=your_access_key
AWS_SECRET_ACCESS_KEY=your_secret_key
AWS_REGION=us-east-1
AWS_SNS_SENDER_ID=FluxNOC    # Optional, for supported regions

IAM PERMISSIONS REQUIRED

{
  "Version": "2012-10-17",
  "Statement": [{
    "Effect": "Allow",
    "Action": ["sns:Publish"],
    "Resource": "*"
  }]
}

// DOCKER DEPLOYMENT

CONTAINER ARCHITECTURE

MANAGEMENT COMMANDS

# Start all services
docker-compose up -d

# View container status
docker-compose ps

# View worker logs (queue processing)
docker-compose logs -f flux-worker

# Restart a specific container
docker-compose restart flux-web

# Stop all services
docker-compose down

# Stop and remove all data (DESTRUCTIVE)
docker-compose down -v

// BACKUP & RESTORE

# Create a backup
./scripts/backup.sh
# Creates: ./backups/flux-notify-backup-YYYYMMDD_HHMMSS.tar.gz

# Restore from backup
./scripts/restore.sh flux-notify-backup-20260224_143700

# Manual database dump
docker exec flux-db mysqldump -u flux_user -p flux_notify > backup.sql

# Manual database restore
docker exec -i flux-db mysql -u flux_user -p flux_notify < backup.sql