2017 © Pedro Peláez
 

project cachet

An open source status page system, for everyone.

image

cachethq/cachet

An open source status page system, for everyone.

  • Saturday, July 28, 2018
  • by jbrooksuk
  • Repository
  • 301 Watchers
  • 8477 Stars
  • 205 Installations
  • PHP
  • 3 Dependents
  • 0 Suggesters
  • 967 Forks
  • 131 Open issues
  • 95 Versions
  • 2 % Grown

The README.md

Cachet

StyleCI Build Status Software License Crowdin Packagist, (*1)

Screenshot, (*2)

Cachet is a beautiful and powerful open source status page system, a free replacement to services such as StatusPage.io, Status.io and others., (*3)

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., (*4)

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, with Google Authenticator

Usage in production

Use of master in a production environment is not recommended as it may change at any time., (*5)

Requirements

  • PHP 5.5.9+ or newer
  • Apache or Nginx server
  • Composer

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!, (*6)

Contributing as a non-developer/non-designer

We're always looking for new translations., (*7)

Of course bug reports, feature requests and documentation are always appreciated., (*8)

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!, (*9)

You'll need to install Node.js, Bower and Gulp., (*10)

To get started you can do the following:, (*11)

  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!, (*12)

Contributing as a developer

Built using Laravel., (*13)

We use these extra dependencies to develop Cachet:, (*14)

  • 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 on the go., (*15)

Installation, Upgrades and Documentation

You can now find our documentation at https://docs.cachethq.io., (*16)

Demo Account

To test out the demo, you may login to the Dashboard with the following:, (*17)

  • Username: test or test@test.com
  • Password: test123

The demo is reset every half hour., (*18)

Release Notes

We list releases on the Releases page of the Cachet GitHub repository. On the Releases page, you can also find the release notes for each release., (*19)

Translations

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., (*20)

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., (*21)

Installations

We offer a paid installation service, which starts at $99 but is subject to change, dependant on your setup and infrastructure., (*22)

To find out more, email us at support@alt-three.com, (*23)

The Versions