Go to file
Ilya Kreymer 30bda8c75d
VNC-Based Profile Browser (#433)
* profile browser vnc support + fixes:
- switch profile browser rendering to use VNC
- frontend: add @novnc/novnc as dependency, create separate bundle novnc.js to load into vnc browser (to avoid loading from each container)
- frontend: update proxy paths to proxy websocket, index page to crawler
- frontend: allow browser profiles in all browsers, remove browser compatibility check
- frontend: update webpack dev config, apply prettier
- frontend: node version fix
- backend: get vncpassword, build new URL for proxying to crawler iframe
- backend: fix profile / crawl job pull policy from 'Always' -> 'Never', should use existing image for job
- backend: fix kill signal to use bash -c to work with latest backend image
- backend/chart: add 'profile_browser_timeout_seconds' to chart values to control how long profile browser to remain when idle (default to 60)
- backend: remove utils.py, now using secret.token_hex() for random suffix
Co-authored-by: sua yoo <sua@suayoo.com>
2023-01-10 14:42:42 -08:00
.github/workflows Use archive_viewer_dep permissions to GET crawls (#443) 2023-01-09 19:11:53 -08:00
ansible Digital ocean setup (#314) 2022-11-15 13:44:24 -08:00
backend VNC-Based Profile Browser (#433) 2023-01-10 14:42:42 -08:00
chart VNC-Based Profile Browser (#433) 2023-01-10 14:42:42 -08:00
configs Remove Code and Configs for Swarm/podman support (#407) 2022-12-08 18:19:58 -08:00
docs docs: CHANGES: fix typo, begin changelist for 1.2.0 (#410) 2022-12-12 20:32:35 -08:00
frontend VNC-Based Profile Browser (#433) 2023-01-10 14:42:42 -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 Digital ocean setup (#314) 2022-11-15 13:44:24 -08:00
CHANGES.md docs: CHANGES: fix typo, begin changelist for 1.2.0 (#410) 2022-12-12 20:32:35 -08:00
LICENSE Add License, Logo and README updates for release (#157) 2022-02-23 12:10:46 -08:00
mkdocs.yml Minor docs style updates (#409) 2022-12-12 18:15:12 -08:00
NOTICE Add License, Logo and README updates for release (#157) 2022-02-23 12:10:46 -08:00
pylintrc misc tweaks: 2021-08-25 18:34:49 -07:00
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.