Documentation

Build on the MonSPHERE platform

Real, technically accurate guides covering everything from your first monitor to platform administration — reflecting the actual API, not marketing copy.

Getting Started

Installation

Deploy the MonSPHERE backend via Docker Compose — the only supported deployment path today.

Agent & Exporter Installation

Install the MonSPHERE agent to auto-provision and supervise Prometheus exporters on a host.

Monitoring

Website Monitoring

HTTP/HTTPS, SSL, DNS, and heartbeat checks against any public or internal endpoint.

Infrastructure Monitoring

Server, container, database, and cloud infrastructure metrics via agents and exporters.

Alerting & Incidents

Alert Management

Threshold and anomaly-based alert rules, routed through Alertmanager to your team.

Incident Management

Every alert becomes a trackable, assignable incident with a full timeline.

Dashboards & Reporting

Dashboard Guide

Build widget-based dashboards from real-time and historical metrics.

Reporting & SLA Guide

Scheduled PDF, XLSX, and CSV reports with real uptime and MTTR calculations.

API & Auth

Authentication

JWT sessions, API keys, MFA/TOTP, and the OAuth provider catalog.

RBAC & Custom Roles

Six system roles, twelve permission keys, and organization-scoped custom roles.

API Guide

Response conventions, error format, and how every resource maps to REST endpoints.

Administration

Organizations & Multi-Tenant

How isolation, membership, and cross-organization access actually work.

Licensing & Subscriptions

Plans, real enforced limits, and cloud / enterprise / offline license types.

Platform Administration

The cross-organization console: organizations, licenses, feature flags, and audit.

Help

Troubleshooting

Common issues when installing agents, hitting quota, or debugging webhook delivery.

FAQ

Answers to common questions about plans, data, and deployment.

Upgrade & Migration Guide

Applying database migrations and upgrading a self-hosted deployment safely.