doc tweaks:
- fix typos in docs - update prod deployment info - update minikube info - add info on how to run with local images - bump version to 1.1.0-beta.3 for testing multiarch build
This commit is contained in:
Ilya Kreymer
parent
a74d88dcda
commit
829548af0f
2
.github/workflows/docs-publish.yaml
vendored
2
.github/workflows/docs-publish.yaml
vendored
@ -3,7 +3,7 @@ on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- docs!
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
|
||||
@ -1,2 +1,2 @@
|
||||
""" current version """
|
||||
__version__ = "1.1.0-beta.2"
|
||||
__version__ = "1.1.0-beta.3"
|
||||
|
||||
@ -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: <time>
|
||||
NAMESPACE: default
|
||||
STATUS: deployed
|
||||
REVISION: 1
|
||||
TEST SUITE: None
|
||||
```
|
||||
|
||||
After that, especially on first run, it may take a few minutes for the Browsertrix Cloud cluster to start, as all images need to be loaded.
|
||||
|
||||
You can try running the command: `kubectl wait --for=condition=ready pod --all --timeout=300s` to wait for all pods to be initialized.
|
||||
|
||||
The command will exit when all pods have been loaded, or if there is an error and it times out.
|
||||
|
||||
If this command fails, you can also run `kubectl get pods` to see the status of each of the pods.
|
||||
|
||||
@ -73,10 +96,26 @@ If the pod is running, or previously ran, you can also get the logs from the con
|
||||
|
||||
The outputs of these commands will be helpful if you'd like to report an issue [on GitHub](https://github.com/webrecorder/browsertrix-cloud/issues)
|
||||
|
||||
|
||||
## Uninstalling
|
||||
|
||||
To uninstall, run `helm uninstall btrix`.
|
||||
|
||||
By default, the database + storage volumes are not automatically deleted. To fully delete all persistent data created in the cluster, also run `kubectl delete pvc --all`.
|
||||
|
||||
|
||||
## Running With Local Images
|
||||
|
||||
By default, this setup will pull the latest release of Browsertrix Cloud. However, if you are developing locally, you may want to use your local images instead.
|
||||
|
||||
To do this:
|
||||
|
||||
1. open `./chart/examples/local-config.yaml` and add:
|
||||
|
||||
```
|
||||
api_pull_policy: "IfNotPresent"
|
||||
nginx_pull_policy: "IfNotPresent"
|
||||
```
|
||||
|
||||
2. Rebuild the local images by running `docker-compose build`
|
||||
|
||||
3. Restart cluster by running Helm again.
|
||||
|
||||
@ -14,11 +14,17 @@ For a single-machine production deployment, we recommend using microk8s.
|
||||
|
||||
1. Install MicroK8S, as suggested in [the local deployment guide](./local) and ensure the `ingress` and `cert-manager` addons are also enabled.
|
||||
|
||||
2. Set the `ingress.host`, `ingress.cert_email` and `signing.host` fields in `./examples/microk8s-hosted.yaml` to your host and domain
|
||||
2. Copy `cp ./chart/examples/microk8s-hosted.yaml ./chart/my-config.yaml` to make local changes.
|
||||
|
||||
3. Set the supeadmin username and password, and mongodb username and password, also in `./examples/microk8s-hosted.yaml`
|
||||
2. Set the `ingress.host`, `ingress.cert_email` and `signing.host` fields in `./chart/my-config.yaml` to your host and domain
|
||||
|
||||
4. Run with `helm upgrade --install -f ./chart/values.yaml -f ./chart/microk8s-hosted.yaml btrix ./chart/`
|
||||
3. Set the superadmin username and password, and mongodb username and password in `./chart/my-config.yaml`
|
||||
|
||||
4. Run with:
|
||||
|
||||
```
|
||||
helm upgrade --install -f ./chart/values.yaml -f ./chart/my-config.yaml btrix ./chart/
|
||||
```
|
||||
|
||||
|
||||
### Using Custom Storage
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "browsertrix-frontend",
|
||||
"version": "1.1.0-beta.2",
|
||||
"version": "1.1.0-beta.3",
|
||||
"main": "index.ts",
|
||||
"license": "AGPL-3.0-or-later",
|
||||
"dependencies": {
|
||||
|
||||
@ -12,6 +12,7 @@ theme:
|
||||
markdown_extensions:
|
||||
- toc:
|
||||
toc_depth: 3
|
||||
permalink: true
|
||||
- pymdownx.highlight:
|
||||
anchor_linenums: true
|
||||
- pymdownx.inlinehilite
|
||||
|
||||
@ -1 +1 @@
|
||||
1.1.0-beta.2
|
||||
1.1.0-beta.3
|
||||
|
||||
Loading…
Reference in New Issue
Block a user