Skip to content

Commit

Permalink
Adds warning about crawling with basic auth (#669)
Browse files Browse the repository at this point in the history
Closes webrecorder/browsertrix#1950 over here
too

### Changes
- Adds a warning about using basic auth
- Adds a link to MDN because learning and cross referencing is fun!
  • Loading branch information
Shrinks99 authored Aug 15, 2024
1 parent 4cc67a3 commit 4c1da90
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/docs/user-guide/yaml-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,10 @@ seeds:

## HTTP Auth

Browsertrix Crawler supports HTTP Basic Auth, which can be provide on a per-seed basis as part of the URL, for example:
!!! warning "HTTP basic auth credentials are written to the archive"
We recommend exercising caution and only archiving with dedicated archival accounts, changing your password or deleting the account when finished.

Browsertrix Crawler supports [HTTP Basic Auth](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication), which can be provide on a per-seed basis as part of the URL, for example:
`--url https://username:[email protected]/`.

Alternatively, credentials can be added to the `auth` field for each seed:
Expand Down

0 comments on commit 4c1da90

Please sign in to comment.