Skip to content

Latest commit

 

History

History
102 lines (62 loc) · 3.82 KB

README.md

File metadata and controls

102 lines (62 loc) · 3.82 KB
Raw

Cachet

StyleCI Build Status Software License Crowdin Latest Release

Screenshot

Cachet is a beautiful and powerful open source status page system.

Features

  • 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 using Google Authenticator

Requirements

  • PHP 5.5.9+ or newer
  • HTTP server with PHP support (eg: Apache, Nginx, Caddy)
  • Composer

I'm looking to contribute to this awesome project!

Sweet, 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

We're always looking for new translations.

Of course bug reports, feature requests and documentation are always appreciated.

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:

  1. Install Node.js and our dev dependencies.
  2. Make your changes to the SCSS files in ./resources/assets/sass/
  3. Run gulp

If you're making a lot of changes, you'll find that running gulp watch will make life easier for you!

Contributing as a developer

Built using Laravel.

We use these extra dependencies to develop Cachet:

  • Node.js
  • Gulp
  • Git

Once cloned to your local machine, you'll need some demo data! Run php artisan cachet:seed to get the demo installation ready for action.

Installation, Upgrades and Documentation

Documentation is found at https://docs.cachethq.io.

Here are some useful quick links:

Demo Account

To test out the demo, you may login to the Dashboard with the following:

The demo is reset every half hour.

Translations

If you'd like to contribute translations, please check out our CrowdIn project.

Thank you to our translators, who have allowed us to share Cachet with the world!

Show your support

Cachet is a BSD-3-licensed open source project. If you'd like to support future development, check out the Patreon campaign.

Professional Installation Service

We offer a professional installation service. To find out more, email us at [[email protected]](mailto:[email protected]?Cachet Installation)

Security Vulnerabilities

If you discover a security vulnerability within Cachet, please send an e-mail to us at [email protected]. We handle all security vulnerabilities on a case-by-case basis.