mirror of
https://github.com/CachetHQ/Cachet.git
synced 2025-01-17 13:38:20 +01:00
103 lines
5.1 KiB
Markdown
103 lines
5.1 KiB
Markdown
<p align="center"><img src="https://demo.cachethq.io/img/cachet-logo.svg" width="50%"></p>
|
||
|
||
<p align="center">
|
||
<a href="https://styleci.io/repos/26730195/"><img src="https://styleci.io/repos/26730195/shield" alt="StyleCI"></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>
|
||
<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>
|
||
|
||
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!](http://cachethq-slack.herokuapp.com)
|
||
|
||
## Requirements
|
||
|
||
- PHP 7.1.3 – 7.3
|
||
- HTTP server with PHP support (e.g.: Apache, Nginx, Caddy)
|
||
- [Composer](https://getcomposer.org)
|
||
- A supported database: 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/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)
|
||
|
||
### Demo
|
||
|
||
To test out the demo, you can log in to the [Dashboard](https://dev.cachethq.io/dashboard) with the following credentials:
|
||
|
||
- **Username:** `test` or `test@example.com`
|
||
- **Password:** `test123`
|
||
|
||
> The demo resets every 30 minutes.
|
||
|
||
## Translate Cachet
|
||
|
||
If you'd like to contribute translations, please check out our [Crowdin project](https://crowdin.com/project/cachet).
|
||
|
||
## 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.
|
||
|
||
## Limited Support Contact
|
||
|
||
We may be able to resolve **support queries** via email. Please send an email to [support@cachethq.io](mailto:support@cachethq.io?Cachet%20Support). Please check the GitHub [issue tracker](https://github.com/CachetHQ/Cachet/issues) first before emailing.
|
||
|
||
## Professional Installation Service
|
||
|
||
A professional **installation service** is offered by Alt Three Services Limited. To find out more, contact [support@alt-three.com](mailto:support@alt-three.com?Cachet%20Installation). **Do not contact this email address for general support.**
|
||
|
||
## Sponsorship
|
||
|
||
You can sponsor Cachet at our [Patreon page](https://patreon.com/jbrooksuk).
|
||
|
||
## Contributors
|
||
|
||
### Code Contributors
|
||
|
||
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
|
||
<a href="https://github.com/CachetHQ/Cachet/graphs/contributors"><img src="https://opencollective.com/Cachet/contributors.svg?width=890&button=false" /></a>
|
||
|
||
### Financial Contributors
|
||
|
||
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/Cachet/contribute)]
|
||
|
||
#### Individuals
|
||
|
||
<a href="https://opencollective.com/Cachet"><img src="https://opencollective.com/Cachet/individuals.svg?width=890"></a>
|
||
|
||
#### Organizations
|
||
|
||
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/Cachet/contribute)]
|
||
|
||
<a href="https://opencollective.com/Cachet/organization/0/website"><img src="https://opencollective.com/Cachet/organization/0/avatar.svg"></a>
|
||
<a href="https://opencollective.com/Cachet/organization/1/website"><img src="https://opencollective.com/Cachet/organization/1/avatar.svg"></a>
|
||
<a href="https://opencollective.com/Cachet/organization/2/website"><img src="https://opencollective.com/Cachet/organization/2/avatar.svg"></a>
|
||
<a href="https://opencollective.com/Cachet/organization/3/website"><img src="https://opencollective.com/Cachet/organization/3/avatar.svg"></a>
|
||
<a href="https://opencollective.com/Cachet/organization/4/website"><img src="https://opencollective.com/Cachet/organization/4/avatar.svg"></a>
|
||
<a href="https://opencollective.com/Cachet/organization/5/website"><img src="https://opencollective.com/Cachet/organization/5/avatar.svg"></a>
|
||
<a href="https://opencollective.com/Cachet/organization/6/website"><img src="https://opencollective.com/Cachet/organization/6/avatar.svg"></a>
|
||
<a href="https://opencollective.com/Cachet/organization/7/website"><img src="https://opencollective.com/Cachet/organization/7/avatar.svg"></a>
|
||
<a href="https://opencollective.com/Cachet/organization/8/website"><img src="https://opencollective.com/Cachet/organization/8/avatar.svg"></a>
|
||
<a href="https://opencollective.com/Cachet/organization/9/website"><img src="https://opencollective.com/Cachet/organization/9/avatar.svg"></a>
|