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:

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!

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
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.

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:

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

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 support@alt-three.com. 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 support@alt-three.com

Donations

Cachet is open source, we don't have any licensing models and don't run ads on the website.

If you'd like to donate towards further development of Cachet you can do so via Paypal.