Closes #1369 ### Changes - Adds improved getting started steps and intro contact information to the User Guide homepage - Adds a small section about the execution minutes graph for orgs with a quota set - Moves existing signup content to a dedicated signup page - Changes admonitions from using em dashes to using colons. - Em dashes are great and I love em.... But sometimes I love them a little _too_ much and they were a bad fit here. - Fixes user guide homepage link - Fixes `ReplayWeb.page` and `ArchiveWeb.page` names - Fixes broken links (would be good to have a CI system for this I think) --------- Co-authored-by: Emma Segal-Grossman <hi@emma.cafe> Co-authored-by: Tessa Walsh <tessa@bitarchivist.net> Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
34 lines
2.7 KiB
Markdown
34 lines
2.7 KiB
Markdown
# Browser Profiles
|
|
|
|
Browser profiles are saved instances of a web browsing session that can be reused to crawl websites as they were configured, with any cookies or saved login sessions. Using a pre-configured profile also means that content that can only be viewed by logged in users can be archived, without archiving the actual login credentials.
|
|
|
|
!!! tip "Best practice: Create and use web archiving-specific accounts for crawling with browser profiles"
|
|
|
|
For the following reasons, we recommend creating dedicated accounts for archiving anything that is locked behind login credentials but otherwise public, especially on social media platforms.
|
|
|
|
- While user names and passwords are not, the access tokens for logged in websites used in the browser profile creation process _are stored_ by the server.
|
|
|
|
- Some websites may rate limit or lock accounts for reasons they deem to be suspicious, such as logging in from a new location or any crawling-related activity.
|
|
|
|
- While login information (username, password) is not archived, *other* data such as cookies, location, etc.. may be included in the resulting crawl (after all, personalized content is often the goal of sites that require credentials to view content).
|
|
|
|
- Due to nature of social media specifically, existing accounts may have personally identifiable information, even when accessing otherwise public content.
|
|
|
|
Of course, there are exceptions — such as when the goal is to archive personalized or private content accessible only from designated accounts.
|
|
|
|
## Creating New Browser Profiles
|
|
|
|
New browser profiles can be created on the Browser Profiles page by pressing the _New Browser Profile_ button and providing a starting URL. Once in the profile creator, log in to any websites that should behave as logged in while crawling and accept any pop-ups that require interaction from the user to proceed with using the website.
|
|
|
|
Press the _Finish Browsing_ button to save the browser profile with a _Name_ and _Description_ of what is logged in or otherwise notable about this browser session.
|
|
|
|
## Editing Existing Browser Profiles
|
|
|
|
Sometimes websites will log users out or expire cookies after a period of time. In these cases, when crawling the browser profile can still be loaded but may not behave as it did when it was initially set up.
|
|
|
|
To update the profile, go to the profile's details page and press the _Edit Browser Profile_ button to load and interact with the sites that need to be re-configured. When finished, press the _Save Browser Profile_ button to return to the profile's details page.
|
|
|
|
### Editing Browser Profile Metadata
|
|
|
|
To edit a browser profile's name and description, select _Edit Name and Description_ from the actions menu on the profile's details page.
|