browsertrix/docs/user-guide
Vinzenz Sinapius bb6e703f6a
Configure browsertrix proxies (#1847)
Resolves #1354

Supports crawling through pre-configured proxy servers, allowing users to select which proxy servers to use (requires browsertrix crawler 1.3+)

Config:
- proxies defined in btrix-proxies subchart
- can be configured via btrix-proxies key or separate proxies.yaml file via separate subchart
- proxies list refreshed automatically if crawler_proxies.json changes if subchart is deployed
- support for ssh and socks5 proxies
- proxy keys added to secrets in subchart
- support for default proxy to be always used if no other proxy configured, prevent starting cluster if default proxy not available
- prevent starting manual crawl if previously configured proxy is no longer available, return error
- force 'btrix' username and group name on browsertrix-crawler non-root user to support ssh

Operator:
- support crawling through proxies, pass proxyId in CrawlJob
- support running profile browsers which designated proxy, pass proxyId to ProfileJob
- prevent starting scheduled crawl if previously configured proxy is no longer available

API / Access:
- /api/orgs/all/crawlconfigs/crawler-proxies - get all proxies (superadmin only)
- /api/orgs/{oid}/crawlconfigs/crawler-proxies - get proxies available to particular org
- /api/orgs/{oid}/proxies - update allowed proxies for particular org (superadmin only)
- superadmin can configure which orgs can use which proxies, stored on the org
- superadmin can also allow an org to access all 'shared' proxies, to avoid having to allow a shared proxy on each org.

UI:
- Superadmin has 'Edit Proxies' dialog to configure for each org if it has: dedicated proxies, has access to shared proxies.
- User can select a proxy in Crawl Workflow browser settings
- Users can choose to launch a browser profile with a particular proxy
- Display which proxy is used to create profile in profile selector
- Users can choose with default proxy to use for new workflows in Crawling Defaults

---------
Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
Co-authored-by: Tessa Walsh <tessa@bitarchivist.net>
2024-10-02 18:35:45 -07:00
..
archived-items.md feat: Display scale as number of browser windows (#2057) 2024-09-05 17:32:40 -07:00
browser-profiles.md docs: Reorganize user guide (#2050) 2024-08-28 09:50:42 -07:00
collection.md fix: Fix collection description (#2065) 2024-09-05 22:10:14 -07:00
collections.md docs: Reorganize user guide (#2050) 2024-08-28 09:50:42 -07:00
contribute.md docs: Reorganize user guide (#2050) 2024-08-28 09:50:42 -07:00
crawl-workflows.md feat: Merge workflow job types (#2068) 2024-09-25 10:37:18 -04:00
getting-started.md feat: Merge workflow job types (#2068) 2024-09-25 10:37:18 -04:00
index.md docs: Clarify hosted vs. self-deployment requirements (#2082) 2024-09-18 13:43:09 -07:00
join.md docs: Reorganize user guide (#2050) 2024-08-28 09:50:42 -07:00
org-members.md docs: Reorganize user guide (#2050) 2024-08-28 09:50:42 -07:00
org-settings.md feat: Allow org admins to set default workflow configs (#2020) 2024-08-29 16:49:22 -07:00
org.md docs: Reorganize user guide (#2050) 2024-08-28 09:50:42 -07:00
overview.md feat: Display scale as number of browser windows (#2057) 2024-09-05 17:32:40 -07:00
review.md docs: Reorganize user guide (#2050) 2024-08-28 09:50:42 -07:00
running-crawl.md feat: Merge workflow job types (#2068) 2024-09-25 10:37:18 -04:00
signup.md docs: Reorganize user guide (#2050) 2024-08-28 09:50:42 -07:00
user-settings.md docs: Reorganize user guide (#2050) 2024-08-28 09:50:42 -07:00
workflow-setup.md Configure browsertrix proxies (#1847) 2024-10-02 18:35:45 -07:00