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
To migrate from Cachet v2.x, read the migration guide first. The migration path is incomplete.- Manual setup
1
Clone Cachet
Clone the Cachet repository:
2
Install dependencies
Install the dependencies:
3
Update the core package
Update the
cachethq/core dependency:This is a temporary step until Cachet v3.x is released.
4
Set storage permissions
Give the user running your web server write access to Cachet’s
storage directory. Cachet uses this
directory for logs, cached files, sessions, and other runtime data.5
Create the environment file
Copy the
.env.example file to .env:6
Generate an application key
Generate an application key:
7
Configure the database
Set the database connection values in
.env to match your setup:.env
8
Publish assets
Publish Cachet’s assets:
9
Run migrations
Run the database migrations:
10
Create your first user
Run this command, then follow the prompts to create the first user:
11
Enable the scheduler
Enable the scheduler by adding the following cron entry:Cachet uses the scheduler to send subscriber notifications for completed maintenance and long-running incidents.
/etc/crontab
12
Run a queue worker
Run a queue worker to deliver email notifications:
Cachet queues all subscriber emails. The default
sync queue connection delivers them during the request. For production, use a dedicated queue worker. See the Laravel queue documentation to run workers with a process supervisor.