Cachet is a beautiful and powerful open source status page system, a free replacement to services such as StatusPage.io, Status.io and others.
- 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
The master branch of this repository is a development branch and should not be used in production. Instead, please check out the latest tag release.
- PHP 5.5.9+ or newer
- Apache or Nginx server
- Composer
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!
If you're one of the more linguistically talented people in the world who can speak and write more than just English, we're always looking for new translations.
Of course bug reports, feature requests and documentation are always being sought after.
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:
- Install Node.js, Bower and Gulp.
- Install the assets;
bower install - Modify the SCSS files in
./resources/assets/sass/ - Run
gulp
If you're making a lot of changes, you'll find that running gulp watch will really help you out!
Built using Laravel, Cachet is very easy to jump into. Have a look around you'll find it!
These extra dependencies are required to develop Cachet:
- Node.js
- Bower
- Gulp
- Git
Once cloned to your local machine, you'll need some demo data! Simply run php artisan cachet:seed to get the demo installation on the go.
You can now find our documentation at https://docs.cachethq.io.
To test out the demo, you may login to the Dashboard with the following:
- Username: test or [email protected]
- Password: test123
The demo is reset every half hour.
A special thank you to our translators, who have allowed us to share Cachet with the world. If you'd like to contribute translations, please check out our CrowdIn project.
If you discover a security vulnerability within Cachet, please send an e-mail to us at [email protected]. All security vulnerabilities will be promptly addressed.