Skip to content

Commit

Permalink
Revert "rename a bunch more things (github jobs and email templates, …
Browse files Browse the repository at this point in the history
…primarily)"

This reverts commit 7722436.
  • Loading branch information
emma-sg committed Mar 7, 2024
1 parent fc914d1 commit da961b2
Show file tree
Hide file tree
Showing 16 changed files with 72 additions and 81 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/publish-helm-chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
helm upgrade --install btrix https://github.com/webrecorder/browsertrix-cloud/releases/download/v${{ env.version }}/browsertrix-cloud-v${{ env.version }}.tgz
```
See [the development guide](https://docs.browsertrix.cloud/deploy/) for more info how to deploy Browsertrix.
See [the development guide](https://docs.browsertrix.cloud/deploy/) for more info how to deploy Browsertrix Cloud.
files: .chart-out/browsertrix-cloud-v${{ env.version }}.tgz
tag_name: v${{ env.version }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Browsertrix Release Build
name: Browsertrix Cloud Release Build

on:
release:
Expand Down
2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Browsertrix
Browsertrix Cloud
Copyright (C) 2022 Webrecorder Software

Released under the GNU Affero General Public License.
Expand Down
2 changes: 1 addition & 1 deletion ansible/do_setup.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
- name: deploy browsertrix on digital ocean
- name: deploy browsertrix cloud on digital ocean
hosts: localhost
connection: local
gather_facts: false
Expand Down
2 changes: 1 addition & 1 deletion ansible/install_k3s.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
# roles:
# - role: k3s/node

# Ansible controller to install browsertrix
# Ansible controller to install browsertrix cloud
- hosts: 127.0.0.1
connection: local
become: yes # Can be removed if not using the btrix/prereq role
Expand Down
4 changes: 2 additions & 2 deletions ansible/playbooks/do_teardown.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
- name: teardown browsertrix on digital ocean
- name: teardown browsertrix cloud on digital ocean
hosts: localhost
connection: local
gather_facts: false
Expand Down Expand Up @@ -132,7 +132,7 @@
register: domain_info
changed_when: true

- name: d_ocean | dns | remove the dns for browsertrix
- name: d_ocean | dns | remove the dns for browsertrix cloud
ansible.builtin.command: "doctl compute domain records rm {{ domain }} {{ item }} -f"
loop: "{{ domain_info.stdout | from_json | json_query(name_query) }}"
vars:
Expand Down
2 changes: 1 addition & 1 deletion ansible/roles/digital_ocean/setup/tasks/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
- name: d_ocean | dns | register the dns for browsertrix cloud
ansible.builtin.command: >-
doctl compute domain records create --record-type A --record-name "{{ subdomain if subdomain else '@' }}" --record-data "{{ lb_ip }}" "{{ domain }}"
Expand Down
4 changes: 2 additions & 2 deletions backend/btrixcloud/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
# ============================================================================
# pylint: disable=too-many-locals, duplicate-code
def main():
"""init browsertrix api"""
"""init browsertrix cloud api"""

app = APIRouter()

Expand Down Expand Up @@ -82,7 +82,7 @@ def main():
# pylint: disable=import-outside-toplevel
if not os.environ.get("KUBERNETES_SERVICE_HOST"):
print(
"Sorry, the Browsertrix Backend must be run inside a Kubernetes environment.\
"Sorry, the Browsertrix Cloud Backend must be run inside a Kubernetes environment.\
Kubernetes not detected (KUBERNETES_SERVICE_HOST is not set), Exiting"
)
sys.exit(1)
Expand Down
2 changes: 1 addition & 1 deletion backend/btrixcloud/main_op.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ def main():
# pylint: disable=import-outside-toplevel
if not os.environ.get("KUBERNETES_SERVICE_HOST"):
print(
"Sorry, the Browsertrix Backend must be run inside a Kubernetes environment.\
"Sorry, the Browsertrix Cloud Backend must be run inside a Kubernetes environment.\
Kubernetes not detected (KUBERNETES_SERVICE_HOST is not set), Exiting"
)
sys.exit(1)
Expand Down
42 changes: 19 additions & 23 deletions btrix
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env bash

# ./btrix: Browsertrix dev environment utility
# ./btrix: Browsertrix Cloud dev environment utility
#
# Test commands require installing pytest first, e.g.:
# python3 -m pip install pytest
Expand Down Expand Up @@ -34,7 +34,8 @@
# $ ./btrix nightly
# Run nightly backend tests

bootstrap() {

bootstrap(){
echo "Building backend..."
./scripts/build-backend.sh

Expand All @@ -45,7 +46,7 @@ bootstrap() {
helm upgrade --install -f ./chart/values.yaml -f ./chart/local.yaml btrix ./chart
}

bootstrapMicrok8s() {
bootstrapMicrok8s(){
echo "Building backend..."
./scripts/build-backend.sh

Expand All @@ -56,17 +57,17 @@ bootstrapMicrok8s() {
microk8s helm3 upgrade --install -f ./chart/values.yaml -f ./chart/local.yaml btrix ./chart
}

waitUntilReady() {
waitUntilReady(){
echo "Waiting until ready..."
kubectl wait --for=condition=ready pod --all --timeout=300s
}

waitUntilReadyMicrok8s() {
waitUntilReadyMicrok8s(){
echo "Waiting until ready..."
microk8s kubectl wait --for=condition=ready pod --all --timeout=300s
}

reset() {
reset(){
echo "Stopping all crawls & profile browsers"
kubectl delete cjs -n crawlers --all
kubectl delete pjs -n crawlers --all
Expand All @@ -80,7 +81,7 @@ reset() {
kubectl delete configmap -n crawlers -l btrix.crawlconfig
}

resetMicrok8s() {
resetMicrok8s(){
echo "Stopping all crawls & profile browsers"
microk8s kubectl delete cjs -n crawlers --all
microk8s kubectl delete pjs -n crawlers --all
Expand Down Expand Up @@ -133,24 +134,22 @@ if [[ $1 = "bootstrap" ]]; then

echo "Current context: $CONTEXT"
echo "Are you sure you want to update this context?"
if [[ "$(
read -e -p '[y/N] > '
echo $REPLY
)" == [Yy]* ]]; then
if [[ "$(read -e -p '[y/N] > '; echo $REPLY)" == [Yy]* ]] ; then
echo Continuing
else
echo Stopping
exit 1
fi

if [[ $2 = "$MICROK8S" || $3 = "$MICROK8S" ]]; then
if [[ $2 = "$MICROK8S" || $3 = "$MICROK8S" ]] ; then
bootstrapMicrok8s
else
bootstrap
fi


if [[ $2 = "$WAIT" || $3 = "$WAIT" ]]; then
if [[ $2 = "$MICROK8S" || $3 = "$MICROK8S" ]]; then
if [[ $2 = "$MICROK8S" || $3 = "$MICROK8S" ]] ; then
waitUntilReadyMicrok8s
else
waitUntilReady
Expand All @@ -160,29 +159,26 @@ fi

# reset: uninstall, delete data, then bootstrap
if [[ $1 = "reset" ]]; then

echo "Current context: $CONTEXT"
echo "Resetting k8s cluster will delete the database. All running crawls will first be canceled. Are you sure you want to do this?"
if [[ "$(
read -e -p '[y/N] > '
echo $REPLY
)" == [Yy]* ]]; then
if [[ "$(read -e -p '[y/N] > '; echo $REPLY)" == [Yy]* ]] ; then
echo Continuing
else
echo Stopping
exit 1
fi

if [[ $2 = "$MICROK8S" || $3 = "$MICROK8S" ]]; then
if [[ $2 = "$MICROK8S" || $3 = "$MICROK8S" ]] ; then
resetMicrok8s
bootstrapMicrok8s
else
reset
bootstrap
fi

if [[ $2 = "$WAIT" || $3 = "$WAIT" ]]; then
if [[ $2 = "$MICROK8S" || $3 = "$MICROK8S" ]]; then
if [[ $2 = "$WAIT" || $3 = "$WAIT" ]] ; then
if [[ $2 = "$MICROK8S" || $3 = "$MICROK8S" ]] ; then
waitUntilReadyMicrok8s
else
waitUntilReady
Expand All @@ -200,9 +196,9 @@ if [[ $1 = "nightly" ]]; then
runNightlyTests
fi

# down: stop and uninstall browsertrix
# down: stop and uninstall browsertrix cloud
if [[ $1 = "down" ]]; then
if [[ $2 = "$MICROK8S" ]]; then
if [[ $2 = "$MICROK8S" ]] ; then
resetMicrok8s
else
reset
Expand Down
2 changes: 1 addition & 1 deletion chart/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: A chart for running the Webrecorder Browsertrix System
type: application
icon: https://webrecorder.net/assets/icon.png

# Browsertrix and Chart Version
# Browsertrix Cloud and Chart Version
version: v1.10.0-beta.0

dependencies:
Expand Down
65 changes: 30 additions & 35 deletions chart/email-templates/invite
Original file line number Diff line number Diff line change
@@ -1,69 +1,64 @@
Welcome to Browsertrix!
Welcome to Browsertrix Cloud!
~~~
<html>

<body>
<p>Hello!</p>
<p>Hello!</p>

<p>Welcome to Browsertrix!</p>
<p>Welcome to Browsertrix Cloud!</p>

{% if sender %}
<p>You have been invited by {{ sender }} to join "{{ org_name }}" on Browsertrix!
</p>
{% endif %}
{% if sender %}
<p>You have been invited by {{ sender }} to join "{{ org_name }}" on Browsertrix Cloud!
</p>
{% endif %}

{% if is_new %}
<p>You can now set up your account using the link below.</p>
{% if is_new %}
<p>You can now set up your account using the link below.</p>

<p style="font-weight: bold; padding: 12px; background-color: lightgrey"><a href="{{ invite_url }}">Click here to
create an account.</a></p>
{% else %}
<p style="font-weight: bold; padding: 12px; background-color: lightgrey"><a href="{{ invite_url }}">Click here to
accept this invite.</a></p>
{% endif %}
<p style="font-weight: bold; padding: 12px; background-color: lightgrey"><a href="{{ invite_url }}">Click here to create an account.</a></p>
{% else %}
<p style="font-weight: bold; padding: 12px; background-color: lightgrey"><a href="{{ invite_url }}">Click here to accept this invite.</a></p>
{% endif %}

<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 <i>+ Create New</i> to create your first Crawl Workflow!
<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 <i>+ Create New</i> to create your first Crawl Workflow!


<p>For more info, check out the <b><a href="https://docs.browsertrix.cloud/user-guide/">Browsertrix User Guide</a></b>
</p>
<p>For more info, check out the <b><a href="https://docs.browsertrix.cloud/user-guide/">Browsertrix Cloud User Guide</a></b></p>


<p>
We want you to get the most from your Browsertrix experience!
</p>
<p>
We want you to get the most from your Browsertrix Cloud experience!
</p>

<p>Let us know if you need any questions or feedback.</p>
You can connect with our team at <a href="mailto:{{ support_email }}">{{ support_email }}</a></p>
</p>
<p>Let us know if you need any questions or feedback.</p>
You can connect with our team at <a href="mailto:{{ support_email }}">{{ support_email }}</a></p>
</p>

<p><i>The Webrecorder Team</i></p>
<p><i>The Webrecorder Team</i></p>
</body>

</html>
~~~
Hello!

Welcome to Browsertrix!
Welcome to Browsertrix Cloud!

{% if sender %}
You have been invited by {{ sender }} to join their organization, "{{ org_name }}" on Browsertrix!
You have been invited by {{ sender }} to join their organization, "{{ org_name }}" on Browsertrix Cloud!

{% else %}

You can join by clicking here: {{ invite_url }}
{% endif %}

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.
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 User Guide at: https://docs.browsertrix.cloud/user-guide/
For more info, check out Browsertrix Cloud 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 experience. Let us know if you need any questions or feedback.
We want you to get the most from your Browsertrix Cloud experience. Let us know if you need any questions or feedback.
You can connect with our team at {{ support_email }}.



4 changes: 2 additions & 2 deletions chart/email-templates/validate
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Welcome to Browsertrix, Verify your Registration.
Welcome to Browsertrix Cloud, Verify your Registration.
~~~
Please verify your registration for Browsertrix for {{ receiver_email }}
Please verify your registration for Browsertrix Cloud for {{ receiver_email }}

You can verify by clicking here: {{ origin }}/verify?token={{ token }}

Expand Down
10 changes: 5 additions & 5 deletions chart/examples/k3s-hosted.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Hosted Config (eg. for k3s)
# --------------------------------
#
# This config can be used to run Browsertrix hosted on a remote server.
# This config can be used to run Browsertrix Cloud hosted on a remote server.
# This requires setting the hostname and signing hostname.
#
#
Expand All @@ -14,14 +14,14 @@
#
# Make sure to disable traefik on your k3s cluster by adding `--no-deploy traefik` to the systemd unit that starts k3s _before_ starting your server. One way to check that traefik is not running your cluster is with `kubectl get deployments -n kube-system` and see if traefik shows up in the output
#
# Once traefik has been disabled, you must install `nginx-ingress` which can be installed by:
# 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 cloud recommends installing cert-manager through jetpack with the following command:
#
# helm repo add jetstack https://charts.jetstack.io
# helm repo update
#
#
# helm repo update jetstack
# helm upgrade --install \
# cert-manager jetstack/cert-manager \
Expand Down Expand Up @@ -69,7 +69,7 @@ signer:
#mongo_auth:
# username: root
# password: PASSWORD!


# optionally, set these to custom values

Expand Down
4 changes: 2 additions & 2 deletions chart/examples/microk8s-hosted.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Hosted Config (eg. for microk8s)
# --------------------------------
#
# This config can be used to run Browsertrix hosted on a remote server.
# This config can be used to run Browsertrix Cloud hosted on a remote server.
# This requires setting the hostname and signing hostname.
#
#
Expand Down Expand Up @@ -54,7 +54,7 @@ signer:
#mongo_auth:
# username: root
# password: PASSWORD!


# optionally, set these to custom values

Expand Down
Loading

0 comments on commit da961b2

Please sign in to comment.