fa194c3d0d
Partially addresses #1241 ### Changes - Adds Browsertrix logo to readme - It detects if you're in light or dark mode and adjusts the text color accordingly! _The future is now!_ - Minor readme updates - Updates icon and adds favicon SVGs to the docs - This does not yet use Konsole for the docs site title. Will have to sort this out later along with private hosting for that font. - Updates docs theme to use new brand colours — picked the green for this one, will probably be consistent across all of Webrecorder's MKDocs sites.
2.4 KiB
Browsertrix 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.com for a feature overview and information about Browsertrix hosting.
Documentation
The full docs for using, deploying, and developing Browsertrix 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 in different environments using Kubernetes, from a single-node setup to scalable clusters in the cloud.
Previously, Browsertrix also supported Docker Compose and podman-based deployment. This has been 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 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 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 is made available under the AGPLv3 License.
Documentation is made available under the Creative Commons Attribution 4.0 International License