Skip to content

Document storage directory permissions #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jbrooksuk merged 1 commit into from
Aug 14, 2026
+11 −7
Merged

Document storage directory permissions #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions v3.x/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,22 @@ If you are looking to migrate from Cachet v2.x, please refer to the [migration g
</Note>
</Step>
<Step title="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.
Comment on lines +49 to +50

@chatgpt-codex-connector chatgpt-codex-connector Bot Aug 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Grant storage access to every Cachet process user

On deployments where nginx and PHP-FPM run under different accounts, granting access to the web-server user does not let the PHP process write Cachet's runtime data; the scheduler and dedicated queue worker documented below can likewise run as separate users. Specify that the PHP-FPM/application, scheduler, and queue-worker users must all have appropriate access to storage, otherwise these supported configurations can still fail with permission errors.

Useful? React with 👍 / 👎.

</Step>
<Step title="Step 5">
Copy the `.env.example` file to `.env`:
```bash
cp .env.example .env
```
</Step>
<Step title="Step 5">
<Step title="Step 6">
Generate an application key:
```bash
php artisan key:generate
```
</Step>
<Step title="Step 6">
<Step title="Step 7">
Configure the `.env` file and set the values of your setup:
```ini .env
DB_CONNECTION=mysql
Expand All @@ -68,33 +72,33 @@ If you are looking to migrate from Cachet v2.x, please refer to the [migration g
DB_PASSWORD=
```
</Step>
<Step title="Step 7">
<Step title="Step 8">
Publish Cachet's assets:
```bash
php artisan vendor:publish --tag=cachet
```
</Step>
<Step title="Step 8">
<Step title="Step 9">
Run the database migrations:
```bash
php artisan migrate
```
</Step>
<Step title="Step 9">
<Step title="Step 10">
Create the first user by following the prompts:
```bash
php artisan cachet:make:user
```
</Step>
<Step title="Step 10">
<Step title="Step 11">
Enable the scheduler by adding the following cron entry:
```bash /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>
<Step title="Step 11">
<Step title="Step 12">
Run a queue worker to deliver email notifications:
```bash
php artisan queue:work
Expand Down
Loading