Frequently asked questions
Simple answers for getting started and understanding what each part of Calmping does.
What does Calmping do?
Calmping checks your websites, apps, APIs, background jobs, certificates, DNS, and TCP services. When something breaks, it opens an incident, alerts you, and keeps the history for a postmortem.
How do I monitor my first website?
Log in, open Overview, choose Add app, enter a name and the website address, then select Run now. A basic uptime check is created automatically.
Which check type should I choose?
Use Uptime for a website, Keyword to check visible text, JSON field for an API, Heartbeat for a scheduled job, TCP port for a database or server, and Custom HTTP for advanced authenticated requests.
What is a failure threshold?
It is the number of failed checks in a row before Calmping opens an incident. Three is a calm default. Use two for a critical service when you want a faster alert.
What does Run now do?
It tests a check immediately instead of waiting for the next scheduled run. Use it whenever you add or change a monitor.
How will I be alerted?
You can use email, browser/phone push, Slack, Discord, or a generic webhook. Alerts are saved to a durable queue first and retried if a provider is temporarily unavailable.
Can I monitor a database?
Yes. A TCP port check can confirm that PostgreSQL, MySQL, Redis, MongoDB, or another service accepts a connection. For deeper health, also monitor an application health endpoint that performs a safe test query.
Can I monitor a private or local service?
Your private SELF_MODE installation can monitor localhost, Docker, VPN, and LAN targets when private targets are enabled. The public shared service blocks private addresses for security.
What happens when an incident opens?
The incident shows the evidence and timeline. You can acknowledge it, open a runbook, request an AI diagnosis, and record how it was fixed. It resolves automatically when the check becomes healthy.
Can I use my own AI provider?
Yes. Choose a curated provider preset in the Integration Hub, or use the clearly labeled Advanced/custom option for a self-hosted, private, or unsupported OpenAI-compatible server. You provide and pay for your own API key. AI suggestions should always be reviewed by a person.
Are my API keys safe?
Integration credentials are encrypted at rest and never returned by read APIs. They are decrypted only when Calmping needs to call the selected provider.
What is the public status page?
It is an optional shareable page showing service health, uptime, and incident history. It does not reveal your email, target addresses, check configuration, evidence, or secrets.
What is a postmortem?
A short record of what happened, the impact, the cause, what fixed it, and how to stop it happening again. Confirmed postmortems become part of your app's knowledge library.
How do Free and Pro work?
Free monitors one app. Pro supports up to ten apps and faster checks. Public billing uses Stripe. The private local SELF_MODE edition has billing disabled.
Can I export or delete my data?
Yes. Settings lets you export your data as JSON or permanently delete your account and all its associated records.
Where is the beginner guide?
The repository includes a plain-language guide at docs/USER_GUIDE.md. The owner operations guide is at docs/OPERATIONS_PLAYBOOK.md.