tea/browsertrix
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
756 Commits 2 Branches 0 Tags 15 MiB
TypeScript 56.4%
Python 39%
JavaScript 1.8%
CSS 1.3%
MDX 0.8%
Other 0.4%
4948e53cdb
Go to file
Henry Wilkinson 4948e53cdb
dev: Adds GitHub feature issue template (#1087) 
* Create feature-change.yml

* Enables docs referral in issue template
2023-08-21 15:27:45 -07:00
.github dev: Adds GitHub feature issue template (#1087) 2023-08-21 15:27:45 -07:00
.vscode Add MkDocs YAML schema to vscode settings.json (#1075) 2023-08-15 12:06:05 -07:00
ansible feat: create DO registry if it doesn't exist (#947) 2023-07-26 15:41:03 -07:00
backend bump to 1.6.2 2023-08-18 18:27:37 -07:00
chart chart resources: adjust backend memory to 350Mi, as 200Mi was too low (#1082) 2023-08-15 21:59:57 -07:00
configs
docs docs: formatting fixes & minor content updates (#1091) 2023-08-21 13:26:43 -07:00
frontend bump to 1.6.2 2023-08-18 18:27:37 -07:00
scripts fix: password check constructor error (#1077) 2023-08-15 12:00:13 -07:00
test fix(build): use /usr/bin/env bash instead of /bin/bash (#1020) 2023-07-28 21:50:04 -07:00
.gitignore
.pre-commit-config.yaml feat: add pre-commit to check we don't have real passwords in yml files (#990) 2023-07-26 13:29:37 -07:00
btrix fix: usr/bin/env bash interpreter for btrix (#1028) 2023-08-01 09:28:56 -07:00
CHANGES.md
LICENSE
mkdocs.yml docs: Adds information about 1.6 features to documentation (#1086) 2023-08-18 21:55:20 -07:00
NOTICE
pylintrc
README.md docs: fix link to dev docs 2023-05-24 10:59:41 -07:00
update-version.sh fix(build): use /usr/bin/env bash instead of /bin/bash (#1020) 2023-07-28 21:50:04 -07:00
version.txt bump to 1.6.2 2023-08-18 18:27:37 -07:00
yarn.lock Frontend collections beta UI (#886) 2023-06-06 17:52:01 -07:00

README.md

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, 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