Skip to content

docs: update remote deployment docs with working nginx-install example #2625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions chart/examples/k3s-hosted.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,16 @@
# 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
# 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:
#
Expand Down
45 changes: 27 additions & 18 deletions frontend/docs/docs/deploy/remote.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,31 +21,39 @@ 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

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
```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
```
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.

Expand All @@ -55,9 +63,10 @@ helm upgrade --install \

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

Expand Down