Skip to main content
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 12.41.1+ or 13.x and requires:
  • PHP 8.3, 8.4, or 8.5
  • 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.
1

Step 1

Clone the Cachet repository:
2

Step 2

Install the dependencies:
3

Step 3

Update the cachethq/core dependency:
This is a temporary step until Cachet v3.x is released.
4

Step 4

Ensure the user running your web server can write to Cachet’s storage directory. Cachet uses this directory for logs, cached files, sessions, and other runtime data.
5

Step 5

Copy the .env.example file to .env:
6

Step 6

Generate an application key:
7

Step 7

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

Step 8

Publish Cachet’s assets:
9

Step 9

Run the database migrations:
10

Step 10

Create the first user by following the prompts:
11

Step 11

Enable the scheduler by adding the following cron entry:
/etc/crontab
Cachet uses the scheduler to send subscriber notifications for completed maintenance and long-running incidents.
12

Step 12

Run a queue worker to deliver email notifications:
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.