You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: document Pro features with crown badges and license configuration
- Add MAINTENANT_LICENSE_KEY to README and configuration docs
- Add Pro license section to configuration guide with activation steps
- Add crown icon badges to Pro-only doc sections (alerts, resources,
updates, status page)
- Document incident management, maintenance windows, subscriber
notifications, and CVE enrichment in feature docs
- Add subtle Pro mentions in docs index and README editions section
- Add mkdocs-material custom CSS for crown icon styling
- ProPage: show thank you message when license is active
- FeatureGate: link Pro badge to pro-edition page
@@ -366,7 +367,7 @@ Full REST API under `/api/v1/` for automation and integration.
366
367
367
368
## Editions
368
369
369
-
maintenant is available in two editions:
370
+
maintenant is fully functional out of the box. The **Pro Edition** is available for teams that need advanced alerting, vulnerability intelligence, and extended notification channels.
370
371
371
372
| Feature | Community | Pro |
372
373
|---------|:---------:|:---:|
@@ -389,7 +390,13 @@ maintenant is available in two editions:
389
390
| Incident management || x |
390
391
| Subscriber notifications || x |
391
392
392
-
The Community Edition is fully functional for self-hosted monitoring. maintenant Pro adds advanced alerting, notification channels, and enterprise features.
393
+
To activate Pro, set your license key in the environment:
394
+
395
+
```bash
396
+
MAINTENANT_LICENSE_KEY=your-license-key
397
+
```
398
+
399
+
Learn more at [kolapsis.github.io/maintenant](https://kolapsis.github.io/maintenant/).
Track and communicate incidents with timeline updates. Each incident has a severity, status, and a history of updates visible on the public status page.
100
+
101
+
```bash
102
+
# Create an incident
103
+
POST /api/v1/status/incidents
104
+
{
105
+
"title": "API latency increase",
106
+
"severity": "minor",
107
+
"message": "Investigating elevated response times on the API."
108
+
}
109
+
110
+
# Post a timeline update
111
+
POST /api/v1/status/incidents/{id}/updates
112
+
{
113
+
"status": "identified",
114
+
"message": "Root cause identified. Deploying fix."
115
+
}
116
+
```
117
+
118
+
---
119
+
120
+
## Maintenance Windows :material-crown:{ title="Pro" }
121
+
Schedule planned downtime. Maintenance windows appear on the status page and automatically suppress alerts for affected components.
To enable Pro features (Slack/Teams/Email channels, CVE enrichment, incident management, maintenance windows, subscriber notifications, and more), set the `MAINTENANT_LICENSE_KEY` environment variable:
64
+
65
+
```yaml
66
+
services:
67
+
maintenant:
68
+
image: ghcr.io/kolapsis/maintenant-pro:latest
69
+
environment:
70
+
MAINTENANT_LICENSE_KEY: "your-license-key"
71
+
```
72
+
73
+
The license is verified periodically against the license server. If the server is temporarily unreachable, Pro features remain active from cache with a graceful degradation window.
74
+
75
+
You can check the current license status via the API:
76
+
77
+
```
78
+
GET /api/v1/license/status
79
+
```
80
+
81
+
---
82
+
60
83
## Security Model
61
84
62
85
maintenant does not include built-in authentication — by design.
Copy file name to clipboardExpand all lines: docs/index.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,8 +22,8 @@ Deploy one container, and maintenant auto-discovers your entire stack. Docker or
22
22
-**[TLS Certificate Monitoring](features/certificates.md)** — Auto-detection from HTTPS endpoints. Alerts at 30, 14, 7, 3, and 1 day before expiry. Full chain validation.
23
23
-**[Resource Metrics](features/resources.md)** — CPU, memory, network I/O, disk I/O per container. Historical charts, alert thresholds, top consumers view.
24
24
-**[Update Intelligence](features/updates.md)** — OCI registry scanning, digest comparison. Know when your images have updates available.
25
-
-**[Alert Engine](features/alerts.md)** — Unified alerts across all sources. Webhook and Discord channels. Silence rules, exponential backoff.
26
-
-**[Public Status Page](features/status-page.md)** — Component groups, incident management, scheduled maintenance.
25
+
-**[Alert Engine](features/alerts.md)** — Unified alerts across all sources. Webhook and Discord channels. Silence rules, exponential backoff. Slack, Teams, and Email with Pro.
26
+
-**[Public Status Page](features/status-page.md)** — Component groups, live SSE updates. Incident management, maintenance windows, and subscriber notifications with Pro.
27
27
-**[MCP Server](features/mcp.md)** — Expose monitoring data to AI assistants (Claude Code, Cursor) via the Model Context Protocol. 18 tools, stdio and HTTP transports.
0 commit comments