diff --git a/.github/workflows/docs-publish.yaml b/.github/workflows/docs-publish.yaml index 21bd945b..89676940 100644 --- a/.github/workflows/docs-publish.yaml +++ b/.github/workflows/docs-publish.yaml @@ -3,7 +3,7 @@ on: push: branches: - main - - docs! + permissions: contents: write diff --git a/backend/btrixcloud/version.py b/backend/btrixcloud/version.py index bd4a1057..29bc776c 100644 --- a/backend/btrixcloud/version.py +++ b/backend/btrixcloud/version.py @@ -1,2 +1,2 @@ """ current version """ -__version__ = "1.1.0-beta.2" +__version__ = "1.1.0-beta.3" diff --git a/docs/deploy/local.md b/docs/deploy/local.md index 8cb078e0..77c75971 100644 --- a/docs/deploy/local.md +++ b/docs/deploy/local.md @@ -10,54 +10,77 @@ and have local package managers for your platform (eg. `brew` for mac) already i After following the environment-specific instructions below, simply run: -`helm upgrade --install -f ./chart/values.yaml -f ./chart/local-config.yaml btrix ./chart/` +``` +helm upgrade --install -f ./chart/values.yaml -f ./chart/examples/local-config.yaml btrix ./chart/ +``` The local setup includes the full Browsertrix Cloud system, with frontend, backend api, db (via MongoDB) and storage (via Minio) An admin user with name `admin@example.com` and password `PASSW0RD!` will be automatically created. -These settings can be changed in `charts/examples/local-config.yaml`. Note that the admin user and password will not be reset after creation. +These settings can be changed in [charts/examples/local-config.yaml](https://github.com/webrecorder/browsertrix-cloud/blob/main/chart/examples/local-config.yaml). -To access the server load: [http://localhost:30870/](http://localhost:30870/) in your browser. +Note that the admin user and password will not be reset after creation. + +To access the server load: **[http://localhost:30870/](http://localhost:30870/)** in your browser. Here are some additional environment-specific deployment specific instructions: -### Docker Desktop -- Mac +### Docker Desktop (for Mac and Windows) -For Mac, we recommend testing out Browsertrix Cloud on Docker Desktop as that will be one of the simplest options. +For Mac and Windows, we recommend testing out Browsertrix Cloud using Kubernetes support in Docker Desktop as that will be one of the simplest options. To run Browsertrix Cloud on Docker Desktop: 1. Ensure `Enable Kubernetes` is checked from the Preferences screen. -2. Install [Helm](https://helm.sh/), which can be installed with `brew install helm` or [other options](https://helm.sh/docs/intro/install/) +2. Install [Helm](https://helm.sh/), which can be installed with `brew install helm` (Mac) or following some of the [other install options](https://helm.sh/docs/intro/install/) 3. Run the Helm command as described above. -### MicroK8S + +### MicroK8S (for all platforms) For Ubuntu and other linux distros, we recommend using MicroK8S for both local deployment and production. 1. Install MicroK8s, by running `sudo snap install microk8s --classic` [see more detailed instructions here](https://microk8s.io/docs/getting-started) or [alternate installation instructions here](https://microk8s.io/docs/install-alternatives) -2. Install the following addons `microk8s enable dns hostpath-storage registry helm`. (For production, also add `ingress cert-manager`) +2. Install the following addons `microk8s enable dns hostpath-storage registry helm3`. (For production, also add `ingress cert-manager` to the list of addons) 3. Wait for add-ons to finish installing with `microk8s status --wait-ready` -4. Run the Helm command as described above, prefixed with `microk8s`, eg. `microk8s helm ...` +4. Run the Helm command as described above, prefixed with `microk8s`, eg. `microk8s helm3 ...` -### Minikube +### Minikube (for all platforms) 1. Install Minikube [following installation instructions](https://minikube.sigs.k8s.io/docs/start/), eg. `brew install minikube` -2. Run the Helm command as described above. +2. Install [Helm](https://helm.sh/), which can be installed with `brew install helm` or [other options](https://helm.sh/docs/intro/install/) + +3. Run the Helm command as described above. + +4. Mac Only: To access Browsertrix Cloud running in minikube on a mac, run `minikube service browsertrix-cloud-frontend --url` and then access Browsertrix Cloud via the provided URL. This is needed as Browsertrix Cloud is running in a VM. ## Waiting for Cluster to Start -Especially on first run, it may take a few minutes for the Browsertrix Cloud cluster to start, as all images need to be loaded. +After running the helm command, you should see something like: -You can try running the command: `kubectl wait --for=condition=ready pod --all` to wait for all pods to be initialized. +``` +Release "btrix" does not exist. Installing it now. +NAME: btrix +LAST DEPLOYED: