2015-04-03 17:10:20 +01:00
# Cachet
2015-01-01 17:54:18 +00:00
2015-02-19 13:44:22 +00:00
[](https://styleci.io/repos/26730195/)
2016-04-22 15:30:59 +01:00
[](https://travis-ci.org/CachetHQ/Cachet)
2015-06-02 14:29:17 +01:00
[](LICENSE)
2015-06-25 14:33:57 +01:00
[](http://translate.cachethq.io/project/cachet)
2016-02-29 22:00:58 +00:00
[](https://packagist.org/packages/cachethq/cachet)
2014-11-20 19:29:06 +00:00
2015-03-13 10:40:43 +00:00
2014-11-24 09:10:56 +00:00
2016-02-29 22:01:59 +00:00
Cachet is a beautiful and powerful open source status page system, a free replacement to services such as StatusPage.io, Status.io and others.
2016-06-30 08:48:30 +01:00
## Show your support
2016-05-20 13:21:49 +01:00
2016-06-30 08:48:30 +01:00
Cachet is a BSD-3-licensed open source project. If you'd like to support future development, check out the [Patreon campaign ](https://patreon.com/jbrooksuk ).
2016-05-20 13:21:49 +01:00
2015-01-01 17:56:11 +00:00
## Features
2014-12-22 12:46:25 +00:00
2015-06-19 21:16:04 +01:00
- List your services components
- Log incidents
- Apply custom CSS to the status page
- Markdown support for incident messages
- JSON API
- Translated into eleven languages
- Metrics
- Cross-database support: MySQL, PostgreSQL and SQLite
- Subscriber notifications via Email
- Two factor authentication, with Google Authenticator
2014-12-22 12:46:25 +00:00
2015-10-01 20:46:48 +01:00
## Usage in production
2016-06-30 08:48:30 +01:00
Use of `master` in a production environment is not recommended as it may change at any time.
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-02-29 22:10:40 +00:00
- Apache or Nginx server
2015-03-13 10:40:43 +00:00
- [Composer ](https://getcomposer.org )
2015-02-25 14:58:34 +00:00
2016-02-29 22:10:40 +00:00
## How to contribute
We're always looking for contributions that improve Cachet. It's easy to get started and you don't even need to know how to write a single line of code!
### Contributing as a non-developer/non-designer
2016-06-30 08:48:30 +01:00
We're always looking for new [translations ](#translations ).
2016-02-29 22:10:40 +00:00
2016-06-30 08:48:30 +01:00
Of course bug reports, feature requests and [documentation ](https://docs.cachethq.io ) are always appreciated.
2016-02-29 22:10:40 +00:00
### Contributing as a designer
As Cachet gains new features, the design and ideas that were once a perfect fit need updating and in some cases designing from scratch. This is where you come in! Fancy giving Cachet a lick of paint? Sweet!
You'll need to install Node.js, Bower and Gulp.
To get started you can do the following:
2016-05-11 20:11:46 +01:00
1. Install Node.js and our dev dependencies.
2016-06-30 08:48:30 +01:00
2. Make your changes to the SCSS files in `./resources/assets/sass/`
2016-05-11 20:11:46 +01:00
3. Run `gulp`
2016-02-29 22:10:40 +00:00
2016-06-30 08:48:30 +01:00
If you're making a lot of changes, you'll find that running `gulp watch` will make life easier for you!
2016-02-29 22:10:40 +00:00
### Contributing as a developer
2016-06-30 08:48:30 +01:00
Built using [Laravel ](https://laravel.com ).
2015-02-25 14:58:34 +00:00
2016-06-30 08:48:30 +01:00
We use these extra dependencies to develop Cachet:
2015-02-25 14:58:34 +00:00
2014-12-30 22:09:22 +00:00
- Node.js
2015-06-19 21:16:04 +01:00
- Gulp
2016-02-29 22:12:41 +00:00
- Git
2016-06-30 08:48:30 +01:00
Once cloned to your local machine, you'll need some demo data! Run `php artisan cachet:seed` to get the demo installation on the go.
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
2015-06-19 21:16:04 +01:00
You can now find our documentation at [https://docs.cachethq.io ](https://docs.cachethq.io ).
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 )
- [Getting started with Vagrant ](https://docs.cachethq.io/docs/get-started-with-vagrant )
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:
2015-12-17 16:13:04 +08:00
- **Username:** test or test@test .com
2015-04-05 22:55:16 +01:00
- **Password:** test123
2015-06-19 21:16:04 +01:00
The demo is reset every half hour.
2014-11-24 10:22:46 +00:00
2016-03-14 14:21:19 +01:00
### Release Notes
2016-06-30 08:48:30 +01:00
We list releases on the [Releases page ](https://github.com/CachetHQ/Cachet/releases ) of the [Cachet GitHub repository ](https://github.com/CachetHQ/Cachet ). On the Releases page, you can also find the release notes for each release.
2016-03-14 14:21:19 +01:00
2015-01-01 17:56:11 +00:00
## Translations
2014-12-27 17:54:58 +00:00
2015-01-08 17:09:27 +00:00
A special thank you to our [translators ](https://crowdin.com/project/cachet/activity_stream ), who have allowed us to share Cachet with the world. 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
## Security Vulnerabilities
2016-06-30 08:48:30 +01:00
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.
2016-04-06 10:13:30 +01:00
## Installations
We offer a paid installation service, which starts at $99 but is subject to change, dependant on your setup and infrastructure.
To find out more, email us at support@alt -three.com
