418c07bf0d
* backend: refactor swarm support to also support podman (#260) - implement podman support as subclass of swarm deployment - podman is used when 'RUNTIME=podman' env var is set - podman socket is mapped instead of docker socket - podman-compose is used instead of docker-compose (though docker-compose works with podman, it does not support secrets, but podman-compose does) - separate cli utils into SwarmRunner and PodmanRunner which extends it - using config.yaml and config.env, both copied from sample versions - work on simplifying config: add docker-compose.podman.yml and docker-compose.swarm.yml and signing and debug configs in ./configs - add {build,run,stop}-{swarm,podman}.sh in scripts dir - add init-configs, only copy if configs don't exist - build local image use current version of podman, to support both podman 3.x and 4.x - additional fixes for after testing podman on centos - docs: update Deployment.md to cover swarm, podman, k8s deployment
35 lines
1.4 KiB
Markdown
35 lines
1.4 KiB
Markdown
# Browsertrix Cloud
|
|
|
|
<p align="center"><img src="/frontend/assets/btrix-cloud.svg" width="128" height="128"></p>
|
|
|
|
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](https://github.com/webrecorder/browsertrix-crawler) containers, which are launched for each crawl.
|
|
|
|
The system is designed to run in both Kubernetes and Docker Swarm, as well as locally under Podman.
|
|
|
|
See [Features](https://browsertrix.cloud/features) for a high-level list of planned features.
|
|
|
|
## Deployment
|
|
|
|
See the [Deployment](Deployment.md) page for information on how to deploy Browsertrix Cloud.
|
|
|
|
|
|
## Development Status
|
|
|
|
Browsertrix Cloud is currently in an alpha stage and not ready for production. This is an ambitious project and there's a lot to be done!
|
|
|
|
If you would like to help in a particular way, please open an issue or reach out to us in other ways.
|
|
|
|
## 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.
|
|
|
|
|