diff --git a/INSTALL.md b/INSTALL.md index 8ac4cf24..977497a1 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,17 +1,23 @@ # Installation -Cachet is written in PHP and uses SQLite/MySQL for its database. It's really easy to get setup and there are various ways you can install. +Cachet is an open source replacement to [StatusPage.io](https://statuspage.io) written in PHP and the [Laravel](http://laravel.com) framework. You need at least PHP, [Composer](https://getcomposer.org/) and the `php-mcrypt` extension installed to run Cachet. +# Table of contents + 1. [Get a copy!](#get-a-copy) 2. [Deploy to Heroku](#deploy-to-heroku) 3. [Configuring a database!](#configuring-a-database) 1. [Running database migrations](#running-database-migrations) -4. [Apache setup](#apache) +4. [Running Cachet](#running-cachet) + 1. [Apache setup](#apache) + 1. [nginx setup](#nginx) 5. [Environment detection](#environment-detection) -## Get a copy! +# Get a copy! + +> If you want to run Cachet locally or help develop then you'll want to use this method. The easiest way is to use Git to pull down the code. You'll need to put it into your web server directory for Apache & Nginx. @@ -22,11 +28,11 @@ $ cd Cachet $ composer install ``` -## Deploy to Heroku +# Deploy to Heroku -When using the **Deploy to Heroku** button you needn't worry about using a database as the install will setup a free instance of ClearDB. +When using the **Deploy to Heroku** button you needn't worry about using a database as the install will setup a free instance of ClearDB. Once installed Heroku can direct you to the setup page where you'll configure the site/application information and create an administrator account. -## Configuring a database +# Configuring a database Cachet relies on a database to store the components and incidents, but by default the configuration is left with SQLite. This is great if you're not pushing the repository to Heroku, Dokku or other virtual containers as the information will be lost each time you push. @@ -131,6 +137,8 @@ Migrated: 2014_11_16_224937_CreateComponentsTable Migrated: 2014_11_17_144232_CreateSettingsTable ``` +# Running Cachet + ## Apache Apache is one of the easier installations. We simply need to create a new Virtual Host and add it to our `HOSTS` file. @@ -160,6 +168,10 @@ Next we add a lookup on our `HOSTS` file (if we're not serving Cachet externally Restart Apache and you're done! -## Environment Detection +## nginx + +**TODO.** + +# Environment Detection If you're deploying into production you'll want to create an environmental variable as `ENV=production`. In the instance where the variable isn't defined, Cachet will think that it's `local`.