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

Make it clear that profile argument can be an HTTP(S) URL (#649)

Browse source 
Small documentation enhancement to make it clear that browser profile
can be passed as HTTP(S) URL as well.
This commit is contained in:
benoit74 2024-07-20 03:53:28 +02:00 • committed by GitHub
parent 88a2fbd0a0
commit 1099f4f3c8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/docs/user-guide/browser-profiles.md
View file

@ -76,7 +76,7 @@ The profile creation script attempts to detect the username and password fields
## Using Browser Profile with a Crawl
To use a previously created profile with a crawl, use the `--profile` flag or `profile` option. The `--profile` flag can then be used to specify any Brave Browser profile stored as a tarball. Using profiles created with same or older version of Browsertrix Crawler is recommended to ensure compatibility. This option allows running a crawl with the browser already pre-configured, logged in to certain sites, language settings configured, etc.
To use a previously created profile with a crawl, use the `--profile` flag or `profile` option. The `--profile` flag can then be used to specify any Brave Browser profile stored as a tarball. Browser profile can be either stored locally and provided as a path, or available online at any HTTP(S) URL which will be downloaded before starting the crawl. Using profiles created with same or older version of Browsertrix Crawler is recommended to ensure compatibility. This option allows running a crawl with the browser already pre-configured, logged in to certain sites, language settings configured, etc.
After running the above command, you can now run a crawl with the profile, as follows:

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

@ -155,9 +155,9 @@ Options:
[number] [default: 0]
--dedupPolicy Deduplication policy
[string] [choices: "skip", "revisit", "keep"] [default: "skip"]
--profile Path to tar.gz file which will be ex
tracted and used as the browser prof
ile [string]
--profile Path or HTTP(S) URL to tar.gz file w
hich contains the browser profile di
rectory [string]
--screenshot Screenshot options for crawler, can
include: view, thumbnail, fullPage
[array] [choices: "view", "thumbnail", "fullPage"] [default: []]
@ -292,8 +292,8 @@ Options:
[boolean] [default: false]
--shutdownWait Shutdown browser in interactive after this many seconds, if
no pings received [number] [default: 0]
--profile Path to tar.gz file which will be extracted and used as the
browser profile [string]
--profile Path or HTTP(S) URL to tar.gz file which contains the brows
er profile directory [string]
--windowSize Browser window dimensions, specified as: width,height
[string] [default: "1360,1020"]
--proxy [boolean] [default: false]