05c5e09d25
Closes #1434 ### Changes #### Developer - Adds the K3S playbook guide to the navigation - Adds note about restarting MKDocs when adding new icons - Adds note about concise language to the styleguide ([see previous discussion](https://github.com/webrecorder/browsertrix-cloud/pull/1394#discussion_r1402666872)) - Adds a note about noun usage to the styleguide #### User guide - Adds tables for archived item and workflow statuses - Adds custom styles for displaying statuses with their icons like we do in the app - Fixes capitalization issues --------- Co-authored-by: Tessa Walsh <tessa@bitarchivist.net> Co-authored-by: sua yoo <sua@webrecorder.org>
1.9 KiB
K3S
Playbook Path: 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.
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 SSH is working, with a sudo user:
#!shell ssh your-user@your-domain - Install Ansible on your local machine (the control machine).
- Clone the repo:
git clone https://github.com/webrecorder/browsertrix-cloud.git
cd browsertrix-cloud
- Optional: Create a copy of the [inventory directory] and name it what you like (alternatively edit the sample files in place)
cp -r ansible/inventory/sample-k3s ansible/inventory/my-deployment
-
Look at the configuration options and modify them to match your setup
-
Change the hosts IP address in your just created inventory
-
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 -
Run the playbook:
ansible-playbook -i inventory/my-deployment/hosts.ini install_k3s.yml
Upgrading
-
Run
git pull -
Run the playbook:
ansible-playbook -i inventory/hosts install_k3s.yml -t helm_upgrade