README + CHANGES + doc tweaks for 1.1.0 release (#402)
- update README + docs with deprecation of non-k8s deployment - add CHANGES.md - bump version to 1.1.0
This commit is contained in:
parent
ba3e7d048f
commit
0aa09be8c3
19
CHANGES.md
Normal file
19
CHANGES.md
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
### v1.1.0
|
||||||
|
|
||||||
|
New Features:
|
||||||
|
- Viewing crawl queue and dynamically adding exclusions to crawl queue while crawl is running.
|
||||||
|
- Adding exclusions to crawl config screen.
|
||||||
|
- Setting initial browser language on crawl config.
|
||||||
|
|
||||||
|
Mkdocs based documentation added
|
||||||
|
|
||||||
|
Docker swarm / compose / podman-based deployments not deprecated in favor of Kubernetes
|
||||||
|
|
||||||
|
Various UI improvements and tweaks
|
||||||
|
|
||||||
|
|
||||||
|
### v1.0.0
|
||||||
|
|
||||||
|
Initial release
|
||||||
|
|
||||||
|
|
35
README.md
35
README.md
@ -10,28 +10,33 @@ and managing all aspects of crawling process. This system provides the orchestra
|
|||||||
while the actual crawling is performed using
|
while the actual crawling is performed using
|
||||||
[Browsertrix Crawler](https://github.com/webrecorder/browsertrix-crawler) containers, which are launched for each crawl.
|
[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.
|
See [Features](https://browsertrix.cloud/features) for a high-level list of planned features.
|
||||||
|
|
||||||
|
|
||||||
## Development Status
|
|
||||||
|
|
||||||
Browsertrix Cloud is currently in an early beta stage and not fully 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.
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Docs are available at: [https://docs.browsertrix.cloud/](https://docs.browsertrix.cloud/) created from the markdown in the [./docs](./docs) on the main branch.
|
The full docs for using, deplyoing and developing Browsertrix Cloud are available at: [https://docs.browsertrix.cloud](https://docs.browsertrix.cloud)
|
||||||
|
|
||||||
To build the documentation locally, install Material for MkDocs with pip:
|
## Deployment
|
||||||
|
|
||||||
```shell
|
The latest deployment documentation is available at: [https://docs.browsertrix.cloud/deploy](https://docs.browsertrix.cloud/deploy)
|
||||||
pip install mkdocs-material
|
|
||||||
```
|
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](https://github.com/webrecorder/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](https://docs.browsertrix.cloud/dev)
|
||||||
|
|
||||||
|
Please see the GitHub issues and [this GitHub Project](https://github.com/orgs/webrecorder/projects/9) for our current project plan and tasks.
|
||||||
|
|
||||||
In the project root directory run `mkdocs serve` to run a local version of the documentation site.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
@ -1,2 +1,2 @@
|
|||||||
""" current version """
|
""" current version """
|
||||||
__version__ = "1.1.0-beta.3"
|
__version__ = "1.1.0"
|
||||||
|
@ -7,8 +7,15 @@ However, despite the name, it is perfectly reasonable (and easy!) to deploy Brow
|
|||||||
The main requirements for Browsertrix Cloud are:
|
The main requirements for Browsertrix Cloud are:
|
||||||
|
|
||||||
- A Kubernetes Cluster
|
- A Kubernetes Cluster
|
||||||
- Helm (package manager for Kubernetes)
|
- Helm 3 (package manager for Kubernetes)
|
||||||
|
|
||||||
We have prepared a [Local Deployment](./local) and [Production (Self-Hosted and Cloud) Deployment](./production) guides to help with
|
We have prepared a [Local Deployment](./local) and [Production (Self-Hosted and Cloud) Deployment](./production) guides to help with
|
||||||
setting up Browsertrix Cloud for different scenarios.
|
setting up Browsertrix Cloud for different scenarios.
|
||||||
|
|
||||||
|
### Non Kubernetes Deployments
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "browsertrix-frontend",
|
"name": "browsertrix-frontend",
|
||||||
"version": "1.1.0-beta.3",
|
"version": "1.1.0",
|
||||||
"main": "index.ts",
|
"main": "index.ts",
|
||||||
"license": "AGPL-3.0-or-later",
|
"license": "AGPL-3.0-or-later",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
@ -1 +1 @@
|
|||||||
1.1.0-beta.3
|
1.1.0
|
||||||
|
Loading…
Reference in New Issue
Block a user