Updates
This commit is contained in:
103
lowcoder/deploy/helm/README.md
Normal file
103
lowcoder/deploy/helm/README.md
Normal file
@@ -0,0 +1,103 @@
|
||||
# Lowcoder
|
||||
|
||||
Lowcoder is a developer-friendly open-source low code platform to build internal apps within minutes.
|
||||
|
||||
[Overview of Lowcoder](https://docs.lowcoder.org/)
|
||||
|
||||
## Introduction
|
||||
|
||||
This chart bootstraps an Lowcoder deployment on a [Kubernetes](https://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Kubernetes 1.19+
|
||||
- Helm 3.2.0+
|
||||
- PV provisioner support in the underlying infrastructure
|
||||
- Bitnami helm chart repository (if mongodb and/or redis is installed)
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `my-lowcoder` into namespace `lowcoder`:
|
||||
|
||||
```bash
|
||||
# If installing mongodb and/or redis, add bitnami chart repository and update chart dependenices
|
||||
$ helm repo add bitnami https://charts.bitnami.com/bitnami
|
||||
$ helm dependency update
|
||||
|
||||
# Install the chart
|
||||
$ helm install -n lowcoder my-lowcoder .
|
||||
```
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall/delete the `my-lowcoder` deployment from namespace `lowcoder`:
|
||||
|
||||
```bash
|
||||
$ helm delete -n lowcoder my-lowcoder
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
## Global
|
||||
|
||||
| Name | Description | Value |
|
||||
| --------------------------------------- | --------------------------------------------------------------------------------- | -------------- |
|
||||
| `global.config.publicUrl` | URL of the public User Interface (used eg. in invitation links) | `https://somedomain.com/` |
|
||||
| `global.config.createWorkspaceOnSignup` | If workspaceMode = SAAS, controls if own workspace is created for the user after sign up | `true` |
|
||||
| `global.config.workspaceMode` | Sets the workspace mode. Possible types are: SAAS, ENTERPRISE | `SAAS` |
|
||||
| `global.config.userId` | User ID of user running Lowcoder server application in container | `9001` |
|
||||
| `global.config.groupId` | Group ID of user running Lowcoder server application in container | `9001` |
|
||||
| `global.config.corsAllowedDomains` | CORS allowed domains | `*` |
|
||||
| `global.config.enableUserSignUp` | Enable users signing up to lowcoder via login page | `true` |
|
||||
| `global.config.enableEmailAuth` | Controls whether authentication via email is enabled | `true` |
|
||||
| `global.config.emailNotificationSender` | Email used in notifications from lowcoder | `info@localhost` |
|
||||
| `global.config.encryption.password` | Encryption password - CHANGE IT! | `lowcoder.org` |
|
||||
| `global.config.encryption.salt` | Encryption salt - CHANGE IT! | `lowcoder.org` |
|
||||
| `global.config.superuser.username` | Lowcoder superadmin username | `admin@localhost` |
|
||||
| `global.config.superuser.password` | Lowcoder superadmin password - if not supplied, it will be generated | |
|
||||
| `global.config.apiKeySecret` | API-KEY secret, should be a string of at least 32 random characters - CHANGE IT | `5a41b0905...` |
|
||||
| `global.config.maxQueryTimeout` | Maximum query timeout in seconds | `120` |
|
||||
| `global.config.maxRequestSize` | Maximum request size | `20m` |
|
||||
| `global.config.snapshotRetentionTime` | Lowcoder application snapshot retention time (in days) | `30` |
|
||||
| `global.config.marketplacePrivateMode` | Controls whether to show Apps on the local Marketplace to anonymous users | `true` |
|
||||
| `global.config.nodeServiceUrl` | URL to node-service server if using external one (disabled by default) | |
|
||||
| `global.config.nodeServiceSecret` | Secret used for encrypting traffic between API service and Node service - CHANGE IT! | |
|
||||
| `global.config.nodeServiceSalt` | Salt used for encrypting traffic between API service and Node service - CHANGE IT! | |
|
||||
| `global.config.apiServiceUrl` | URL to api-service server if using external one (disabled by default) | |
|
||||
| `global.cookie.name` | Name of the lowcoder application cookie | `LOWCODER_CE_SELFHOST_TOKEN` |
|
||||
| `global.cookie.maxAge` | Lowcoder application cookie max age in hours | `24` |
|
||||
| `global.defaults.maxOrgsPerUser` | Maximum allowed organizations per user | `100` |
|
||||
| `global.defaults.maxMembersPerOrg` | Maximum allowed members per organization | `1000` |
|
||||
| `global.defaults.maxGroupsPerOrg` | Maximum groups allowed per organization | `100` |
|
||||
| `global.defaults.maxAppsPerOrg` | Maximum allowed applications per organization | `1000` |
|
||||
| `global.defaults.maxDevelopers` | Maximum allowed developer accounts | `100` |
|
||||
| `global.defaults.apiRateLimit` | Number of max Request per Second - set to 0 to disable rate limiting | `100` |
|
||||
| `global.defaults.queryTimeout` | Default lowcoder query timeout | `10` |
|
||||
| `global.mailServer.host` | Mail server host (used for sending lowcoder emails) | `localhost` |
|
||||
| `global.mailServer.port` | Mail server port | `578` |
|
||||
| `global.mailServer.smtpAuth` | Use SMPT authentication when sending mails | `false` |
|
||||
| `global.mailServer.authUsername` | Username (email) used for SMTP authentication | |
|
||||
| `global.mailServer.authPassword` | Password used for authentication | |
|
||||
| `global.mailServer.useSSL` | Enable SSL for connetion to the mail server | `false` |
|
||||
| `global.mailServer.useStartTLS` | Enable STARTTLS | `true` |
|
||||
| `global.mailServer.requireStartTLS` | Require STARTTLS | `true` |
|
||||
| `global.plugins.folder` | Folder from which to load lowcoder plugins | `/plugins` |
|
||||
|
||||
### Redis
|
||||
|
||||
| Name | Description | Value |
|
||||
| ------------------------------------ | --------------------------------------------------------------------------- | ---------------- |
|
||||
| `redis.enabled` | Install our own instance of redis | `true` |
|
||||
| `redis.externalUrl` | External Redis URL used when `redis.enabled` is `false` | `""` |
|
||||
|
||||
All available parameters can be found in [Bitnami Redis Chart](https://github.com/bitnami/charts/tree/main/bitnami/redis/#parameters)
|
||||
|
||||
### MongoDB
|
||||
|
||||
| Name | Description | Value |
|
||||
| ------------------------------------ | --------------------------------------------------------------------------- | ---------------- |
|
||||
| `mongodb.enabled` | Install our own instance of mongo database | `true` |
|
||||
| `mongodb.externalUrl` | External mongo database connection string when `mongodb.enabled` is `false` | `""` |
|
||||
|
||||
All available parameters can be found in [Bitnami MongoDB Chart](https://github.com/bitnami/charts/tree/main/bitnami/mongodb/#parameters)
|
||||
|
||||
Reference in New Issue
Block a user