Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 3.13 KB

README.md

File metadata and controls

72 lines (48 loc) · 3.13 KB

Cachet Deploy

Build Status Quality Score Software License Gitter

Current progress

For more information on why I started developing Cachet, check out my blog post, for more read [What's next for Cachet?](What's next for Cachet?) A demo, deployed to Heroku.

Currently in development. Things may change or break until a solid release has been announced.

Incompatibility

Cachet is currently unable to build assets under CentOS 6 and Debian Wheezy. This problem lies within the dependencies of our build setup, not Cachet itself. For more information see this issue.

Features

  • List your services components.
  • Log incidents.
  • Override status page colors.
  • Apply a custom stylesheet to the status page.
  • Markdown support for incident messages.
  • RESTful API.
  • Multilingual.

Requirements

  • PHP 5.4 or newer
  • mcrypt extension
  • Composer
  • Node.js
    • Bower
    • Gulp

Installation & Documentation

You can now find our documentation at https://docs.cachethq.io or, directly at http://cachet.readme.io.

Quickstart with Docker

Run a DB container (you can either pass in environment variables for the DB, or mount a config with -v /my/database.php:/var/www/html/app/config/database.php):

export DB_USERNAME=cachet
export DB_PASSWORD=cachet
export DB_DATABASE=cachet
docker run --name mysql -e MYSQL_USER=$DB_USERNAME -e MYSQL_PASSWORD=$DB_PASSWORD -e MYSQL_DATABASE=$DB_DATABASE -d mysql

Initialize the DB if you havent yet:

docker run --link mysql:mysql -e DB_HOST=mysql -e DB_DATABASE=$DB_DATABASE -e DB_USERNAME=$DB_USERNAME -e DB_PASSWORD=$DB_PASSWORD cachethq/cachet:latest php artisan migrate

Run Cachet:

docker run -d --name cachet --link mysql:mysql -p 80:80 -e DB_HOST=mysql -e DB_DATABASE=$DB_DATABASE -e DB_USERNAME=$DB_USERNAME -e DB_PASSWORD=$DB_PASSWORD cachethq/cachet:latest

Now go to http://<ipdockerisboundto>/setup and have fun!

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.

License

Cachet is licensed under The MIT License (MIT).