Installation - Cachet

Cachet v3.x is currently in development and not yet released. The following instructions cover development use only and are subject to change.

Prerequisites

Cachet v3.x runs on Laravel 11.35+, 12.x, or 13.x and requires:

PHP 8.3 or 8.4
Composer
SQLite, MySQL, MariaDB 10.7+, PostgreSQL, or SQL Server

Installing Cachet

If you are looking to migrate from Cachet v2.x, please refer to the migration guide.

Manual setup

Step 1

Clone the Cachet repository:

git clone -b 3.x https://github.com/cachethq/cachet.git
cd cachet

Step 2

Install the dependencies:

composer install --no-dev -o

Step 3

Update the cachethq/core dependency:

composer update cachethq/core

This is a temporary step until Cachet v3.x is released.

Step 4

Copy the .env.example file to .env:

cp .env.example .env

Step 5

Generate an application key:

php artisan key:generate

Step 6

Configure the .env file and set the values of your setup:

.env

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=cachet
DB_USERNAME=root
DB_PASSWORD=

Step 7

Publish Cachet’s assets:

php artisan vendor:publish --tag=cachet

Step 8

Run the database migrations:

php artisan migrate

Step 9

Create the first user by following the prompts:

php artisan cachet:make:user

Step 10

Enable the scheduler by adding the following cron entry:

/etc/crontab

* * * * * php /path/to/cachet/artisan schedule:run >> /dev/null 2>&1

Cachet uses the scheduler to send subscriber notifications for completed maintenance and long-running incidents.

Step 11

Run a queue worker to deliver email notifications:

php artisan queue:work

Cachet queues all subscriber emails. The default sync queue connection delivers them inline, but we recommend a dedicated queue worker in production. See the Laravel queue documentation for running workers with a process supervisor.

​Prerequisites

​Installing Cachet

Prerequisites

Installing Cachet