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

docs: regnerate cli options with ./docs/gen-cli.sh

Browse source
This commit is contained in:
Ilya Kreymer 2024-07-19 18:53:50 -07:00
parent 1099f4f3c8
commit 48716c172d
1 changed files with 12 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/docs/user-guide/cli-options.md
View file

@ -172,8 +172,8 @@ Options:
--warcInfo, --warcinfo Optional fields added to the warcinf --warcInfo, --warcinfo Optional fields added to the warcinf
o record in combined WARCs o record in combined WARCs
--redisStoreUrl If set, url for remote redis server --redisStoreUrl If set, url for remote redis server
to store state. Otherwise, using in- to store state. Otherwise, using loc
memory store al redis instance
[string] [default: "redis://localhost:6379/0"] [string] [default: "redis://localhost:6379/0"]
--saveState If the crawl state should be seriali --saveState If the crawl state should be seriali
zed to the crawls/ directory. Defaul zed to the crawls/ directory. Defaul
@ -252,14 +252,20 @@ Options:
--debugAccessRedis if set, runs internal redis without --debugAccessRedis if set, runs internal redis without
protected mode to allow external acc protected mode to allow external acc
ess (for debugging) [boolean] ess (for debugging) [boolean]
--debugAccessBrowser if set, allow debugging browser on p
ort 9222 via CDP [boolean]
--warcPrefix prefix for WARC files generated, inc --warcPrefix prefix for WARC files generated, inc
luding WARCs added to WACZ [string] luding WARCs added to WACZ [string]
--serviceWorker, --sw service worker handling: disabled, e --serviceWorker, --sw service worker handling: disabled, e
nabled, or disabled with custom prof nabled, or disabled with custom prof
ile ile
[choices: "disabled", "disabled-if-profile", "enabled"] [default: "disabled"] [choices: "disabled", "disabled-if-profile", "enabled"] [default: "disabled"]
--dryRun If true, no data is written to disk, --proxyServer if set, will use specified proxy ser
only logs [boolean] ver. Takes precedence over any env v
ar proxy settings [string]
--dryRun If true, no archive data is written
to disk, only pages and logs (and op
tionally saved state). [boolean]
--qaSource Required for QA mode. Source (WACZ o --qaSource Required for QA mode. Source (WACZ o
r multi WACZ) for QA [string] r multi WACZ) for QA [string]
--qaDebugImageDiff if specified, will write crawl.png, --qaDebugImageDiff if specified, will write crawl.png,
@ -296,7 +302,8 @@ Options:
er profile directory [string] er profile directory [string]
--windowSize Browser window dimensions, specified as: width,height --windowSize Browser window dimensions, specified as: width,height
[string] [default: "1360,1020"] [string] [default: "1360,1020"]
--proxy [boolean] [default: false] --proxyServer if set, will use specified proxy server. Takes precedence o
ver any env var proxy settings [string]
--cookieDays If >0, set all cookies, including session cookies, to have --cookieDays If >0, set all cookies, including session cookies, to have
this duration in days before saving profile this duration in days before saving profile
[number] [default: 7] [number] [default: 7]