mirror/archivebox
1
0
Fork 0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-08-28 16:50:01 +02:00
Code Issues Releases Wiki Activity

Updated Scheduled Archiving (markdown)

Nick Sweeting
2024-01-04 12:58:50 -08:00
parent 0ed4ce4d66
commit ab207a2c7f
1 changed files with 17 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
Scheduled-Archiving.md

@@ -4,25 +4,29 @@ ArchiveBox contains a built-in scheduler that supports pulling in URLs regularly
```bash ```bash
$ archivebox schedule --help $ archivebox schedule --help
[i] [2024-01-04 20:58:15] ArchiveBox v0.7.2: archivebox schedule --help
> ~/ArchiveBox/data
usage: archivebox schedule [-h] [--quiet] [--add] [--every EVERY] [--depth {0,1}] [--overwrite] [--clear] [--show] [--foreground] [--run-all] [import_path] usage: archivebox schedule [-h] [--quiet] [--add] [--every EVERY] [--tag TAG] [--depth {0,1}] [--overwrite] [--update] [--clear] [--show] [--foreground] [--run-all] [import_path]
Set ArchiveBox to regularly import URLs at specific times using cron Set ArchiveBox to regularly import URLs at specific times using cron
positional arguments: positional arguments:
import_path Check this path and import any new links on every run (can be either local file or remote URL) import_path Check this path and import any new links on every run (can be either local file or remote URL)
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--quiet, -q Dont warn about storage space. --quiet, -q Don't warn about storage space.
--add Add a new scheduled ArchiveBox update job to cron --add Add a new scheduled ArchiveBox update job to cron
--every EVERY Run ArchiveBox once every [timeperiod] (hour/day/month/year or cron format e.g. "0 0 * * *") --every EVERY Run ArchiveBox once every [timeperiod] (hour/day/month/year or cron format e.g. "0 0 * * *")
--depth {0,1} Depth to archive to [0] or 1, see "add" command help for more info --tag TAG, -t TAG Tag the added URLs with the provided tags e.g. --tag=tag1,tag2,tag3
--overwrite Re-archive any URLs that have been previously archived, overwriting existing Snapshots --depth {0,1} Depth to archive to [0] or 1, see "add" command help for more info
--clear Stop all ArchiveBox scheduled runs (remove cron jobs) --overwrite Re-archive any URLs that have been previously archived, overwriting existing Snapshots
--show Print a list of currently active ArchiveBox cron jobs --update Re-pull any URLs that have been previously added, as needed to fill missing ArchiveResults
--foreground, -f Launch ArchiveBox scheduler as a long-running foreground task instead of using cron. --clear Stop all ArchiveBox scheduled runs (remove cron jobs)
--run-all Run all the scheduled jobs once immediately, independent of their configured schedules, can be used together with --foreground --show Print a list of currently active ArchiveBox cron jobs
--foreground, -f Launch ArchiveBox scheduler as a long-running foreground task instead of using cron.
--run-all Run all the scheduled jobs once immediately, independent of their configured schedules, can be used together with --foreground
``` ```
ArchiveBox ignores links that are imported multiple times (keeping the earliest version that it's seen). ArchiveBox ignores links that are imported multiple times (keeping the earliest version that it's seen).