Add Repository Index + Chart Rename + Docs Rename (#1708)

Repository Index: Generate an index.yaml in ./docx/helm-repo/index.yaml to allow for browsertrix to be a helm repository. docs: rename docs.browsertrix.cloud -> docs.browsertrix.com docs: update deployment doc to mention helm repo as preferred way to install docs build action: generate repository index in GH action publish action: update auto-generated message to mention installing from the repo. --------- Co-authored-by: Tessa Walsh <[email protected]>
webrecorder · Apr 21, 2024 · b574f00 · b574f00
1 parent d31bdd2
commit b574f00
Show file tree

Hide file tree

Showing 35 changed files with 2,173 additions and 870 deletions.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -12,5 +12,5 @@ contact_links:
     url: https://forum.webrecorder.net/
     about: Have a ("how do I...?") question? Not sure if your issue is reproducible? The best way to get help is on our community forum!
   - name: Check out the docs
-    url: https://docs.browsertrix.cloud
-    about: Find solutions to common questions, such as how to install, develop, and deploy Browsertrix.
+    url: https://docs.browsertrix.com
+    about: Find solutions to common questions, such as how to install, develop, and deploy Browsertrix.
diff --git a/.github/workflows/docs-publish.yaml b/.github/workflows/docs-publish.yaml
@@ -17,5 +17,9 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: 3.x
-      - run: pip install mkdocs-material
+      - run: pip install mkdocs-material requests pyyaml
+
+      - name: Generate Helm Chart Index
+        run: python ./scripts/generate-helm-index.py > ./docs/helm-repo/index.yaml
+
       - run: mkdocs gh-deploy --force
diff --git a/.github/workflows/password-check.yaml b/.github/workflows/password-check.yaml
@@ -1,40 +1,40 @@
-name: Password Check
+# name: Password Check
 
-on:
-  push:
-    paths:
-      - '*.yaml'
-      - '*.yml'
-  pull_request:
-    paths:
-      - '*.yaml'
-      - '*.yml'
+# on:
+#   push:
+#     paths:
+#       - '*.yaml'
+#       - '*.yml'
+#   pull_request:
+#     paths:
+#       - '*.yaml'
+#       - '*.yml'
 
-jobs:
-  check:
-    runs-on: ubuntu-latest
-    steps:
-      - name: checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 3
+# jobs:
+#   check:
+#     runs-on: ubuntu-latest
+#     steps:
+#       - name: checkout
+#         uses: actions/checkout@v3
+#         with:
+#           fetch-depth: 3
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.10'
+#       - name: Set up Python
+#         uses: actions/setup-python@v4
+#         with:
+#           python-version: '3.10'
 
-      - name: Install dependencies
-        run: |
-          cd backend/
-          python -m pip install --upgrade pip
-          pip install pyyaml
+#       - name: Install dependencies
+#         run: |
+#           cd backend/
+#           python -m pip install --upgrade pip
+#           pip install pyyaml
 
-      - name: Password Check
-        run: |
-          CHANGED_FILES=$(git diff --name-only HEAD^..HEAD)
-          echo $CHANGED_FILES
-          YML_FILES=$(echo "$CHANGED_FILES" | { grep ".yml$\|.yaml$" || true; })
-          if [[ -n "$YML_FILES" ]]; then
-            python3 scripts/check_passwords.py $YML_FILES
-          fi
+#       - name: Password Check
+#         run: |
+#           CHANGED_FILES=$(git diff --name-only HEAD^..HEAD)
+#           echo $CHANGED_FILES
+#           YML_FILES=$(echo "$CHANGED_FILES" | { grep ".yml$\|.yaml$" || true; })
+#           if [[ -n "$YML_FILES" ]]; then
+#             python3 scripts/check_passwords.py $YML_FILES
+#           fi
diff --git a/.github/workflows/publish-helm-chart.yaml b/.github/workflows/publish-helm-chart.yaml
@@ -34,15 +34,22 @@ jobs:
           body: |
             ## Deployment
 
-            This release can be deployed with Helm by running:
+            This release can be deployed with Helm directly by running:
 
             ```
-            helm upgrade --install btrix https://github.com/webrecorder/browsertrix-cloud/releases/download/v${{ env.version }}/browsertrix-cloud-v${{ env.version }}.tgz
+            helm upgrade --install btrix https://github.com/webrecorder/browsertrix/releases/download/v${{ env.version }}/browsertrix-v${{ env.version }}.tgz
             ```
 
-            See [the development guide](https://docs.browsertrix.cloud/deploy/) for more info how to deploy Browsertrix Cloud.
+            Alternatively, you can add the Browsertrix Helm Chart Repo with:
 
-          files: .chart-out/browsertrix-cloud-v${{ env.version }}.tgz
+            ```  
+            helm repo add browsertrix https://docs.browsertrix.com/helm-repo/
+            helm upgrade --install btrix browsertrix/browsertrix --version ${{ env.version }}
+            ```
+
+            See [the development guide](https://docs.browsertrix.com/deploy/) for more info how to deploy Browsertrix.
+
+          files: .chart-out/browsertrix-v${{ env.version }}.tgz
           tag_name: v${{ env.version }}
-          fail_on_unmatched_files: true
           draft: true
+          fail_on_unmatched_files: true
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -1,4 +1,4 @@
-name: Browsertrix Cloud Release Build
+name: Browsertrix Release Build
 
 on:
   release:

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -26,10 +26,10 @@ repos:
       language: system
       entry: frontend/.husky/pre-commit
       pass_filenames: false
-- repo: local
-  hooks:
-    - id: password-check
-      name: password-check
-      language: system
-      types: [yaml]
-      entry: python3 scripts/check_passwords.py
+# - repo: local
+#   hooks:
+#     - id: password-check
+#       name: password-check
+#       language: system
+#       types: [yaml]
+#       entry: python3 scripts/check_passwords.py
diff --git a/NOTICE b/NOTICE
@@ -1,4 +1,4 @@
-Browsertrix Cloud
+Browsertrix
 Copyright (C) 2022 Webrecorder Software
 
 Released under the GNU Affero General Public License.

diff --git a/README.md b/README.md
@@ -15,11 +15,11 @@ See [browsertrix.com](https://browsertrix.com) for a feature overview and inform
 
 ## Documentation
 
-The full docs for using, deploying, and developing Browsertrix 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.com](https://docs.browsertrix.com)
 
 ## Deployment
 
-The latest deployment documentation is available at: [https://docs.browsertrix.cloud/deploy](https://docs.browsertrix.cloud/deploy)
+The latest deployment documentation is available at: [https://docs.browsertrix.com/deploy](https://docs.browsertrix.com/deploy)
 
 The docs cover deploying Browsertrix in different environments using Kubernetes, from a single-node setup to scalable clusters in the cloud.
 
@@ -33,7 +33,7 @@ If you are looking to just try running a single crawl, you may want to try [Brow
 
 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/)
+Additional developer documentation is available at [https://docs.browsertrix.com/develop](https://docs.browsertrix.com/develop/)
 
 Please see the GitHub issues and [this GitHub Project](https://github.com/orgs/webrecorder/projects/9) for our current project plan and tasks.
 

diff --git a/ansible/README.md b/ansible/README.md
@@ -1,3 +1,3 @@
 ### Install
 
-Most current instructions to install will always be [here](https://docs.browsertrix.cloud/deploy/remote/)
+Most current instructions to install will always be [here](https://docs.browsertrix.com/deploy/remote/)
diff --git a/ansible/do_setup.yml b/ansible/do_setup.yml
@@ -1,5 +1,5 @@
 ---
-- name: deploy browsertrix cloud on digital ocean
+- name: deploy browsertrix on digital ocean
   hosts: localhost
   connection: local
   gather_facts: false

diff --git a/ansible/install_k3s.yml b/ansible/install_k3s.yml
@@ -21,7 +21,7 @@
 #   roles:
 #     - role: k3s/node
 
-# Ansible controller to install browsertrix cloud
+# Ansible controller to install browsertrix
 - hosts: 127.0.0.1
   connection: local
   become: yes # Can be removed if not using the btrix/prereq role

diff --git a/ansible/playbooks/do_teardown.yml b/ansible/playbooks/do_teardown.yml
@@ -1,5 +1,5 @@
 ---
-- name: teardown browsertrix cloud on digital ocean
+- name: teardown browsertrix on digital ocean
   hosts: localhost
   connection: local
   gather_facts: false
@@ -132,7 +132,7 @@
       register: domain_info
       changed_when: true
 
-    - name: d_ocean | dns | remove the dns for browsertrix cloud
+    - name: d_ocean | dns | remove the dns for browsertrix
       ansible.builtin.command: "doctl compute domain records rm {{ domain }} {{ item }} -f"
       loop: "{{ domain_info.stdout | from_json | json_query(name_query) }}"
       vars:

diff --git a/ansible/roles/digital_ocean/setup/tasks/main.yml b/ansible/roles/digital_ocean/setup/tasks/main.yml
@@ -198,7 +198,7 @@
   ansible.builtin.set_fact:
     lb_ip: "{{ loadbalancer_ip_result.stdout_lines[1] }}"
 
-- name: d_ocean | dns | register the dns for browsertrix cloud
+- name: d_ocean | dns | register the dns for browsertrix
   ansible.builtin.command: >-
       doctl compute domain records create --record-type A --record-name "{{ subdomain if subdomain else '@' }}" --record-data "{{ lb_ip }}" "{{ domain }}"
 

diff --git a/ansible/roles/microk8s/common/defaults/main.yml b/ansible/roles/microk8s/common/defaults/main.yml
@@ -4,7 +4,7 @@ ansible_ssh_private_key_file: "~/.ssh/id_rsa"
 microk8s_cache_valid_time: 3600
 allow_world_readable_tmpfiles: true
 
-domain: "{{ domain_name | default('browsertrix.cloud') }}"
+domain: "{{ domain_name | default('browsertrix.com') }}"
 ## version management
 microk8s_disable_snap_autoupdate: false
 

diff --git a/backend/btrixcloud/main.py b/backend/btrixcloud/main.py
@@ -48,7 +48,7 @@
 # ============================================================================
 # pylint: disable=too-many-locals, duplicate-code
 def main():
-    """init browsertrix cloud api"""
+    """init browsertrix api"""
 
     app = APIRouter()
 
@@ -83,7 +83,7 @@ def main():
     # pylint: disable=import-outside-toplevel
     if not os.environ.get("KUBERNETES_SERVICE_HOST"):
         print(
-            "Sorry, the Browsertrix Cloud Backend must be run inside a Kubernetes environment.\
+            "Sorry, the Browsertrix Backend must be run inside a Kubernetes environment.\
              Kubernetes not detected (KUBERNETES_SERVICE_HOST is not set), Exiting"
         )
         sys.exit(1)

diff --git a/backend/btrixcloud/main_op.py b/backend/btrixcloud/main_op.py
@@ -46,7 +46,7 @@ def main():
     # pylint: disable=import-outside-toplevel
     if not os.environ.get("KUBERNETES_SERVICE_HOST"):
         print(
-            "Sorry, the Browsertrix Cloud Backend must be run inside a Kubernetes environment.\
+            "Sorry, the Browsertrix Backend must be run inside a Kubernetes environment.\
              Kubernetes not detected (KUBERNETES_SERVICE_HOST is not set), Exiting"
         )
         sys.exit(1)

diff --git a/btrix b/btrix
@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# ./btrix: Browsertrix Cloud dev environment utility
+# ./btrix: Browsertrix dev environment utility
 #
 # Test commands require installing pytest first, e.g.:
 # python3 -m pip install pytest
@@ -196,7 +196,7 @@ if [[ $1 = "nightly" ]]; then
     runNightlyTests
 fi
 
-# down: stop and uninstall browsertrix cloud
+# down: stop and uninstall browsertrix
 if [[ $1 = "down" ]]; then
     if [[ $2 = "$MICROK8S" ]] ; then
         resetMicrok8s

diff --git a/chart/Chart.yaml b/chart/Chart.yaml
@@ -1,10 +1,10 @@
 apiVersion: v2
-name: browsertrix-cloud
+name: browsertrix
 description: A chart for running the Webrecorder Browsertrix System
 type: application
 icon: https://webrecorder.net/assets/icon.png
 
-# Browsertrix Cloud and Chart Version
+# Browsertrix and Chart Version
 version: v1.10.0-beta.1
 
 dependencies:

diff --git a/chart/email-templates/invite b/chart/email-templates/invite
@@ -23,18 +23,18 @@ Welcome to Browsertrix!
 
 <p>
 Step 1: Create your login credentials<br/>
-Step 2: Review the <a href="https://docs.browsertrix.cloud/user-guide/">Browerstrix User Guide</a><br/>
-Step 3: <a href="https://docs.browsertrix.cloud/user-guide/org-settings/">Invite additional users</a> from your organization
+Step 2: Review the <a href="https://docs.browsertrix.com/user-guide/">Browerstrix User Guide</a><br/>
+Step 3: <a href="https://docs.browsertrix.com/user-guide/org-settings/">Invite additional users</a> from your organization
 </p>
 
-<p>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 <b>+ Create New</b> to <a href="https://docs.browsertrix.cloud/user-guide/workflow-setup/">create your first Crawl Workflow</a>!</p>
+<p>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 <b>+ Create New</b> to <a href="https://docs.browsertrix.com/user-guide/workflow-setup/">create your first Crawl Workflow</a>!</p>
 
 <p>To help you get up to speed, here are the top three questions our users normally have on the first day:</p>
 
 <p>
-How do I <a href="https://docs.browsertrix.cloud/user-guide/workflow-setup/">crawl my first website</a>?<br/>
-How do I create a <a href="https://docs.browsertrix.cloud/user-guide/browser-profiles/">browser profile</a>?<br/>
-How do I <a href="https://docs.browsertrix.cloud/user-guide/archived-items/#crawl-settings">export my archived items</a>?
+How do I <a href="https://docs.browsertrix.com/user-guide/workflow-setup/">crawl my first website</a>?<br/>
+How do I create a <a href="https://docs.browsertrix.com/user-guide/browser-profiles/">browser profile</a>?<br/>
+How do I <a href="https://docs.browsertrix.com/user-guide/archived-items/#crawl-settings">export my archived items</a>?
 </p>
 
 <p>If you need any assistance, please direct your questions to <a href="mailto:{{ support_email }}">{{ support_email }}</a></p>
@@ -61,18 +61,18 @@ We're excited you're here and can't wait to help you get started crawling! You c
 Here's what you should do first off to get the most value out of your experience:
 
 Step 1: Create your login credentials
-Step 2: Review the Browerstrix User Guide (https://docs.browsertrix.cloud/user-guide/)
-Step 3: Invite additional users from your organization (https://docs.browsertrix.cloud/user-guide/org-settings/)
+Step 2: Review the Browerstrix User Guide (https://docs.browsertrix.com/user-guide/)
+Step 3: Invite additional users from your organization (https://docs.browsertrix.com/user-guide/org-settings/)
 
 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! (https://docs.browsertrix.cloud/user-guide/workflow-setup/)
+From there, you can click +Create New to create your first Crawl Workflow! (https://docs.browsertrix.com/user-guide/workflow-setup/)
 
 To help you get up to speed, here are the top three questions our users normally have on the first day:
 
-How do I crawl my first website? (https://docs.browsertrix.cloud/user-guide/workflow-setup/)
-How do I create a browser profile? (https://docs.browsertrix.cloud/user-guide/browser-profiles/)
-How do I export my archived items? (https://docs.browsertrix.cloud/user-guide/archived-items/#crawl-settings)
+How do I crawl my first website? (https://docs.browsertrix.com/user-guide/workflow-setup/)
+How do I create a browser profile? (https://docs.browsertrix.com/user-guide/browser-profiles/)
+How do I export my archived items? (https://docs.browsertrix.com/user-guide/archived-items/#crawl-settings)
 
 If you need any assistance, please direct your questions to {{ support_email }}.
 

diff --git a/chart/examples/k3s-hosted.yaml b/chart/examples/k3s-hosted.yaml
@@ -1,7 +1,7 @@
 # Hosted Config (eg. for k3s)
 # --------------------------------
 #
-# This config can be used to run Browsertrix Cloud hosted on a remote server.
+# This config can be used to run Browsertrix hosted on a remote server.
 # This requires setting the hostname and signing hostname.
 #
 #
@@ -17,7 +17,7 @@
 # Once traefik has been disabled, you must install `nginx-ingress` which can be installed by: 
 # helm upgrade --install nginx ingress-nginx/ingress-nginx -n ingress-nginx --create-namespace
 #
-# You'll also need to install cert-manager. Browsertrix cloud recommends installing cert-manager through jetpack with the following command: 
+# You'll also need to install cert-manager. Browsertrix recommends installing cert-manager through jetpack with the following command: 
 #
 # helm repo add jetstack https://charts.jetstack.io
 # helm repo update

diff --git a/chart/examples/microk8s-hosted.yaml b/chart/examples/microk8s-hosted.yaml
@@ -1,7 +1,7 @@
 # Hosted Config (eg. for microk8s)
 # --------------------------------
 #
-# This config can be used to run Browsertrix Cloud hosted on a remote server.
+# This config can be used to run Browsertrix hosted on a remote server.
 # This requires setting the hostname and signing hostname.
 #
 #

diff --git a/docs/CNAME b/docs/CNAME
@@ -1 +1 @@
-docs.browsertrix.cloud
+docs.browsertrix.com