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 <tessa@bitarchivist.net>

2024-04-21 09:42:25 -07:00

2.4 KiB

Raw Blame History

DigitalOcean

Playbook Path: ansible/playbooks/install_microk8s.yml

This playbook provides an easy way to install Browsertrix on DigitalOcean. It automatically sets up Browsertrix with LetsEncrypt certificates.

Requirements

To run this ansible playbook, you need to:

Have a DigitalOcean Account where this will run.
Create a DigitalOcean API Key which will need to be set in your terminal sessions environment variables export DO_API_TOKEN
doctl command line client configured (run doctl auth init)
Create a DigitalOcean Spaces API Key which will also need to be set in your terminal sessions environment variables, which should be set as DO_AWS_ACCESS_KEY and DO_AWS_SECRET_KEY
Configure a DNS A Record and CNAME record.
Have a working Python and pip configuration through your OS Package Manager

Install

Clone the repo:

git clone https://github.com/webrecorder/browsertrix.git
cd browsertrix

Install the Dependencies through pipenv

cd ansible
pip install pipenv
pipenv install
pipenv shell

Look at the configuration options and modify them or pass them as extra variables as shown below. If you haven't configured kubectl, please enable the configure_kube option
Run the playbook:

ansible-playbook do_setup.yml -e project_name="your-project" -e superuser_email="you@yourdomain.com" -e domain="yourdomain.com"

You may optionally configure these command line parameters through the group_vars file

Upgrading

Run git pull
Run the playbook:

ansible-playbook do_setup.yml -e project_name="your-project" -e superuser_email="you@yourdomain.com" -e domain="yourdomain.com" -t helm_upgrade

Uninstall

You can tear down your deployment through ansible as well. By default ansible will dump all the databases into your DO space. You can configure an option to disable this feature.

ansible-playbook playbooks/do_teardown.yml -e project_name="your-project" -e superuser_email="you@yourdomain.com" -e domain="yourdomain.com"

2.4 KiB Raw Blame History