2017-01-02 14:52:43 +00:00
< p align = "center" >< img src = "/public/img/cachet-logo @2x .png" ></ p >
2015-01-01 17:54:18 +00:00
2017-01-02 14:52:43 +00:00
< p align = "center" >
2015-02-19 13:44:22 +00:00
[![StyleCI ](https://styleci.io/repos/26730195/shield )](https://styleci.io/repos/26730195/)
2016-08-08 17:26:10 +01:00
[![Build Status ](https://img.shields.io/travis/CachetHQ/Cachet/2.4.svg?style=flat-square )](https://travis-ci.org/CachetHQ/Cachet)
2015-06-02 14:29:17 +01:00
[![Software License ](https://img.shields.io/badge/license-BSD3-brightgreen.svg?style=flat-square )](LICENSE)
2016-07-12 16:14:54 +08:00
[![Crowdin ](https://d322cqt584bo4o.cloudfront.net/cachet/localized.svg )](http://translate.cachethq.io/project/cachet)
2016-08-23 13:25:24 +01:00
[![Latest Release ](https://img.shields.io/github/release/cachethq/cachet.svg?style=flat-square )](https://github.com/CachetHQ/Cachet/releases)
2017-01-02 14:52:43 +00:00
< / p >
2014-11-24 09:10:56 +00:00
2016-08-08 17:30:04 +01:00
Cachet is a beautiful and powerful open source status page system.
2016-05-20 13:21:49 +01:00
2017-01-02 14:52:43 +00:00
## Overview
2014-12-22 12:46:25 +00:00
2017-01-02 14:52:43 +00:00
- List your service components
- Report incidents
- Customise the look of your status page
2015-06-19 21:16:04 +01:00
- Markdown support for incident messages
2017-01-02 14:52:43 +00:00
- A powerful JSON API
2015-06-19 21:16:04 +01:00
- Metrics
2017-01-02 14:52:43 +00:00
- Multi-lingual
- Subscriber notifications via email
- Two factor authentication
2015-10-01 20:46:48 +01:00
2015-01-01 17:56:11 +00:00
## Requirements
2014-12-30 22:09:22 +00:00
2015-06-16 09:41:56 +01:00
- PHP 5.5.9+ or newer
2016-08-18 09:54:53 +01:00
- HTTP server with PHP support (eg: Apache, Nginx, Caddy)
2015-03-13 10:40:43 +00:00
- [Composer ](https://getcomposer.org )
2017-01-02 14:52:43 +00:00
- A supported database: MySQL, PostgreSQL or SQLite
2014-11-20 17:27:01 +00:00
2015-05-19 08:39:00 +01:00
## Installation, Upgrades and Documentation
2014-11-20 17:27:01 +00:00
2017-01-02 14:52:43 +00:00
You can find documentation at [https://docs.cachethq.io ](https://docs.cachethq.io ).
2016-08-08 17:30:04 +01:00
Here are some useful quick links:
2015-05-19 08:39:00 +01:00
2015-08-08 17:12:31 +01:00
- [Installing Cachet ](https://docs.cachethq.io/docs/installing-cachet )
- [Getting started with Docker ](https://docs.cachethq.io/docs/get-started-with-docker )
2015-04-05 22:55:16 +01:00
### Demo Account
To test out the demo, you may login to the [Dashboard ](https://demo.cachethq.io/dashboard ) with the following:
2016-08-08 17:30:04 +01:00
- **Username:** `test` or `test@test.com`
- **Password:** `test123`
2015-04-05 22:55:16 +01:00
2017-01-02 14:52:43 +00:00
> The demo resets every 30 minutes.
2014-11-24 10:22:46 +00:00
2017-01-02 14:52:43 +00:00
## Translate Cachet
2014-12-27 17:54:58 +00:00
2016-08-08 17:30:04 +01:00
If you'd like to contribute translations, please check out our [CrowdIn project ](https://crowdin.com/project/cachet ).
2015-10-01 20:55:24 +01:00
2016-08-08 17:30:04 +01:00
## Professional Installation Service
2016-04-06 10:13:30 +01:00
2016-08-08 17:30:04 +01:00
We offer a professional installation service. To find out more, email us at [support@alt-three.com ](mailto:support@alt-three.com?Cachet Installation )
2016-04-06 10:13:30 +01:00
2016-08-08 17:30:04 +01:00
## Security Vulnerabilities
If you discover a security vulnerability within Cachet, please send an e-mail to us at support@alt -three.com. We handle all security vulnerabilities on a case-by-case basis.