Skip to content

Commit 20fbe1f

Browse files
committed
Add beacon cron instructions
1 parent 9a53dc4 commit 20fbe1f

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

v3.x/configuration/beacon.mdx

+13
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,19 @@ CACHET_BEACON=true
1919
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`.
2020
</Tip>
2121

22+
### Configuring the scheduler
23+
24+
Cachet automatically registers the `cachet:beacon` command to run daily at `00:00`. You will need to configure your server
25+
to run the scheduler every minute using a cron job. To do so, you can do this by adding the following cron entry:
26+
27+
```bash /etc/crontab
28+
* * * * * php /path/to/cachet/artisan schedule:run >> /dev/null 2>&1
29+
```
30+
31+
<Note>
32+
Be sure to replace `/path/to/cachet` with the actual path to your Cachet installation.
33+
</Note>
34+
2235
## What data is collected?
2336

2437
- **Install ID**: An anonymous identifier for your Cachet installation.

v3.x/installation.mdx

+6-2
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,6 @@ If you are looking to migrate from Cachet v2.x, please refer to the [migration g
5858
<Step title="Step 6">
5959
Configure the `.env` file and set the values of your setup:
6060
```ini .env
61-
CACHET_PATH=/
62-
6361
DB_CONNECTION=mysql
6462
DB_HOST=127.0.0.1
6563
DB_PORT=3306
@@ -80,4 +78,10 @@ If you are looking to migrate from Cachet v2.x, please refer to the [migration g
8078
php artisan migrate
8179
```
8280
</Step>
81+
<Step title="Step 9">
82+
Enable the scheduler by adding the following cron entry:
83+
```bash /etc/crontab
84+
* * * * * php /path/to/cachet/artisan schedule:run >> /dev/null 2>&1
85+
```
86+
</Step>
8387
</Steps>

0 commit comments

Comments
 (0)