Go to file
Ilya Kreymer 989ed2a8da
Use Shared Services for Crawling, Redis, Profile Browsers (#1088)
* refactor to use shared role-based service shared across pods:
- 'crawler' service for all crawler screencasting, scales 0 .. N with crawler-<ID>-N.crawl
- 'redis' service for all redis access, redis-<ID>-0.redis
- 'browser' service for all browser access (profile browsers), browser-<ID>-0.browser
- don't create a new service per crawl/profile at all
- enable 'publishNotReadyAddresses' for potentially faster resolving, esp for redis
- remove service as type managed by operator as no longer creating services dynamically
- remove frontend var CRAWLER_SVC_SUFFIX, suffix always '.crawler' to match crawler service name
2023-08-24 20:08:53 -07:00
.github dev: Adds GitHub feature issue template (#1087) 2023-08-21 15:27:45 -07:00
.vscode Add MkDocs YAML schema to vscode settings.json (#1075) 2023-08-15 12:06:05 -07:00
ansible feat: create DO registry if it doesn't exist (#947) 2023-07-26 15:41:03 -07:00
backend Use Shared Services for Crawling, Redis, Profile Browsers (#1088) 2023-08-24 20:08:53 -07:00
chart Use Shared Services for Crawling, Redis, Profile Browsers (#1088) 2023-08-24 20:08:53 -07:00
configs
docs docs: formatting fixes & minor content updates (#1091) 2023-08-21 13:26:43 -07:00
frontend Use Shared Services for Crawling, Redis, Profile Browsers (#1088) 2023-08-24 20:08:53 -07:00
scripts fix: password check constructor error (#1077) 2023-08-15 12:00:13 -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
btrix fix: usr/bin/env bash interpreter for btrix (#1028) 2023-08-01 09:28:56 -07:00
CHANGES.md
LICENSE
mkdocs.yml docs: Adds information about 1.6 features to documentation (#1086) 2023-08-18 21:55:20 -07:00
NOTICE
pylintrc
README.md
update-version.sh fix(build): use /usr/bin/env bash instead of /bin/bash (#1020) 2023-07-28 21:50:04 -07:00
version.txt bump version to 1.7.0-beta.0 2023-08-23 12:03:45 -07:00
yarn.lock

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