Giter VIP home page Giter VIP logo

cachet's Introduction

Cachet

StyleCI Build Status Software License Crowdin Packagist

Screenshot

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

Supporting Cachet

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

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

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.

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!

Contributing as a non-developer/non-designer

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.

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. Modify 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 really help you out!

Contributing as a developer

Built using Laravel, Cachet is very easy to jump into. Have a look around you'll find it surprisingly easy!

These extra dependencies are required to develop Cachet:

  • Node.js
  • 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.

Installation, Upgrades and Documentation

You can now find our documentation at https://docs.cachethq.io.

Demo Account

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

The demo is reset every half hour.

Release Notes

All releases are listed on the Releases page of the Cachet GitHub repository. On the Releases page, you can also find the release notes for each release.

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.

Security Vulnerabilities

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.

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 [email protected]

cachet's People

Contributors

jbrooksuk avatar grahamcampbell avatar joecohens avatar lianguan avatar manavo avatar ehesp avatar billmn avatar mmollick avatar n0mer avatar gm-ah avatar ldidry avatar chaseconey avatar sammcj avatar theobearman avatar noahbass avatar jamesking56 avatar ilikeprograms avatar samuelmoraesf avatar darkpixel avatar fabian avatar byxorna avatar lenovouser avatar guanshiliang avatar demlasjr avatar mattclements avatar edemeijer avatar anlutro avatar lavatoaster avatar tobru avatar manuelgu avatar

Watchers

RAKESH SHARMA avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.