Skip to content

Commit d8ea42e

Browse files
committed
Update Readme
1 parent ade398f commit d8ea42e

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -299,3 +299,46 @@ Example configuration showcasing all available monitor types:
299299
| `expectedValue` | any | Expected value (json only) |
300300
| `recordType` | string | DNS record type (dns only) |
301301
| `expectedIp` | string | Expected IP (dns only) |
302+
303+
## Monitor Check Frequency
304+
305+
By default, the GitHub Actions workflow runs every **30 minutes**. This is because GitHub Actions scheduled workflows can be delayed during high load periods, making intervals shorter than 30 minutes unreliable.
306+
307+
### Setting Up 5-Minute Checks with cron-job.org
308+
309+
For more frequent monitoring, use a free external cron service like [cron-job.org](https://cron-job.org) to trigger the workflow via GitHub's API.
310+
311+
#### 1. Create a GitHub Personal Access Token
312+
313+
1. Go to **GitHub → Settings → Developer settings → Personal access tokens → Fine-grained tokens**
314+
2. Click **Generate new token**
315+
3. Set **Repository access** to "Only select repositories" and choose your ShadowStatus repo
316+
4. Under **Permissions**, grant **Actions** read and write access
317+
5. Generate and copy the token
318+
319+
#### 2. Configure cron-job.org
320+
321+
1. Create a free account at [cron-job.org](https://cron-job.org)
322+
2. Create a new cron job with these settings:
323+
324+
| Setting | Value |
325+
| ------------------ | ------------------------------------------------------------------------------------------------------ |
326+
| **URL** | `https://api.github.com/repos/YOUR_USERNAME/YOUR_REPO/actions/workflows/monitor-checks.yml/dispatches` |
327+
| **Schedule** | Every 5 minutes |
328+
| **Request Method** | POST |
329+
330+
3. Add these **Headers**:
331+
332+
```
333+
Authorization: Bearer YOUR_GITHUB_TOKEN
334+
Accept: application/vnd.github+v3+json
335+
Content-Type: application/json
336+
```
337+
338+
4. Set the **Request Body**:
339+
340+
```json
341+
{ "ref": "main" }
342+
```
343+
344+
The GitHub Actions workflow will continue running every 30 minutes as a fallback in case the external cron service fails

0 commit comments

Comments
 (0)