Go to file
Tessa Walsh 9c7a312a4c
Rework collections to track collections in Crawl (#878)
* Track collections in Crawl rather than crawls in Collection
* Add delete collection API endpoint and tests
* Precompute collection crawlCount, pageCount, and tags and add them to
GET collection responses
* Add modified field to Collection
* Update collection replay.json method
* Make add and remove crawls accept list of crawl ids
* Auto-add new workflow crawls to collections when they successfully
complete via CrawlConfig.autoAddCollections field
* Move long-running post-crawl operator tasks into asyncio task
* Make CrawlConfig.autoAddCollections updatable via /update API endpoint
2023-05-25 15:41:50 -04:00
.github tests: fixes for crawl cancel + crawl stopped (#864) 2023-05-22 20:17:29 -07:00
ansible add authsign block to microk8s playbook (#776) 2023-05-05 11:32:32 -07:00
backend Rework collections to track collections in Crawl (#878) 2023-05-25 15:41:50 -04:00
chart tests: fixes for crawl cancel + crawl stopped (#864) 2023-05-22 20:17:29 -07:00
configs Remove Code and Configs for Swarm/podman support (#407) 2022-12-08 18:19:58 -08:00
docs Update backend local development docs (#884) 2023-05-25 09:50:56 -07:00
frontend Show org creation form if there are no orgs (#883) 2023-05-24 13:10:12 -07:00
scripts Fix doc to build a local image for microk8s (#594) 2023-02-14 16:10:04 -08:00
test Single config and env vars (#267) 2022-06-16 21:50:03 -07:00
.gitignore Make btrix helper work with microk8s (#768) 2023-04-18 08:50:46 -04:00
.pre-commit-config.yaml Rename archives/teams -> orgs in codebase + add db migration (#486) 2023-01-18 14:51:04 -08:00
btrix Add current context and confirmation dialog to reset/bootstrap methods (#887) 2023-05-25 13:43:53 -04:00
CHANGES.md version: bump to 1.3.0 2023-02-24 18:07:56 -08:00
LICENSE
mkdocs.yml Update backend local development docs (#884) 2023-05-25 09:50:56 -07:00
NOTICE
pylintrc
README.md docs: fix link to dev docs 2023-05-24 10:59:41 -07:00
update-version.sh Release Build + Versioning (#373) 2022-11-18 17:15:25 -08:00
version.txt version: bump to 1.6.0-beta.0 2023-05-19 11:29:31 -07:00

Browsertrix Cloud

Browsertrix Cloud 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 Features for a high-level list of planned features.

Documentation

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

Deployment

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

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

Previously, Browsertrix Cloud also supported Docker Compose and podman-based deployment. This is now 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 Cloud 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 Cloud 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.cloud/develop

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

License

Browsertrix Cloud is made available under the AGPLv3 License.

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