README.md

Cachet is a beautiful and powerful open source status page system.

Overview

• List your service components
• Report incidents
• Customise the look of your status page
• Markdown support for incident messages
• A powerful JSON API
• Metrics
• Multi-lingual
• Subscriber notifications via email
• Two factor authentication

Community

You can now join our Slack community!

Requirements

• PHP 7.1 or later
• HTTP server with PHP support (eg: Apache, Nginx, Caddy)
• Composer
• A supported database: MySQL, PostgreSQL or SQLite

Installation, Upgrades and Documentation

You can find documentation at https://docs.cachethq.io.

Here are some useful quick links:

• Installing Cachet
• Getting started with Docker
• Installing Cachet on Windows

Demo

To test out the demo, you may login to the Dashboard with the following:

• Username: test or [email protected]
• Password: test123

The demo resets every 30 minutes.

Translate Cachet

If you'd like to contribute translations, please check out our CrowdIn project.

Security Vulnerabilities

If you discover a security vulnerability within Cachet, please send an e-mail to [email protected]. All security vulnerabilities on a case-by-case basis.

Limited Support Contact

We may be able to resolve support queries via email. Please send an e-mail to [email protected]. Please first check the GitHub issue tracker before emailing.

Professional Installation Service

A professional installation service is offered by Alt Three Services Limited. To find out more, contact [email protected]. Do not contact this email address for general support.

Sponsorship

Thank you to the following for sponsoring Cachet.