a74d88dcda
* Initial docs move * Setup mkdocs * Adds instructions for building docs * add new deployment docs, local and prod * set up three sections: deployment, dev and user guide * remove old deployment docs * ci: mkdocs gh-pages publish Co-authored-by: sua yoo <sua@suayoo.com> Co-authored-by: Ilya Kreymer <ikreymer@gmail.com> |
||
|---|---|---|
| .github/workflows | ||
| ansible | ||
| backend | ||
| chart | ||
| configs | ||
| docs | ||
| frontend | ||
| scripts | ||
| test | ||
| .gitignore | ||
| docker-compose.yml | ||
| LICENSE | ||
| mkdocs.yml | ||
| NOTICE | ||
| pylintrc | ||
| README.md | ||
| update-version.sh | ||
| version.txt | ||
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.