Go to file
Tessa Walsh d38abbca7f
Standardize handling of storage and execution time quotas (#1969)
Fixes #1968 

Changes:
- `stopped_quota_reached` and `skipped_quota_reached` migrated to new
values that indicate which quota was reached
- Before crawls are run, the operator checks if storage or exec mins
quotas are reached and if so fails the crawl with the appropriate state
of `skipped_storage_quota_reached` or `skipped_time_quota_reached`
- While crawls are running, the operator checks if the exec mins quota
is reached or if the size of all running crawls will mean the storage
quota is reached once uploaded; if so, the crawl is stopped gracefully
and given `stopped_storage_quota_needed` or `stopped_time_quota_reached`
state as appropriate
- Adds new nightly tests for enforcing storage quota
2024-07-25 12:49:11 -07:00
.github quickfix: pin mypy version to avoid issues with latest release 2024-07-19 18:30:57 -07:00
.vscode Initial QA Review UI! (#1624) 2024-04-04 15:09:52 -07:00
ansible Add Repository Index + Chart Rename + Docs Rename (#1708) 2024-04-21 09:42:25 -07:00
assets Frontend: App Branding! (#1592) 2024-04-17 23:40:02 -04:00
backend Standardize handling of storage and execution time quotas (#1969) 2024-07-25 12:49:11 -07:00
chart disable behaviors for QA runs via configmap (#1963) 2024-07-23 19:54:21 -07:00
configs
docs Add superuser API endpoints to export and import org data (#1394) 2024-07-02 17:14:34 -04:00
frontend Standardize handling of storage and execution time quotas (#1969) 2024-07-25 12:49:11 -07:00
scripts Add Repository Index + Chart Rename + Docs Rename (#1708) 2024-04-21 09:42:25 -07:00
test fix(build): use /usr/bin/env bash instead of /bin/bash (#1020) 2023-07-28 21:50:04 -07:00
.gitignore
.pre-commit-config.yaml Add Repository Index + Chart Rename + Docs Rename (#1708) 2024-04-21 09:42:25 -07:00
btrix Add Repository Index + Chart Rename + Docs Rename (#1708) 2024-04-21 09:42:25 -07:00
CHANGES.md
LICENSE
mkdocs.yml Add superuser API endpoints to export and import org data (#1394) 2024-07-02 17:14:34 -04:00
NOTICE Add Repository Index + Chart Rename + Docs Rename (#1708) 2024-04-21 09:42:25 -07:00
pylintrc
README.md Add Repository Index + Chart Rename + Docs Rename (#1708) 2024-04-21 09:42:25 -07:00
update-version.sh enable screenshots by default + fix py version formatting (#1518) 2024-02-07 17:07:28 -08:00
version.txt version: bump to 1.11.0-beta.1 2024-07-17 10:06:49 -07:00
yarn.lock Frontend collections beta UI (#886) 2023-06-06 17:52:01 -07:00

Browsertrix

 

Browsertrix is an open-source cloud-native high-fidelity browser-based crawling service designed to make web archiving easier and more accessible for everyone.

The service provides an API and UI for scheduling crawls and viewing results, and managing all aspects of crawling process. This system provides the orchestration and management around crawling, while the actual crawling is performed using Browsertrix Crawler containers, which are launched for each crawl.

See browsertrix.com for a feature overview and information about Browsertrix hosting.

Documentation

The full docs for using, deploying, and developing Browsertrix are available at: https://docs.browsertrix.com

Deployment

The latest deployment documentation is available at: https://docs.browsertrix.com/deploy

The docs cover deploying Browsertrix in different environments using Kubernetes, from a single-node setup to scalable clusters in the cloud.

Previously, Browsertrix also supported Docker Compose and podman-based deployment. This has been deprecated due to the complexity of maintaining feature parity across different setups, and with various Kubernetes deployment options being available and easy to deploy, even on a single machine.

Making deployment of Browsertrix as easy as possible remains a key goal, and we welcome suggestions for how we can further improve our Kubernetes deployment options.

If you are looking to just try running a single crawl, you may want to try Browsertrix Crawler first to test out the crawling capabilities.

Development Status

Browsertrix is currently in a beta, though the system and backend API is fairly stable, we are working on many additional features.

Additional developer documentation is available at https://docs.browsertrix.com/develop

Please see the GitHub issues and this GitHub Project for our current project plan and tasks.

License

Browsertrix is made available under the AGPLv3 License.

Documentation is made available under the Creative Commons Attribution 4.0 International License