Cachet/README.md

72 lines
2.7 KiB
Markdown
Raw Normal View History

2017-03-20 23:10:09 +00:00
<p align="center"><img src="https://demo.cachethq.io/img/cachet-logo.svg" width="50%"></p>
<p align="center">
2017-01-02 15:03:03 +00:00
<a href="https://styleci.io/repos/26730195/"><img src="https://styleci.io/repos/26730195/shield" alt="StyleCI"></a>
<a href="https://travis-ci.org/CachetHQ/Cachet"><img src="https://img.shields.io/travis/CachetHQ/Cachet/2.4.svg?style=flat-square" alt="Build Status"></a>
<a href="LICENSE"><img src="https://img.shields.io/badge/license-BSD3-brightgreen.svg?style=flat-square" alt="License"></a>
<a href="https://translate.cachethq.io/project/cachet"><img src="https://d322cqt584bo4o.cloudfront.net/cachet/localized.svg" alt="Localisation"></a>
2017-01-02 15:03:03 +00:00
<a href="https://github.com/CachetHQ/Cachet/releases"><img src="https://img.shields.io/github/release/cachethq/cachet.svg?style=flat-square" alt="Latest Stable Version"></a>
</p>
2016-08-08 17:30:04 +01:00
Cachet is a beautiful and powerful open source status page system.
2017-03-12 11:42:28 +00:00
## Community
You can now [join our Slack community!](http://cachethq-slack.herokuapp.com)
## Overview
2014-12-22 12:46:25 +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
- A powerful JSON API
2015-06-19 21:16:04 +01:00
- Metrics
- 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
- PHP 7.1 or later
2016-08-18 09:54:53 +01:00
- HTTP server with PHP support (eg: Apache, Nginx, Caddy)
- [Composer](https://getcomposer.org)
- 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
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)
- [Installing Cachet on Windows](https://docs.cachethq.io/docs/installing-cachet-on-windows)
2015-08-08 17:12:31 +01:00
2017-07-27 07:30:49 -04:00
### Demo
2015-04-05 22:55:16 +01:00
2017-07-27 07:30:49 -04:00
To test out the demo, you may login to the [Dashboard](https://dev.cachethq.io/dashboard) with the following:
- **Username:** `test` or `test@test.com`
- **Password:** `test123`
> The demo resets every 30 minutes.
## 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
We offer a professional installation service. To find out more, email us at [support@alt-three.com](mailto:support@alt-three.com?Cachet%20Installation)
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.
2018-06-22 08:55:07 +01:00
## Sponsorship
Thank you to the following for [sponsoring](https://patreon.com/jbrooksuk) Cachet.
2018-06-22 08:56:37 +01:00
![Exascale](/docs/images/sponsorships/exascale.jpg)