Configuration

SolidPing is configured primarily through environment variables. All environment variables use the SP_ prefix. Configuration uses hierarchical precedence: Environment variables > config.local.yml > config.yml > defaults.

Configuration Methods

1. Environment Variables - Recommended for Docker and production
2. Configuration File - config.yml in the working directory (with config.local.yml for local overrides)
3. Command Line - Some options can be passed via CLI flags

Quick Reference

Essential Variables

Variable	Default	Description
SP_DB_TYPE	sqlite	Database type: postgres, sqlite, sqlite-memory, postgres-embedded
SP_DB_URL	-	PostgreSQL connection string
SP_DB_DIR	.	SQLite database directory
SP_DB_RESET	false	Reset database on startup
SP_SERVER_LISTEN	:4000	Server address and port
SP_BASE_URL	http://localhost:4000	Public URL where SolidPing is accessible

Server Configuration

Variable	Default	Description
SP_SERVER_LISTEN	:4000	Listen address (e.g., :4000, 0.0.0.0:8080)
SP_SERVER_JOB_WORKER_NB	2	Number of job runner goroutines
SP_SERVER_CHECK_WORKER_NB	3	Number of check runner goroutines
SP_SHUTDOWN_TIMEOUT	30s	Graceful shutdown timeout
PORT	-	Alternative to SP_SERVER_LISTEN (for PaaS compatibility)

Distributed Workers

Variable	Default	Description
SP_NODE_ROLE	all	Node role: all, api, jobs, checks
SP_NODE_REGION	-	Worker region (required when role=checks)

Use SP_NODE_ROLE to run SolidPing in a distributed configuration:

• all - Single node running everything (default)
• api - Only serve the API and dashboard
• jobs - Only run background jobs (scheduling, cleanup)
• checks - Only execute health checks (worker mode)

Logging

Variable	Default	Description
SP_LOG_LEVEL	info	Log level: debug, info, warn, error

Authentication

Variable	Default	Description
SP_AUTH_JWT_SECRET	auto-generated	JWT signing secret
SP_AUTH_REGISTRATION_EMAIL_PATTERN	-	Restrict registration by email regex

OAuth Providers

Set both _CLIENT_ID and _CLIENT_SECRET to enable each provider:

Provider	Variables
Google	SP_GOOGLE_CLIENT_ID, SP_GOOGLE_CLIENT_SECRET
GitHub	SP_GITHUB_CLIENT_ID, SP_GITHUB_CLIENT_SECRET
GitLab	SP_GITLAB_CLIENT_ID, SP_GITLAB_CLIENT_SECRET
Microsoft	SP_MICROSOFT_CLIENT_ID, SP_MICROSOFT_CLIENT_SECRET

Run Mode

Variable	Default	Description
SP_RUN_MODE	-	Runtime mode: test (seed test data), demo

Development

Variable	Description
SP_REDIRECTS	Dev proxy redirects (format: /path:host:port/target,...)

Example Configuration

Environment Variables

# Database (PostgreSQL)
SP_DB_TYPE=postgres
SP_DB_URL=postgresql://solidping:password@localhost:5432/solidping?sslmode=disable

# Server
SP_BASE_URL=https://monitoring.example.com
SP_SERVER_LISTEN=:4000

# Workers
SP_SERVER_JOB_WORKER_NB=4
SP_SERVER_CHECK_WORKER_NB=8

# Authentication
SP_AUTH_JWT_SECRET=your-secure-random-secret
SP_GOOGLE_CLIENT_ID=your-google-client-id
SP_GOOGLE_CLIENT_SECRET=your-google-client-secret

# Logging
SP_LOG_LEVEL=info

Configuration File (config.yml)

db:
  type: postgres
  url: postgresql://solidping:password@localhost:5432/solidping?sslmode=disable

base_url: https://monitoring.example.com

server:
  listen: ":4000"
  job_worker_nb: 4
  check_worker_nb: 8
  shutdown_timeout: 30s

auth:
  jwt_secret: your-secure-random-secret

email:
  enabled: true
  host: smtp.example.com
  port: 587
  username: noreply@example.com
  password: smtp-password
  from: noreply@example.com
  from_name: SolidPing

slack:
  app_id: your-slack-app-id
  client_id: your-slack-client-id
  client_secret: your-slack-client-secret
  signing_secret: your-slack-signing-secret

CLI Configuration

The SolidPing CLI client (sp) uses its own configuration:

Variable	Default	Description
SOLIDPING_CONFIG	~/.config/solidping/settings.json	CLI config file path
SOLIDPING_URL	-	Server URL override
SOLIDPING_ORG	-	Organization override
SOLIDPING_VERBOSE	false	Verbose CLI logging

Sections

• Database Configuration - PostgreSQL and SQLite options
• Notifications - Email, Slack, Discord, webhooks, and more
• Authentication - OAuth providers and access control

Security Recommendations

Production Security

Always change these in production:

• Set SP_AUTH_JWT_SECRET to a strong random value
• Database passwords - Use strong, unique passwords
• Set SP_BASE_URL to your public URL
• Email credentials - Store securely, never commit to version control