|
| 1 | +# Openblocks |
| 2 | + |
| 3 | +Openblocks is a developer-friendly open-source low code platform to build internal apps within minutes. |
| 4 | + |
| 5 | +[Overview of Openblocks](https://docs.openblocks.dev/) |
| 6 | + |
| 7 | +## Introduction |
| 8 | + |
| 9 | +This chart bootstraps an Openblocks deployment on a [Kubernetes](https://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. |
| 10 | + |
| 11 | +## Prerequisites |
| 12 | + |
| 13 | +- Kubernetes 1.19+ |
| 14 | +- Helm 3.2.0+ |
| 15 | +- PV provisioner support in the underlying infrastructure |
| 16 | +- Bitnami helm chart repository (if mongodb and/or redis is installed) |
| 17 | + |
| 18 | +## Installing the Chart |
| 19 | + |
| 20 | +To install the chart with the release name `my-openblocks` into namespace `openblocks`: |
| 21 | + |
| 22 | +```bash |
| 23 | +# If installing mongodb and/or redis, add bitnami chart repository and update chart dependenices |
| 24 | +$ helm repo add bitnami https://charts.bitnami.com/bitnami |
| 25 | +$ helm dependency update |
| 26 | + |
| 27 | +# Install the chart |
| 28 | +$ helm install -n openblocks my-openblocks . |
| 29 | +``` |
| 30 | + |
| 31 | +## Uninstalling the Chart |
| 32 | + |
| 33 | +To uninstall/delete the `my-openblocks` deployment from namespace `openblocks`: |
| 34 | + |
| 35 | +```bash |
| 36 | +$ helm delete -n openblocks my-openblocks |
| 37 | +``` |
| 38 | + |
| 39 | +## Parameters |
| 40 | + |
| 41 | +### Redis |
| 42 | + |
| 43 | +| Name | Description | Value | |
| 44 | +| ------------------------------------ | --------------------------------------------------------------------------- | ---------------- | |
| 45 | +| `redis.enabled` | Install our own instance of redis | `true` | |
| 46 | +| `redis.externalUrl` | External Redis URL used when `redis.enabled` is `false` | `""` | |
| 47 | + |
| 48 | +All available parameters can be found in [Bitnami Redis Chart](https://github.com/bitnami/charts/tree/main/bitnami/redis/#parameters) |
| 49 | + |
| 50 | +### MongoDB |
| 51 | + |
| 52 | +| Name | Description | Value | |
| 53 | +| ------------------------------------ | --------------------------------------------------------------------------- | ---------------- | |
| 54 | +| `mongodb.enabled` | Install our own instance of mongo database | `true` | |
| 55 | +| `mongodb.externalUrl` | External mongo database connection string when `mongodb.enabled` is `false` | `""` | |
| 56 | + |
| 57 | +All available parameters can be found in [Bitnami MongoDB Chart](https://github.com/bitnami/charts/tree/main/bitnami/mongodb/#parameters) |
| 58 | + |
| 59 | +### Openblocks server api-service |
| 60 | + |
| 61 | +| Name | Description | Value | |
| 62 | +| --------------------------------------- | --------------------------------------------------------------------------- | ---------------- | |
| 63 | +| `apiService.config.userId` | User ID of user running Openblocks server application in container | `9001` | |
| 64 | +| `apiService.config.groupId` | Group ID of user running Openblocks server application in container | `9001` | |
| 65 | +| `apiService.config.corsAllowedDomains` | CORS allowed domains | `*` | |
| 66 | +| `apiService.config.encryption.password` | Encryption password | `openblocks.dev` | |
| 67 | +| `apiService.config.encryption.salt` | Encryption salt | `openblocks.dev` | |
| 68 | +| `apiService.config.enableUserSignUp` | Enable users signing up to openblocks via login page | `true` | |
| 69 | +| `apiService.config.nodeServiceUrl` | URL to node-service server if using external Openblocks server | | |
| 70 | + |
| 71 | +### Openblocks server node-service |
| 72 | + |
| 73 | +| Name | Description | Value | |
| 74 | +| --------------------------------------- | --------------------------------------------------------------------------- | ---------------- | |
| 75 | +| `nodeService.config.userId` | User ID of user running Openblocks service application in container | `9001` | |
| 76 | +| `nodeService.config.groupId` | Group ID of user running Openblocks service application in container | `9001` | |
| 77 | +| `nodeService.config.apiServiceUrl` | URL to api-service server if using external Openblocks server | | |
| 78 | + |
| 79 | +### Openblocks frontend (client) |
| 80 | + |
| 81 | +| Name | Description | Value | |
| 82 | +| --------------------------------------- | --------------------------------------------------------------------------- | ---------------- | |
| 83 | +| `frontend.config.userId` | User ID of nginx user running Openblocks client application in container | `9001` | |
| 84 | +| `frontend.config.groupId` | Group ID of nginx user running Openblocks client application in container | `9001` | |
| 85 | +| `frontend.config.apiServiceUrl` | URL to api-service server if using external Openblocks server | `""` | |
| 86 | +| `frontend.config.nodeServiceUrl` | URL to node-service server if using external Openblocks server | | |
| 87 | + |
0 commit comments