From 0814c8455e9829785437cce0c94f926c3c9230ec Mon Sep 17 00:00:00 2001 From: Pierre Marshall Date: Tue, 27 May 2025 10:57:22 +0100 Subject: [PATCH 1/3] docs: update k3s chart example for installing ingress-nginx plus minor style changes for readability, carriage return at the end of a line with a sentence --- chart/examples/k3s-hosted.yaml | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/chart/examples/k3s-hosted.yaml b/chart/examples/k3s-hosted.yaml index 72c8ec7e2e..8b06d8c9fc 100644 --- a/chart/examples/k3s-hosted.yaml +++ b/chart/examples/k3s-hosted.yaml @@ -12,10 +12,14 @@ # # One way to deploy this is with k3s, which will require the following changes: # -# 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 +# 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: -# helm upgrade --install nginx ingress-nginx/ingress-nginx -n ingress-nginx --create-namespace +# Once traefik has been disabled, you must install `nginx-ingress`, which can be installed by: +# +# helm upgrade --install ingress-nginx ingress-nginx \ +# --repo https://kubernetes.github.io/ingress-nginx \ +# --namespace ingress-nginx --create-namespace # # You'll also need to install cert-manager. Browsertrix recommends installing cert-manager through jetpack with the following command: # From 1eb595a6cd9653c4fcf734bce3046afd5ec7e7f8 Mon Sep 17 00:00:00 2001 From: Pierre Marshall Date: Tue, 27 May 2025 11:18:12 +0100 Subject: [PATCH 2/3] docs: update remote deployment docs with working example for installing ingress-nginx, fixes #2619 plus style change to indent code blocks which forces markdown to continue multi-line list items --- frontend/docs/docs/deploy/remote.md | 35 +++++++++++++++++------------ 1 file changed, 21 insertions(+), 14 deletions(-) diff --git a/frontend/docs/docs/deploy/remote.md b/frontend/docs/docs/deploy/remote.md index 6178c0525d..a2ac6148b8 100644 --- a/frontend/docs/docs/deploy/remote.md +++ b/frontend/docs/docs/deploy/remote.md @@ -31,21 +31,28 @@ Another option for a single-machine remote deployment is [k3s](https://k3s.io) 1. Install K3s, as suggested in the [local deployment guide](../deploy/local.md). Make sure to **disable traefik** which can be done by adding `--no-deploy traefik` to the `systemd` unit when installing k3s -2. Install `nginx-ingress` with: `helm upgrade --install nginx ingress-nginx/ingress-nginx -n ingress-nginx --create-namespace` +2. Install `nginx-ingress` with: + + ```zsh + helm upgrade --install ingress-nginx ingress-nginx \ + --repo https://kubernetes.github.io/ingress-nginx \ + --namespace ingress-nginx --create-namespace + ``` + 3. Install `cert-manager`. We recommend installing `cert-manager` through Jetpack, like so: - -```zsh -helm repo add jetstack https://charts.jetstack.io -helm repo update - -helm repo update jetstack -helm upgrade --install \ - cert-manager jetstack/cert-manager \ - --namespace cert-manager \ - --create-namespace \ - --version v1.12.0 \ - --set installCRDs=true -``` + + ```zsh + helm repo add jetstack https://charts.jetstack.io + helm repo update + + helm repo update jetstack + helm upgrade --install \ + cert-manager jetstack/cert-manager \ + --namespace cert-manager \ + --create-namespace \ + --version v1.12.0 \ + --set installCRDs=true + ``` 4. Copy `cp ./chart/examples/k3s-hosted.yaml ./chart/my-config.yaml` to make local changes. From 9fd1a3b550519fd84bac3f2727ea47cba7259599 Mon Sep 17 00:00:00 2001 From: Ilya Kreymer Date: Wed, 28 May 2025 20:00:44 -0700 Subject: [PATCH 3/3] spacing fixes --- chart/examples/k3s-hosted.yaml | 2 +- frontend/docs/docs/deploy/remote.md | 44 +++++++++++++++-------------- 2 files changed, 24 insertions(+), 22 deletions(-) diff --git a/chart/examples/k3s-hosted.yaml b/chart/examples/k3s-hosted.yaml index 8b06d8c9fc..9970d86232 100644 --- a/chart/examples/k3s-hosted.yaml +++ b/chart/examples/k3s-hosted.yaml @@ -10,7 +10,7 @@ # k3s # --- # -# One way to deploy this is with k3s, which will require the following changes: +# One way to deploy this is with k3s (https://k3s.io/), which will require the following changes: # # 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. diff --git a/frontend/docs/docs/deploy/remote.md b/frontend/docs/docs/deploy/remote.md index a2ac6148b8..fab11e9504 100644 --- a/frontend/docs/docs/deploy/remote.md +++ b/frontend/docs/docs/deploy/remote.md @@ -21,9 +21,10 @@ For a single-machine remote deployment, we recommend using [MicroK8s](https://mi 4. Run with: - ```shell - helm upgrade --install -f ./chart/values.yaml -f ./chart/my-config.yaml btrix ./chart/ - ``` + ```shell + helm upgrade --install -f ./chart/values.yaml -f ./chart/my-config.yaml \ + btrix ./chart/ + ``` ## Single Machine Deployment with k3s @@ -32,27 +33,27 @@ Another option for a single-machine remote deployment is [k3s](https://k3s.io) 1. Install K3s, as suggested in the [local deployment guide](../deploy/local.md). Make sure to **disable traefik** which can be done by adding `--no-deploy traefik` to the `systemd` unit when installing k3s 2. Install `nginx-ingress` with: - + ```zsh helm upgrade --install ingress-nginx ingress-nginx \ --repo https://kubernetes.github.io/ingress-nginx \ --namespace ingress-nginx --create-namespace ``` - + 3. Install `cert-manager`. We recommend installing `cert-manager` through Jetpack, like so: - - ```zsh - helm repo add jetstack https://charts.jetstack.io - helm repo update - - helm repo update jetstack - helm upgrade --install \ - cert-manager jetstack/cert-manager \ - --namespace cert-manager \ - --create-namespace \ - --version v1.12.0 \ - --set installCRDs=true - ``` + + ```zsh + helm repo add jetstack https://charts.jetstack.io + helm repo update + + helm repo update jetstack + helm upgrade --install \ + cert-manager jetstack/cert-manager \ + --namespace cert-manager \ + --create-namespace \ + --version v1.12.0 \ + --set installCRDs=true + ``` 4. Copy `cp ./chart/examples/k3s-hosted.yaml ./chart/my-config.yaml` to make local changes. @@ -62,9 +63,10 @@ Another option for a single-machine remote deployment is [k3s](https://k3s.io) 7. Run with: - ```shell - helm upgrade --install -f ./chart/values.yaml -f ./chart/my-config.yaml btrix ./chart/ - ``` + ```shell + helm upgrade --install -f ./chart/values.yaml -f ./chart/my-config.yaml \ + btrix ./chart/ + ``` ### Using Custom Storage