diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
index 13d96430..50cc5d1f 100644
--- a/.github/ISSUE_TEMPLATE/bug.yml
+++ b/.github/ISSUE_TEMPLATE/bug.yml
@@ -7,7 +7,7 @@ body:
- type: input
id: version
attributes:
- label: Browsertrix Cloud Version
+ label: Browsertrix Version
description: This can be found in the site footer
placeholder: "v1.5.0-beta.0-67d0c6a"
validations:
@@ -38,6 +38,6 @@ body:
- type: textarea
attributes:
label: Additional details
- description: Add any other relevant information here, such as your local environment if you are running Browsertrix Cloud locally.
+ description: Add any other relevant information here, such as your local environment if you are running Browsertrix locally.
validations:
required: false
diff --git a/README.md b/README.md
index fa086b3f..4bdc19f2 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
-# Browsertrix Cloud
+# Browsertrix
-Browsertrix Cloud is an open-source cloud-native high-fidelity browser-based crawling service designed
+Browsertrix 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,
@@ -10,28 +10,28 @@ and managing all aspects of crawling process. This system provides the orchestra
while the actual crawling is performed using
[Browsertrix Crawler](https://github.com/webrecorder/browsertrix-crawler) containers, which are launched for each crawl.
-See [Browsertrix Cloud](https://browsertrix.com) for a feature overview and information about Browsertrix Cloud Hosting.
+See [browsertrix.com](https://browsertrix.com) for a feature overview and information about Browsertrix Hosting.
## Documentation
-The full docs for using, deploying and developing Browsertrix Cloud are available at: [https://docs.browsertrix.cloud](https://docs.browsertrix.cloud)
+The full docs for using, deploying and developing Browsertrix are available at: [https://docs.browsertrix.cloud](https://docs.browsertrix.cloud)
## Deployment
The latest deployment documentation is available at: [https://docs.browsertrix.cloud/deploy](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.
+The docs cover deploying Browsertrix 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
+Previously, Browsertrix 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.
+Making deployment of Browsertrix 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.
+Browsertrix 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](https://docs.browsertrix.cloud/develop/)
@@ -40,6 +40,6 @@ Please see the GitHub issues and [this GitHub Project](https://github.com/orgs/w
## License
-Browsertrix Cloud is made available under the AGPLv3 License.
+Browsertrix is made available under the AGPLv3 License.
Documentation is made available under the Creative Commons Attribution 4.0 International License
diff --git a/chart/email-templates/invite b/chart/email-templates/invite
index 61a2469d..72a8837d 100644
--- a/chart/email-templates/invite
+++ b/chart/email-templates/invite
@@ -1,13 +1,13 @@
-Welcome to Browsertrix Cloud!
+Welcome to Browsertrix!
~~~
Hello!
-Welcome to Browsertrix Cloud!
+Welcome to Browsertrix!
{% if sender %}
-You have been invited by {{ sender }} to join "{{ org_name }}" on Browsertrix Cloud!
+
You have been invited by {{ sender }} to join "{{ org_name }}" on Browsertrix!
{% endif %}
@@ -22,11 +22,11 @@ Welcome to Browsertrix Cloud!
When you first access your account, you’ll be directed to your Dashboard. It contains information you may want to view frequently including: Storage Usage, Crawling Info, Collections, and Monthly Usage History. From there, you can click + Create New to create your first Crawl Workflow!
-
For more info, check out the Browsertrix Cloud User Guide
+For more info, check out the Browsertrix User Guide
-We want you to get the most from your Browsertrix Cloud experience!
+We want you to get the most from your Browsertrix experience!
Let us know if you need any questions or feedback.
@@ -39,10 +39,10 @@ You can connect with our team at {{ support
~~~
Hello!
-Welcome to Browsertrix Cloud!
+Welcome to Browsertrix!
{% if sender %}
-You have been invited by {{ sender }} to join their organization, "{{ org_name }}" on Browsertrix Cloud!
+You have been invited by {{ sender }} to join their organization, "{{ org_name }}" on Browsertrix!
{% else %}
@@ -51,13 +51,13 @@ You can join by clicking here: {{ invite_url }}
When you first access your account, you’ll be directed to your Dashboard. It contains information you may want to view frequently including: Storage Usage, Crawling Info, Collections, and Monthly Usage History.
-For more info, check out Browsertrix Cloud User Guide at: https://docs.browsertrix.cloud/user-guide/
+For more info, check out Browsertrix User Guide at: https://docs.browsertrix.cloud/user-guide/
If you ever need to reset your password, go here: {{ origin }}/log-in/forgot-password
-We want you to get the most from your Browsertrix Cloud experience. Let us know if you need any questions or feedback.
+We want you to get the most from your Browsertrix experience. Let us know if you need any questions or feedback.
You can connect with our team at {{ support_email }}.
diff --git a/chart/email-templates/validate b/chart/email-templates/validate
index 51bc0fed..fd62561f 100644
--- a/chart/email-templates/validate
+++ b/chart/email-templates/validate
@@ -1,6 +1,6 @@
-Welcome to Browsertrix Cloud, Verify your Registration.
+Welcome to Browsertrix, Verify your Registration.
~~~
-Please verify your registration for Browsertrix Cloud for {{ receiver_email }}
+Please verify your registration for Browsertrix for {{ receiver_email }}
You can verify by clicking here: {{ origin }}/verify?token={{ token }}
diff --git a/docs/deploy/ansible/digitalocean.md b/docs/deploy/ansible/digitalocean.md
index 1ffd987b..03c1b318 100644
--- a/docs/deploy/ansible/digitalocean.md
+++ b/docs/deploy/ansible/digitalocean.md
@@ -2,7 +2,7 @@
*Playbook Path: [ansible/playbooks/install_microk8s.yml](https://github.com/webrecorder/browsertrix-cloud/blob/main/ansible/playbooks/do_setup.yml)*
-This playbook provides an easy way to install Browsertrix Cloud on DigitalOcean. It automatically sets up Browsertrix with LetsEncrypt certificates.
+This playbook provides an easy way to install Browsertrix on DigitalOcean. It automatically sets up Browsertrix with LetsEncrypt certificates.
### Requirements
diff --git a/docs/deploy/ansible/k3s.md b/docs/deploy/ansible/k3s.md
index 9109d311..d73ef4f2 100644
--- a/docs/deploy/ansible/k3s.md
+++ b/docs/deploy/ansible/k3s.md
@@ -2,7 +2,7 @@
*Playbook Path: [ansible/playbooks/install_k3s.yml](https://github.com/webrecorder/browsertrix-cloud/blob/main/ansible/playbooks/install_k3s.yml)*
-This playbook provides an easy way to install Browsertrix Cloud on a Linux box (tested on Rocky Linux 9). It automatically sets up Browsertrix with Let's Encrypt certificates.
+This playbook provides an easy way to install Browsertrix on a Linux box (tested on Rocky Linux 9). It automatically sets up Browsertrix with Let's Encrypt certificates.
### Requirements
@@ -29,7 +29,7 @@ cp -r ansible/inventory/sample-k3s ansible/inventory/my-deployment
2. Change the [hosts IP address](https://github.com/webrecorder/browsertrix-cloud/blob/main/ansible/inventory/sample-k3s/hosts.ini) in your just created inventory
-4. You may need to make modifications to the playbook itself based on your configuration. The playbook lists sections that can be removed or changed based on whether you'd like to install a multi-node or single-node k3s installation for your Browsertrix Cloud deployment. By default the playbook assumes you'll run in a single-node environment deploying directly to `localhost`
+4. You may need to make modifications to the playbook itself based on your configuration. The playbook lists sections that can be removed or changed based on whether you'd like to install a multi-node or single-node k3s installation for your Browsertrix deployment. By default the playbook assumes you'll run in a single-node environment deploying directly to `localhost`
5. Run the playbook:
```zsh
diff --git a/docs/deploy/ansible/microk8s.md b/docs/deploy/ansible/microk8s.md
index 547a7d42..be6687c4 100644
--- a/docs/deploy/ansible/microk8s.md
+++ b/docs/deploy/ansible/microk8s.md
@@ -2,7 +2,7 @@
*Playbook Path: [ansible/playbooks/install_microk8s.yml](https://github.com/webrecorder/browsertrix-cloud/blob/main/ansible/playbooks/install_microk8s.yml)*
-This playbook provides an easy way to install Browsertrix Cloud on Ubuntu (tested on Jammy Jellyfish) and RedHat 9 (tested on Rocky Linux 9). It automatically sets up Browsertrix with Letsencrypt certificates.
+This playbook provides an easy way to install Browsertrix on Ubuntu (tested on Jammy Jellyfish) and RedHat 9 (tested on Rocky Linux 9). It automatically sets up Browsertrix with Letsencrypt certificates.
### Requirements
diff --git a/docs/deploy/index.md b/docs/deploy/index.md
index 3d2dac1c..5c7a9693 100644
--- a/docs/deploy/index.md
+++ b/docs/deploy/index.md
@@ -1,13 +1,13 @@
-# Deploying Browsertrix Cloud
+# Deploying Browsertrix
-Browsertrix Cloud is designed to be a cloud-native application running in Kubernetes.
+Browsertrix is designed to be a cloud-native application running in Kubernetes.
-However, despite the name, it is perfectly reasonable (and easy!) to deploy Browsertrix Cloud locally using one of the many available local Kubernetes options.
+However, despite the name, it is perfectly reasonable (and easy!) to deploy Browsertrix locally using one of the many available local Kubernetes options.
-The main requirements for Browsertrix Cloud are:
+The main requirements for Browsertrix are:
- A Kubernetes Cluster
- [Helm 3](https://helm.sh/) (package manager for Kubernetes)
-We have prepared a [Local Deployment Guide](local.md) which covers several options for testing Browsertrix Cloud locally on a single machine, as well as a [Production (Self-Hosted and Cloud) Deployment](remote.md) guide to help with setting up Browsertrix Cloud in different production scenarios. Information about configuring storage, crawler channels, and other details in local or production deployments is in the [Customizing Browsertrix Deployment Guide](customization.md).
+We have prepared a [Local Deployment Guide](local.md) which covers several options for testing Browsertrix locally on a single machine, as well as a [Production (Self-Hosted and Cloud) Deployment](remote.md) guide to help with setting up Browsertrix in different production scenarios. Information about configuring storage, crawler channels, and other details in local or production deployments is in the [Customizing Browsertrix Deployment Guide](customization.md).
diff --git a/docs/deploy/local.md b/docs/deploy/local.md
index 8d91096c..8ab58661 100644
--- a/docs/deploy/local.md
+++ b/docs/deploy/local.md
@@ -1,10 +1,10 @@
# Local Deployment
-To try out the latest release of Browsertrix Cloud on your local machine, you'll first need to have a working Kubernetes cluster.
+To try out the latest release of Browsertrix on your local machine, you'll first need to have a working Kubernetes cluster.
## Installing Kubernetes
-Before running Browsertrix Cloud, you'll need to set up a running [Kubernetes](https://kubernetes.io/) cluster.
+Before running Browsertrix, you'll need to set up a running [Kubernetes](https://kubernetes.io/) cluster.
Today, there are numerous ways to deploy Kubernetes fairly easily, and we recommend trying one of the single-node options, which include Docker Desktop, microk8s, minikube, and k3s.
@@ -16,7 +16,7 @@ Here are some environment specific instructions for setting up a local cluster f
??? info "Docker Desktop (recommended for macOS and Windows)"
- For macOS and Windows, we recommend testing out Browsertrix Cloud using Kubernetes support in Docker Desktop as that will be one of the simplest options.
+ For macOS and Windows, we recommend testing out Browsertrix using Kubernetes support in Docker Desktop as that will be one of the simplest options.
1. [Install Docker Desktop](https://www.docker.com/products/docker-desktop/) if not already installed.
@@ -54,9 +54,9 @@ Here are some environment specific instructions for setting up a local cluster f
3. Set `KUBECONFIG` to point to the config for K3S: `export KUBECONFIG=/etc/rancher/k3s/k3s.yaml` to ensure Helm will use the correct version.
-## Launching Browsertrix Cloud with Helm
+## Launching Browsertrix with Helm
-Once you have a running Kubernetes cluster with one of the options above, and Helm 3 installed, install the latest release of Browsertrix Cloud directly from the latest GitHub release.
+Once you have a running Kubernetes cluster with one of the options above, and Helm 3 installed, install the latest release of Browsertrix directly from the latest GitHub release.
@@ -80,7 +80,7 @@ https://github.com/webrecorder/browsertrix-cloud/releases/download/VERSION/brows
**Note:** Subsequent commands will also use `microk8s helm3` instead of `helm`.
-The default setup includes the full Browsertrix Cloud system, with frontend, backend api, db (via MongoDB), and storage (via Minio)
+The default setup includes the full Browsertrix system, with frontend, backend api, db (via MongoDB), and storage (via Minio)
An admin user with name `admin@example.com` and password `PASSW0RD!` will be automatically created.
@@ -100,7 +100,7 @@ helm upgrade --install btrix https://github.com/webrecorder/browsertrix-cloud/re
-f ./chart/examples/local-config.yaml
```
-The above examples assumes running from a cloned Browsertrix Cloud repo, however the config file can be saved anywhere and specified with `-f `.
+The above examples assumes running from a cloned Browsertrix repo, however the config file can be saved anywhere and specified with `-f `.
## Waiting for Cluster to Start
@@ -117,7 +117,7 @@ REVISION: 1
TEST SUITE: None
```
-After that, especially on first run, it may take a few minutes for the Browsertrix Cloud cluster to start, as all images need to be downloaded locally.
+After that, especially on first run, it may take a few minutes for the Browsertrix cluster to start, as all images need to be downloaded locally.
You can try running the following command to wait for all pods to be initialized:
@@ -127,7 +127,7 @@ kubectl wait --for=condition=ready pod --all --timeout=300s
The command will exit when all pods have been loaded, or if there is an error and it times out.
-If the command succeeds, you should be able to access Browsertrix Cloud by loading: [http://localhost:30870/](http://localhost:30870/) in your browser.
+If the command succeeds, you should be able to access Browsertrix by loading: [http://localhost:30870/](http://localhost:30870/) in your browser.
??? info "Minikube (on macOS)"
@@ -152,7 +152,7 @@ The outputs of these commands are helpful when reporting an issue [on GitHub](ht
## Updating the Cluster
-To update the cluster, for example to update to new version `NEWVERSION`, re-run the same command again, which will pull the latest images. In this way, you can upgrade to the latest release of Browsertrix Cloud. The upgrade will preserve the database and current archives.
+To update the cluster, for example to update to new version `NEWVERSION`, re-run the same command again, which will pull the latest images. In this way, you can upgrade to the latest release of Browsertrix. The upgrade will preserve the database and current archives.
```shell
helm upgrade --install btrix https://github.com/webrecorder/browsertrix-cloud/releases/download/NEWVERSION/browsertrix-cloud-NEWVERSION.tgz
@@ -172,4 +172,4 @@ To fully delete all persistent data (db + archives) created in the cluster, run
## Deploying for Local Development
-These instructions are intended for deploying the cluster from the latest releases published on GitHub. See [setting up cluster for local development](../develop/local-dev-setup.md) for additional customizations related to developing Browsertrix Cloud and deploying from local images.
+These instructions are intended for deploying the cluster from the latest releases published on GitHub. See [setting up cluster for local development](../develop/local-dev-setup.md) for additional customizations related to developing Browsertrix and deploying from local images.
diff --git a/docs/deploy/remote.md b/docs/deploy/remote.md
index 2ec0df5d..6178c052 100644
--- a/docs/deploy/remote.md
+++ b/docs/deploy/remote.md
@@ -94,15 +94,15 @@ mongo_auth:
## Cloud Deployment
-There are also many ways to deploy Browsertrix Cloud on various cloud providers.
+There are also many ways to deploy Browsertrix on various cloud providers.
-To simplify this process, we are working on Ansible playbooks for setting up Browsertrix Cloud on commonly used infrastructure.
+To simplify this process, we are working on Ansible playbooks for setting up Browsertrix on commonly used infrastructure.
### Ansible Deployment
-[Ansible](https://ansible.com) makes the initial setup and configuration of your Browsertrix Cloud instance automated and repeatable.
+[Ansible](https://ansible.com) makes the initial setup and configuration of your Browsertrix instance automated and repeatable.
-To use, you will need to [install Ansible](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#control-node-requirements) on your control computer and then you can use these to deploy to Browsertrix Cloud on remote and cloud environments.
+To use, you will need to [install Ansible](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#control-node-requirements) on your control computer and then you can use these to deploy to Browsertrix on remote and cloud environments.
Currently, we provide playbooks for the following tested environments:
diff --git a/docs/develop/docs.md b/docs/develop/docs.md
index 43dbabae..0c1bb5cb 100644
--- a/docs/develop/docs.md
+++ b/docs/develop/docs.md
@@ -133,7 +133,7 @@ Renders to: `#!python range()`
`Paid Feature`{ .badge-green }
-Some features of Browsertrix Cloud only pertain to those paying for the software on a hosted plan. Denote these with the following:
+Some features of Browsertrix only pertain to those paying for the software on a hosted plan. Denote these with the following:
```markdown
`Paid Feature`{ .badge-green }
diff --git a/docs/develop/frontend-dev.md b/docs/develop/frontend-dev.md
index b362affa..cf536a04 100644
--- a/docs/develop/frontend-dev.md
+++ b/docs/develop/frontend-dev.md
@@ -1,14 +1,14 @@
# Developing the Frontend UI
-This guide explains how to run the Browsertrix Cloud frontend development server with [Yarn](https://classic.yarnpkg.com).
+This guide explains how to run the Browsertrix frontend development server with [Yarn](https://classic.yarnpkg.com).
Instead of rebuilding the entire frontend image to view your UI changes, you can use the included local development server to access the frontend from your browser. This setup is ideal for rapid UI development that does not rely on any backend changes.
## Requirements
-### 1. Browsertrix Cloud API backend already in a Kubernetes cluster
+### 1. Browsertrix API backend already in a Kubernetes cluster
-The frontend development server requires an existing backend that has been deployed locally or is in production. See [Deploying Browsertrix Cloud](../deploy/index.md).
+The frontend development server requires an existing backend that has been deployed locally or is in production. See [Deploying Browsertrix](../deploy/index.md).
### 2. Node.js ≥16 and Yarn 1
@@ -64,7 +64,7 @@ API_BASE_URL=http://dev.example.com
!!! note
- This setup assumes that your API endpoints are available under `/api`, which is the default configuration for the Browsertrix Cloud backend.
+ This setup assumes that your API endpoints are available under `/api`, which is the default configuration for the Browsertrix backend.
If connecting to a local deployment cluster, set `API_BASE_URL` to:
diff --git a/docs/develop/index.md b/docs/develop/index.md
index f37c2a43..5228f16a 100644
--- a/docs/develop/index.md
+++ b/docs/develop/index.md
@@ -3,11 +3,11 @@ hide:
- toc
---
-# Developing Browsertrix Cloud
+# Developing Browsertrix
-Browsertrix Cloud consists of a Python-based backend and TypeScript-based frontend.
+Browsertrix consists of a Python-based backend and TypeScript-based frontend.
-To develop Browsertrix Cloud, the system must [first be deployed locally](../deploy/local.md) in a Kubernetes cluster.
+To develop Browsertrix, the system must [first be deployed locally](../deploy/local.md) in a Kubernetes cluster.
The deployment can then be [further customized for local development](./local-dev-setup.md).
diff --git a/docs/develop/local-dev-setup.md b/docs/develop/local-dev-setup.md
index 06d9b7fc..dd0def59 100644
--- a/docs/develop/local-dev-setup.md
+++ b/docs/develop/local-dev-setup.md
@@ -6,7 +6,7 @@ First, see our [Local Deployment guide](../deploy/local.md#installing-kubernetes
## Local Dev Configuration
-The local deployment guide explains how to deploy Browsertrix Cloud with latest published images.
+The local deployment guide explains how to deploy Browsertrix with latest published images.
However, if you are developing locally, you will need to use your local images instead.
diff --git a/docs/index.md b/docs/index.md
index d6c89633..900cfc5b 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -6,12 +6,12 @@ hide:
# Home
-Welcome to the Browsertrix Cloud official user guide and developer docs. These docs will contain the following sections.
+Welcome to the Browsertrix official user guide and developer docs. These docs will contain the following sections.
-- [Deployment Guide](deploy/index.md) — How to install and deploy Browsertrix Cloud on your local machine, or in the cloud.
-- [Developer Docs](develop/index.md) — Information on developing Browsertrix Cloud itself.
-- [User Guide](user-guide/index.md) — Instructions and reference for using Browsertrix Cloud.
+- [Deployment Guide](deploy/index.md) — How to install and deploy Browsertrix on your local machine, or in the cloud.
+- [Developer Docs](develop/index.md) — Information on developing Browsertrix itself.
+- [User Guide](user-guide/index.md) — Instructions and reference for using Browsertrix.
-If you are unfamiliar with Browsertrix Cloud, please check out [our website](https://browsertrix.cloud), or the main repository at [https://github.com/webrecorder/browsertrix-cloud](https://github.com/webrecorder/browsertrix-cloud)
+If you are unfamiliar with Browsertrix, please check out [our website](https://browsertrix.cloud), or the main repository at [https://github.com/webrecorder/browsertrix-cloud](https://github.com/webrecorder/browsertrix-cloud)
Our docs are still under construction. If you find something missing, chances are we haven't gotten around to writing that part yet. If you find typos or something isn't clear or seems incorrect, please open an [issue](https://github.com/webrecorder/browsertrix-cloud/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) and we'll try to make sure that your questions get answered here in the future!
diff --git a/frontend/src/components/ui/README.md b/frontend/src/components/ui/README.md
index 9800a633..4521fd33 100644
--- a/frontend/src/components/ui/README.md
+++ b/frontend/src/components/ui/README.md
@@ -1,5 +1,5 @@
# Reusable UI Components
-Components here should be reusable across Browsertrix Cloud (and perhaps eventually across other Webrecorder projects as well). They should generally not depend on auth, not be specific to a single page or view, and have well-defined (and typed) inputs and outputs.
+Components here should be reusable across Browsertrix (and perhaps eventually across other Webrecorder projects as well). They should generally not depend on auth, not be specific to a single page or view, and have well-defined (and typed) inputs and outputs.
diff --git a/frontend/src/index.ejs b/frontend/src/index.ejs
index 3b8f35e8..2d6b718f 100644
--- a/frontend/src/index.ejs
+++ b/frontend/src/index.ejs
@@ -6,7 +6,7 @@
name="viewport"
content="width=device-width, initial-scale=1.0, viewport-fit=cover"
/>
- Browsertrix Cloud
+ Browsertrix