probablycorey/workshop
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

better docs

Browse Source
This commit is contained in:
Corey Johnson 2025-07-25 14:39:14 -07:00
parent 3abadc3b51
commit 4d7041f2b1
1 changed files with 13 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
packages/http/README.md
View File

@ -13,31 +13,20 @@ A proxy server that will start all subdomain servers and a proxy server to route
In your package's `package.json`, add a script that starts with `cron:` followed by the cron schedule.
```
Every minute: `"cron:constantly": "your-script-goes-here"`
Every hour: `"cron:hourly": "your-script-goes-here"`
Every day: `"cron:daily": "your-script-goes-here"` // Runs at midnight
Every week: `"cron:weekly": "your-script-goes-here"` // Runs on Sunday
Every month: `"cron:monthly": "your-script-goes-here"` // Runs on the 1st
```
If you want to run a script at a specific time, you can use the following format:
**ALL TIMES ARE IN UTC!!!**
**ALL TIMES USE THE 24 HOUR FORMAT!!!**
```
cron:hourly@0:25": "your-script-goes-here" // The hour is ignored
cron:daily@1:20": "your-script-goes-here" // This is at 1:20 AM UTC for 1:20 PM use 13:20
cron:weekly@12:00": "your-script-goes-here"
cron:monthly@13:00": "your-script-goes-here"
```
| Script Name | Description |
| --------------------- | ---------------------------------------------------------------------------------- |
| `cron:constantly` | Runs every minute |
| `cron:hourly` | Runs every hour |
| `cron:daily` | Runs at midnight |
| `cron:weekly` | Runs on Sunday |
| `cron:monthly` | Runs on the 1st of month |
| `cron:hourly@0:25` | Runs every hour at 25 minutes past the hour (the hour is ignored) |
| `cron:daily@1:20` | Runs daily at 1:20 AM UTC |
| `cron:weekly@12:00` | Runs weekly on Sunday at 12:00 PM UTC |
| `cron:monthly@13:00` | Runs monthly on the 1st at 1:00 PM UTC |
| `cron:daily #comment` | If you need multiple crons with the same schedule, make them unique with a comment |
What happens if you have two scripts with the same cron schedule?
```
cron:daily": "your-script-goes-here"
cron:daily #comment": "your-script-goes-here" // Everything after # is ignored so you can use this to make cron jobs unique or more readable
```
You can view the cron job status at http://theworkshop.cc
You can view all the cron job statuses at http://theworkshop.cc