Cachet/README.md

96 lines
3.9 KiB
Markdown
Raw Normal View History

# Cachet
2015-02-19 13:44:22 +00:00
[![StyleCI](https://styleci.io/repos/26730195/shield)](https://styleci.io/repos/26730195/)
2016-01-30 12:41:07 +00:00
[![Build Status](https://img.shields.io/travis/CachetHQ/Cachet.svg?style=flat-square)](https://travis-ci.org/CachetHQ/Cachet)
[![Quality Score](https://img.shields.io/scrutinizer/g/CachetHQ/Cachet.svg?style=flat-square)](https://scrutinizer-ci.com/g/CachetHQ/Cachet)
[![Software License](https://img.shields.io/badge/license-BSD3-brightgreen.svg?style=flat-square)](LICENSE)
2015-06-25 14:33:57 +01:00
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/cachet/localized.png)](http://translate.cachethq.io/project/cachet)
2016-02-29 22:00:58 +00:00
[![Packagist](https://img.shields.io/packagist/v/cachethq/cachet.svg?style=flat-square)](https://packagist.org/packages/cachethq/cachet)
2014-11-20 19:29:06 +00:00
![Screenshot](https://cachethq.io/img/main-interface.jpg)
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.
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
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.
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
- Apache or Nginx server
- [Composer](https://getcomposer.org)
2015-02-25 14:58:34 +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
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](#translations).
Of course bug reports, feature requests and [documentation](https://docs.cachethq.io) 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, Bower and Gulp.
2. Install the assets; `bower install`
3. Modify the SCSS files in `./resources/assets/sass/`
4. 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](https://laravel.com), Cachet is very easy to jump into. Have a look around you'll find it!
2015-02-25 14:58:34 +00:00
These extra dependencies are required 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
- Bower
- Gulp
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
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
If you discover a security vulnerability within Cachet, please send an e-mail to us at support@alt-three.com. All security vulnerabilities will be promptly addressed.