browsertrix/docs/deploy/ansible/microk8s.md
Ilya Kreymer b574f00d2b
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

1.7 KiB

Microk8s

Playbook Path: ansible/playbooks/install_microk8s.yml

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

To run this ansible playbook, you need to:

  • Have a server / VPS where browsertrix will run.
  • Configure a DNS A Record to point at your server's IP address.
  • Make sure you can ssh to it, with a sudo user: ssh @
  • Install Ansible on your local machine (the control machine).

!!! note

Ansible requires an SSH key with no password. You cannot use a passphrase.
	Sudo must similarly be available without a passphrase for ansible to work

??? info Debian Users

	You will need to install `acl` on the target Ansible machine to set permissions: 
	`sudo apt-get install acl`

Install

  1. Clone the repo:
git clone https://github.com/webrecorder/browsertrix.git
cd browsertrix/ansible
  1. Look at the configuration options and modify them or pass them as extra variables as shown below.

  2. Add your IP address above to a new file called [inventory/hosts]

  3. Run the playbook:

ansible-playbook -i inventory/hosts install_microk8s.yml -e host_ip="1.2.3.4" -e domain_name="yourdomain.com" -e your_user="your_vps_admin_user"

Upgrading

  1. Run git pull

  2. Run the playbook:

ansible-playbook -i inventory/hosts install_microk8s.yml -e host_ip="1.2.3.4" -e domain_name="yourdomain.com" -t helm_upgrade