mirror of
https://github.com/CachetHQ/Cachet.git
synced 2025-01-16 21:18:19 +01:00
57 lines
1.8 KiB
Markdown
57 lines
1.8 KiB
Markdown
<p align="center">
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="https://cachethq.io/assets/cachet-logo-dark.svg">
|
||
<img alt="Cachet Logo" src="https://cachethq.io/assets/cachet-logo-light.svg">
|
||
</picture>
|
||
</p>
|
||
|
||
Cachet, the open-source status page system.
|
||
|
||
## Cachet 3.x Announcement
|
||
|
||
We are shifting our attention and resources to Cachet 3.x and will no longer be supporting the 2.x version.
|
||
|
||
For more information on the Cachet rebuild and our plans for 3.x, you can read the announcement [here](https://github.com/CachetHQ/Cachet/discussions/4342).
|
||
|
||
## Features
|
||
|
||
- 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
|
||
|
||
## Requirements
|
||
|
||
- PHP 7.1.3 – 7.3
|
||
- HTTP server with PHP support (e.g.: Apache, Nginx, Caddy)
|
||
- [Composer](https://getcomposer.org)
|
||
- A supported database: MariaDB, MySQL, PostgreSQL or SQLite
|
||
|
||
## Installation, Upgrades and Documentation
|
||
|
||
You can find documentation at [https://docs.cachethq.io](https://docs.cachethq.io).
|
||
|
||
Here are some useful quick links:
|
||
|
||
- [Installing Cachet](https://docs.cachethq.io/installation/)
|
||
- [Getting started with Docker](https://docs.cachethq.io/installation/docker)
|
||
|
||
### Demo
|
||
|
||
To test out the demo, you can log in to the [Cachet dashboard](https://demo.cachethq.io/dashboard) with the following credentials:
|
||
|
||
- **Username:** `test` or `test@example.com`
|
||
- **Password:** `test123`
|
||
|
||
> **Note**
|
||
> The demo will automatically reset every 30 minutes.
|
||
|
||
## Security Vulnerabilities
|
||
|
||
If you discover a security vulnerability within Cachet, please send an e-mail to [support@cachethq.io](mailto:support@cachethq.io?Cachet%20Security%20Vulnerability). All security vulnerabilities are reviewed on a case-by-case basis.
|