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

​
Prerequisites

Cachet v3.x is written in PHP with Laravel 11.x and requires:

  • PHP 8.2, 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.

1

Step 1

Clone the Cachet repository:

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

Step 2

Install the dependencies:

composer install --no-dev -o
3

Step 3

Update the cachethq/core dependency:

composer update cachethq/core

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

4

Step 4

Copy the .env.example file to .env:

cp .env.example .env
5

Step 5

Generate an application key:

php artisan key:generate
6

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=
7

Step 7

Publish Cachet’s assets:

php artisan vendor:publish --tag=cachet
8

Step 8

Run the database migrations:

php artisan migrate
9

Step 9

Create the first user by following the prompts:

php artisan cachet:make:user
10

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 v3.x is currently in development and not yet released. The following instructions are intended for development purposes only and are subject to change.

​
Prerequisites

Cachet v3.x is written in PHP with Laravel 11.x and requires:

  • PHP 8.2, 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.

1

Step 1

Clone the Cachet repository:

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

Step 2

Install the dependencies:

composer install --no-dev -o
3

Step 3

Update the cachethq/core dependency:

composer update cachethq/core

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

4

Step 4

Copy the .env.example file to .env:

cp .env.example .env
5

Step 5

Generate an application key:

php artisan key:generate
6

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=
7

Step 7

Publish Cachet’s assets:

php artisan vendor:publish --tag=cachet
8

Step 8

Run the database migrations:

php artisan migrate
9

Step 9

Create the first user by following the prompts:

php artisan cachet:make:user
10

Step 10

Enable the scheduler by adding the following cron entry:

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