Stowage/browsertrix-crawler
2
0
Fork 0
mirror of https://github.com/webrecorder/browsertrix-crawler.git synced 2025-10-19 14:33:17 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix docs mistaking --waitUntil with --pageLoadTimeout (#864)

Browse source 
Fixes https://github.com/webrecorder/browsertrix-crawler/issues/853

Corrects a documentation inaccuracy pointed out by a user
This commit is contained in:
Tessa Walsh 2025-07-21 15:52:58 -04:00 • committed by GitHub
parent 549d655173
commit acae5155f5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/docs/user-guide/behaviors.md
View file

@ -35,14 +35,15 @@ To disable all behaviors, use `--behaviors ""`.
## Behavior and Page Timeouts ## Behavior and Page Timeouts
Browsertrix includes a number of timeouts, including before, during and after running behaviors. Browsertrix includes a number of timeouts, including before, during and after running behaviors.
The timeouts are as follows: The timeouts are as follows:
- `--waitUntil`: how long to wait for page to finish loading, *before* doing anything else. - `--pageLoadTimeout`: how long to wait for page to finish loading, *before* doing anything else.
- `--postLoadDelay`: how long to wait *before* starting any behaviors, but after page has finished loading. A custom behavior can override this (see below). - `--postLoadDelay`: how long to wait *before* starting any behaviors, but after page has finished loading. A custom behavior can override this (see below).
- `--behaviorTimeout`: maximum time to spend on running site-specific / Autoscroll behaviors (can be less if behavior finishes early). - `--behaviorTimeout`: maximum time to spend on running site-specific / Autoscroll behaviors (can be less if behavior finishes early).
- `--pageExtraDelay`: how long to wait *after* finishing behaviors (or after `behaviorTimeout` has been reached) before moving on to next page. - `--pageExtraDelay`: how long to wait *after* finishing behaviors (or after `behaviorTimeout` has been reached) before moving on to next page.
A site-specific behavior (or Autoscroll) will start after the page is loaded (at most after `--waitUntil` seconds) and exactly after `--postLoadDelay` seconds. A site-specific behavior (or Autoscroll) will start after the page is loaded (at most after `--pageLoadTimeout` seconds) and exactly after `--postLoadDelay` seconds.
The behavior will then run until finished or at most until `--behaviorTimeout` is reached (90 seconds by default). The behavior will then run until finished or at most until `--behaviorTimeout` is reached (90 seconds by default).