Skip to content

Commit

Permalink
Add beacon cron instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jbrooksuk committed Jan 3, 2025
1 parent 9a53dc4 commit 20fbe1f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
13 changes: 13 additions & 0 deletions v3.x/configuration/beacon.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,19 @@ CACHET_BEACON=true
If you're limiting outbound requests on your server and you'd like to opt into the beacon, you'll need to allow outbound requests to `https://cachethq.io`.
</Tip>

### Configuring the scheduler

Cachet automatically registers the `cachet:beacon` command to run daily at `00:00`. You will need to configure your server
to run the scheduler every minute using a cron job. To do so, you can do this by adding the following cron entry:

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

<Note>
Be sure to replace `/path/to/cachet` with the actual path to your Cachet installation.
</Note>

## What data is collected?

- **Install ID**: An anonymous identifier for your Cachet installation.
Expand Down
8 changes: 6 additions & 2 deletions v3.x/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,6 @@ If you are looking to migrate from Cachet v2.x, please refer to the [migration g
<Step title="Step 6">
Configure the `.env` file and set the values of your setup:
```ini .env
CACHET_PATH=/

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
Expand All @@ -80,4 +78,10 @@ If you are looking to migrate from Cachet v2.x, please refer to the [migration g
php artisan migrate
```
</Step>
<Step title="Step 9">
Enable the scheduler by adding the following cron entry:
```bash /etc/crontab
* * * * * php /path/to/cachet/artisan schedule:run >> /dev/null 2>&1
```
</Step>
</Steps>

0 comments on commit 20fbe1f

Please # to comment.