b2d526f09a
Fixes #1463 ### Changes - Explains execution time - Adds style guide section about adding a badge for paid features - Updates config for mkdocs-material 9.5, materialx emoji support is being removed. - Adds better tooltips, a cool feature that also got released with mkdocs-material 9.5 - Adds search suggestions ### Caveats - [mkdocs 1.5 has improved the way they handle link validation](https://www.mkdocs.org/about/release-notes/#expanded-validation-of-links). Looks like way I've gone about linking things could be improved, and it will give a bunch of warnings as a result. The site still builds fine, but I'm going to fix this in a different PR so this one doesn't take as much effort to review :) EDIT: Here's that PR https://github.com/webrecorder/browsertrix-cloud/pull/1476 ### Testing - Make sure you are up to date with `pip install --upgrade mkdocs-material` ### Screenshot **Badge!** <img width="884" alt="Screenshot 2024-01-17 at 11 59 00 PM" src="https://github.com/webrecorder/browsertrix-cloud/assets/5672810/62a51cf6-24bd-49f1-a6d0-d335f730bfbe"> ### Future - Should mkdocs-material be versioned in our deployment script? We risk things breaking if I don't get to them fast enough! 🙃 --------- Co-authored-by: Tessa Walsh <tessa@bitarchivist.net> |
||
|---|---|---|
| .github | ||
| .vscode | ||
| ansible | ||
| backend | ||
| chart | ||
| configs | ||
| docs | ||
| frontend | ||
| scripts | ||
| test | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| btrix | ||
| CHANGES.md | ||
| LICENSE | ||
| mkdocs.yml | ||
| NOTICE | ||
| pylintrc | ||
| README.md | ||
| update-version.sh | ||
| version.txt | ||
| 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 Browsertrix Cloud for a feature overview and information about Browsertrix Cloud Hosting.
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