Skip to content

Document custom image upload settings #29

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 22, 2026
+15 −1
Merged

Document custom image upload settings #29

Show file tree
Hide file tree
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
10 changes: 10 additions & 0 deletions v3.x/configuration/environment.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@ and served, rather than the content of your status page.
| `CACHET_BEACON` | `true` | Whether Cachet sends anonymous [telemetry](/v3.x/configuration/beacon). Set to `false` to opt out. |
| `CACHET_SETTINGS_CACHE` | `true` | Cache Cachet's settings instead of reading them from the database on every request. |

## Image uploads

These variables control custom images uploaded from the Cachet dashboard:

| Variable | Default | Description |
| --- | --- | --- |
| `CACHET_UPLOAD_DISK` | `public` | The Laravel filesystem disk used to store and load custom images. Existing images must be moved when changing disks. |
| `CACHET_UPLOAD_MAX_SIZE` | `1024` | The maximum image upload size in kilobytes. |
| `CACHET_UPLOAD_IMAGE_MIME_TYPES` | `image/jpeg,image/png,image/gif,image/webp` | Comma-separated list of accepted image MIME types. |

## Maintenance & retention

| Variable | Default | Description |
Expand Down
6 changes: 5 additions & 1 deletion v3.x/configuration/theme.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ To override the default banner image shown at the top of your status page, uploa
We recommend using an image with a 16:9 aspect ratio for the best results.
</Tip>

The uploaded image is also embedded in outgoing Cachet emails as the application logo. Cachet accepts JPEG, PNG, GIF,
and WebP images up to 1 MB by default. You can change the storage disk, maximum upload size, and accepted image types
with the [image upload environment variables](/v3.x/configuration/environment#image-uploads).

Once you've uploaded your image, click the "Save" button to apply the changes.
By default, Cachet stores images in `/storage/app/public`. To make the image accessible to the public, you'll need to run the following command:

Expand Down Expand Up @@ -73,4 +77,4 @@ You can disable "Accent Pairing" and select your own background color from a lis
### Custom colors

To customize Cachet to your liking, we recommend using the [Customization](/v3.x/configuration/customization) panel and
configuring your own colors with CSS.
configuring your own colors with CSS.
Loading