bcb73932d4
Resolves https://github.com/webrecorder/browsertrix/issues/2478 ## Changes - Organizes README - Fixes relative links in mkdocs --------- Co-authored-by: Tessa Walsh <tessa@bitarchivist.net>
61 lines
2.7 KiB
Markdown
61 lines
2.7 KiB
Markdown
<h1>
|
|
<div align="center">
|
|
<img alt="Browsertrix" src="assets/browsertrix-lockup-color-dynamic.svg" width="90%">
|
|
</div>
|
|
</h1>
|
|
|
|
|
|
|
|
Browsertrix is a 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 starting, scheduling, sharing, and managing crawls. This repo includes the orchestration and management tools around crawling, while the actual crawling is performed using [browsertrix-crawler](https://github.com/webrecorder/browsertrix-crawler) containers.
|
|
|
|
Install Browsertrix to self host, or access hosted Browsertrix from [app.browsertrix.com](https://app.browsertrix.com).
|
|
|
|
See [webrecorder.net/browsertrix](https://webrecorder.net/browsertrix/) for a full overview of features.
|
|
|
|
## Documentation
|
|
|
|
Documentation for using, deploying, and developing Browsertrix is available at [docs.browsertrix.com](https://docs.browsertrix.com).
|
|
|
|
See instructions in [frontend/docs](./frontend/docs/docs/develop/docs.md#installation) to run the docs locally.
|
|
|
|
## Installation
|
|
|
|
Instructions for setting up Browsertrix is available at [docs.browsertrix.com/deploy](https://docs.browsertrix.com/deploy).
|
|
|
|
The docs cover deploying Browsertrix in different environments using Kubernetes, from a single-node setup to scalable clusters in the cloud.
|
|
|
|
## Support
|
|
|
|
Ask us your questions about Browsertrix and web archiving in the [community help forum](https://forum.webrecorder.net/c/help/5).
|
|
|
|
Dedicated professional support is available with a custom subscription. For details, see [hosted Browsertrix plans](https://webrecorder.net/browsertrix/#get-started).
|
|
|
|
## Bugs
|
|
|
|
For bug reports or feature requests, please open a [GitHub issue](https://github.com/webrecorder/browsertrix/issues/new/choose).
|
|
|
|
## Changelog
|
|
|
|
See [release notes](https://github.com/webrecorder/browsertrix/releases).
|
|
|
|
## Contributing
|
|
|
|
### Developing
|
|
|
|
Guides for getting started with local development are available at [docs.browsertrix.com/develop](https://docs.browsertrix.com/develop).
|
|
|
|
See [Code of Conduct](https://github.com/webrecorder/browsertrix?tab=coc-ov-file#contributor-covenant-code-of-conduct).
|
|
|
|
### Translating
|
|
|
|
Translations are managed through Weblate, a web-based and open source translation tool. View translations in progress and register to contribute at [our Weblate project](https://hosted.weblate.org/engage/browsertrix/).
|
|
|
|
<img src="https://hosted.weblate.org/widget/browsertrix/browsertrix-ui/multi-auto.svg" alt="Translation status" />
|
|
|
|
## License
|
|
|
|
Browsertrix is made available under the [AGPLv3 License](https://github.com/webrecorder/browsertrix?tab=AGPL-3.0-1-ov-file#readme).
|
|
|
|
Documentation is made available under the Creative Commons Attribution 4.0 International License. |