Go to file
Ilya Kreymer 829548af0f doc tweaks:
- fix typos in docs
- update prod deployment info
- update minikube info
- add info on how to run with local images
- bump version to 1.1.0-beta.3 for testing multiarch build
2022-12-05 18:14:19 -08:00
.github/workflows doc tweaks: 2022-12-05 18:14:19 -08:00
ansible
backend doc tweaks: 2022-12-05 18:14:19 -08:00
chart Local Deployment Work: Support running locally + test cluster on CI (#396) 2022-12-02 19:58:34 -08:00
configs
docs doc tweaks: 2022-12-05 18:14:19 -08:00
frontend doc tweaks: 2022-12-05 18:14:19 -08:00
scripts
test
.gitignore
docker-compose.yml
LICENSE
mkdocs.yml doc tweaks: 2022-12-05 18:14:19 -08:00
NOTICE
pylintrc
README.md mkdocs setup (deploy, dev, user-guide) (#375) 2022-12-05 16:41:37 -08:00
update-version.sh Release Build + Versioning (#373) 2022-11-18 17:15:25 -08:00
version.txt doc tweaks: 2022-12-05 18:14:19 -08: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.

The system is designed to run in both Kubernetes and Docker Swarm, as well as locally under Podman.

See Features for a high-level list of planned features.

Development Status

Browsertrix Cloud is currently in an early beta stage and not fully ready for production. This is an ambitious project and there's a lot to be done!

If you would like to help in a particular way, please open an issue or reach out to us in other ways.

Documentation

Docs are available at: https://docs.browsertrix.cloud/ created from the markdown in the ./docs on the main branch.

To build the documentation locally, install Material for MkDocs with pip:

pip install mkdocs-material

In the project root directory run mkdocs serve to run a local version of the documentation site.

License

Browsertrix Cloud is made available under the AGPLv3 License.

If you would like to use it under a different license or have a question, please reach out as that may be a possibility.