Go to file
Tessa Walsh 0fa60ebc45
Rename archives/teams -> orgs in codebase + add db migration (#486)
* Rename archives to orgs and aid to oid on backend

* Rename archive to org and aid to oid in frontend

* Remove translation artifact

* Rename team -> organization

* Add database migrations and run once on startup

* This commit also applies the new by_one_worker decorator to other
asyncio tasks to prevent heavy tasks from being run in each worker.

* Run black, pylint, and husky via pre-commit

* Set db version and use in migrations

* Update and prepare database in single task

* Migrate k8s configmaps
2023-01-18 14:51:04 -08:00
.github/workflows Add frontend build check (#498) 2023-01-18 13:06:33 -08:00
ansible email sending tweaks: (#470) 2023-01-12 23:25:23 -08:00
backend Rename archives/teams -> orgs in codebase + add db migration (#486) 2023-01-18 14:51:04 -08:00
chart Rename archives/teams -> orgs in codebase + add db migration (#486) 2023-01-18 14:51:04 -08:00
configs Remove Code and Configs for Swarm/podman support (#407) 2022-12-08 18:19:58 -08:00
docs docs: tweak ansible deployment docs 2023-01-11 22:33:28 -08:00
frontend Rename archives/teams -> orgs in codebase + add db migration (#486) 2023-01-18 14:51:04 -08:00
scripts VNC-Based Profile Browser (#433) 2023-01-10 14:42:42 -08:00
test Single config and env vars (#267) 2022-06-16 21:50:03 -07:00
.gitignore add digital ocean documentation (#421) 2023-01-11 21:57:17 -08:00
.pre-commit-config.yaml Rename archives/teams -> orgs in codebase + add db migration (#486) 2023-01-18 14:51:04 -08:00
CHANGES.md docs: CHANGES: fix typo, begin changelist for 1.2.0 (#410) 2022-12-12 20:32:35 -08:00
LICENSE
mkdocs.yml Minor docs style updates (#409) 2022-12-12 18:15:12 -08:00
NOTICE
pylintrc
README.md README + CHANGES + doc tweaks for 1.1.0 release (#402) 2022-12-06 12:27:27 -08:00
update-version.sh Release Build + Versioning (#373) 2022-11-18 17:15:25 -08:00
version.txt VNC-Based Profile Browser (#433) 2023-01-10 14:42:42 -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.

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

Documentation

The full docs for using, deplyoing 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/dev

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.

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