Self-hosting

In this article, you will be guided through how to host Lowcoder on your own server using Docker-Compose or Docker.

There are multiple ways of installation. We directly support:

Single Docker Image to run with a single line of command.
Multi-Docker Image deployment for scaling scenarios withDocker Compose
Kubernetes-based deployment withHELM Charts.
Heroku based deployment
Google Cloud Platform
Raspberry Pi

1) Start easy:

For easy setup and deployment, we provide anall-in-one image that bundles frontend, backend, and data persistence services altogether in one single container.

All-in-one image

Prerequisites

Docker (version 20.10.7 or above)
Docker-Compose (version 1.29.2 or above)

Recommended system spec: 1-core CPU and 2 GB RAM.

Windows users are recommended to use PowerShell for running the commands below.

In your working directory, run the following commands to make a directory namedLowcoder to store the data of Lowcoder:

mkdir lowcodercd lowcoder

Deploy

Follow the steps below:

Download the configuration file by clickingdocker-compose.yml or running the curl command:

curl https://raw.githubusercontent.com/lowcoder-org/lowcoder/main/deploy/docker/docker-compose.yaml -o $PWD/docker-compose.yml

Start the Docker container by running this command:
```
docker-compose up -d
```
The docker image, about 400 MB, is downloaded during the initial start-up.
After downloading, it usually takes less than 30 seconds to start the service.
Check the logs by running this command:
```
docker logs -f lowcoder
```
When you seefrontend,backend,redis, andmongoentered the RUNNING state, the Lowcoder service has officially started:
Visithttp://localhost:3000 and clickSign up. Lowcoder will automatically create a workspace for you, then you can start building your apps and invite members to your workspace.

Run the command below:

docker run -d --name lowcoder -p 3000:3000 -v "$PWD/stacks:/lowcoder-stacks" lowcoderorg/lowcoder-ce

Update to the latest version

Run the following commands to update to the latest Lowcoder image:

docker-compose pulldocker-compose rm -fsv lowcoderdocker-compose up -d

Run the following commands to update to the latest Lowcoder image:

docker pull lowcoderorg/lowcoder-cedocker rm -fv Lowcoderdocker run -d --name Lowcoder -p 3000:3000 -v "$PWD/stacks:/Lowcoder-stacks" lowcoderorg/lowcoder-ce

2) Scale

For bigger expected loads that need scaling in a cluster environment, we provideseparate images of backend and frontend services with a customizable Dockerfile.

Separate images: services in stateless containers

For bigger expected loads that need scaling in a cluster environment, we offer separate images for stateless containers of the backend and frontend service with a customizable Dockerfile. A well-functioning Lowcoder deployment consists of below services:

api-service: Backend service.
node-service: Backend service.
frontend: Frontend service.
MongoDB: Used for persisting data of users, apps, data sources, etc.
Redis: Used for maintaining user sessions, rate-limiter, etc.

Prerequisites

Docker-Compose (version 1.29.2 or above)

Deploy

In your working directory, run the following commands to make a directory namedlowcoder to store the data of Lowcoder:
```
mkdir lowcodercd lowcoder
```

Download the configuration file by clickingdocker-compose-multi.yml or running the curl command:

curl https://raw.githubusercontent.com/lowcoder-org/lowcoder/main/deploy/docker/docker-compose-multi.yaml -o $PWD/docker-compose-multi.yml

Modify service configurations in the downloaded Dockerfile according to your needs:
- mongodb: Start a new MongoDB instance on your host. You can delete this part and modify the environment variableMONGODB_URI of theapi-service to use your own MongoDB.
- redis: Start a new Redis instance on your host. You can delete this part and modify the environment variableREDIS_URI of theapi-service to use your own Redis.
- api-service: Required.
- node-service: Required.
- frontend: Required. Can be optional if you deploy the frontend on CDN.
Start Docker containers by running this command:
```
docker-compose -f docker-compose-multi.yml up -d
```
Visithttp://localhost:3000 and clickSign up. Lowcoder will automatically create a workspace for you, then you can start building your apps and invite members to your workspace.

3) Update to the latest version

Run the following commands to update services to the latest in a Docker Compose installation:

Please also have a look at thismigration / update guide

docker-compose -f docker-compose-multi.yml pulldocker-compose -f docker-compose-multi.yml up -d

4) Customize the deployment

This section shows how to customize deployment configurations by setting environment variables.

If you have already started Docker containers, you need to restart the containers for new configurations to take effect. For example, the way torestart your container running an all-in-one image is:

One single command:

docker-compose downdocker-compose up -d

It picks up configuration changes by stopping containers already in service and recreating new ones.

Run the following commands to stop, remove the container already in service, and start up a new one using the newly customized deployment command.

docker stop lowcoderdocker rm lowcoder# run your new docker run command

Below are examples of configuring the all-in-one image by setting environment variables indocker-compose.yml. If you are self-hosting with separate images, modify thelowcoder-api-service part of thedocker-compose-multi.yml file instead.

For more information about configurations and environment variables, seeConfiguration.

Use your own MongoDB and Redis

By default, Lowcoder uses the built-in MongoDB and Redis installed inside the container, and you can replace them with your own MongoDB and Redis clusters.

Add environment variablesMONGODB_URI andREDIS_URI indocker-compose.yml downloaded in your working directory.

Add environment variablesMONGODB_URI andREDIS_URI to the deployment command, as shown below:

docker run -d --name lowcoder -e MONGODB_URI=YOUR_MONGODB_URI REDIS_URI=YOUR_REDIS_URI -p 3000:3000 -v "$PWD/stacks:/lowcoder-stacks lowcoderorg/lowcoder-ce

Run as non-root user

By default, the supervisor will run under the useruid=9001. You can specify the uid by adding a docker environment variableLOCAL_USER_ID and setting its value to a differentnumber, such as10010.

Add an environment variableLOCAL_USER_ID indocker-compose.yml downloaded in your working directory.

Add an environment variableLOCAL_USER_ID to the deployment command, as shown below:

docker run -d --name lowcoder -e LOCAL_USER_ID=10010 -p 3000:3000 -v "$PWD/stacks:/lowcoder-stacks" lowcoderorg/lowcoder-ce

5) Secure your deployment

Install SSL certificate

With an SSL certificate, you can securely visit self-hosted Lowcoder with HTTPS protocol. Here are the steps to install your SSL certificate before starting a container:

Copyfullchain.pem andprivkey.pem to the$PWD/lowcoder-stacks/ssl directory.
In$PWD/docker-compose.yml, change the value ofports to"3443:3443".

Copyfullchain.pem andprivkey.pem to the$PWD/lowcoder-stacks/ssl directory.
Change theports in the deployment command to3443:3443, as shown below:

docker run -d --name lowcoder -p 3443:3443 -v "$PWD/stacks:/lowcoder-stacks" lowcoderorg/lowcoder-ce

In cases where you have certificates with names:server.crt andserver.key, you need to rename them first as follows:server.crt =>fullchain.pemserver.key =>privkey.pem

6) Configure the Environment

ENV Variables for Helm, Docker Compose, and Docker installations are to find in the most current version on our Github Repository.

ENV Variables for the all-in-one image

This image contains all services needed to run Lowcoder platform in one container.

Environment variable

Description

Default-Value

LOWCODER_REDIS_ENABLED

Iftrue redis server is started in the container

true

LOWCODER_MONGODB_ENABLED

Iftrue mongo database is started in the container

true

LOWCODER_MONGODB_EXPOSED

Iftrue mongo database accept connections from outside the docker

false

LOWCODER_API_SERVICE_ENABLED

Iftrue lowcoder api-service is started in the container

true

LOWCODER_NODE_SERVICE_ENABLED

Iftrue lowcoder node-service is started in the container

true

LOWCODER_FRONTEND_ENABLED

Iftrue lowcoder web frontend is started in the container

true

LOWCODER_PUID

ID of user running services. It will own all created logs and data.

9001

LOWCODER_PGID

ID of group of the user running services.

9001

LOWCODER_MONGODB_URL

Mongo database connection string

mongodb://localhost:27017/lowcoder?authSource=admin

LOWCODER_REDIS_URL

Redis server URL

redis://localhost:6379

LOWCODER_DB_ENCRYPTION_PASSWORD

Encryption password

lowcoder.org

LOWCODER_DB_ENCRYPTION_SALT

Salt used for encrypting password

lowcoder.org

LOWCODER_CORS_DOMAINS

CORS allowed domains

*

LOWCODER_PUBLIC_URL

The URL of the public User Interface

localhost:3000

LOWCODER_MAX_REQUEST_SIZE

Lowcoder max request size

20m

LOWCODER_MAX_QUERY_TIMEOUT

Lowcoder max query timeout (in seconds)

120

LOWCODER_DEFAULT_QUERY_TIMEOUT

Lowcoder default query timeout (in seconds)

10

LOWCODER_API_RATE_LIMIT

Number of max Request per Second

100

LOWCODER_API_SERVICE_URL

Lowcoder API service URL

http://localhost:8080

LOWCODER_NODE_SERVICE_URL

Lowcoder Node service (js executor) URL

http://localhost:6060

LOWCODER_MAX_ORGS_PER_USER

Default maximum organizations per user

100

LOWCODER_MAX_MEMBERS_PER_ORG

Default maximum members per organization

1000

LOWCODER_MAX_GROUPS_PER_ORG

Default maximum groups per organization

100

LOWCODER_MAX_APPS_PER_ORG

Default maximum applications per organization

1000

LOWCODER_MAX_DEVELOPERS

Default maximum developers

100

LOWCODER_WORKSPACE_MODE

SAAS to activate, ENTERPRISE to switch off - Workspaces

SAAS

LOWCODER_EMAIL_SIGNUP_ENABLED

Control if users create their own Workspace automatic when Sign Up

true

LOWCODER_EMAIL_AUTH_ENABLED

Control if Users can Sign Up / Login using the Standard Email Field

true

LOWCODER_CREATE_WORKSPACE_ON_SIGNUP

IF LOWCODER_WORKSPACE_MODE = SAAS, controls if a own workspace is created for the user after sign up

true

LOWCODER_MARKETPLACE_PRIVATE_MODE

Control if not to show Apps on the local Marketplace to anonymous users

true

LOWCODER_SUPERUSER_USERNAME

Username of the Super-User of an Lowcoder Installation

admin@localhost

LOWCODER_SUPERUSER_PASSWORD

Password of the Super-User, if not present or empty, it will be generated

`generated and printed into log file

API Key Secret

Also, you should set the API-KEY secret, whcih should be a string of at least 32 random characters On linux/mac, generate one eg. with: head /dev/urandom | head -c 30 | shasum -a 256

Environment variable

Description

Default-Value

LOWCODER_API_KEY_SECRET

String to encrypt/sign API Keys that users may create

SMTP Server

To enable secure Password Reset flow for the users, you need to configure your own SMTP Server. You can do this with the following Variables (from Lowcoder v2.4.x on):

Environment Variable

Description

Default Value

LOWCODER_ADMIN_SMTP_HOST

SMTP Hostname of your Mail Relay Server

LOWCODER_ADMIN_SMTP_PORT

Port number for the SMTP service

587

LOWCODER_ADMIN_SMTP_USERNAME

Username for SMTP authentication

LOWCODER_ADMIN_SMTP_PASSWORD

Password for SMTP authentication

LOWCODER_ADMIN_SMTP_AUTH

Enable SMTP authentication

true

LOWCODER_ADMIN_SMTP_SSL_ENABLED

Enable SSL encryption

false

LOWCODER_ADMIN_SMTP_STARTTLS_ENABLED

Enable STARTTLS encryption

true

LOWCODER_ADMIN_SMTP_STARTTLS_REQUIRED

Require STARTTLS encryption

true

LOWCODER_LOST_PASSWORD_EMAIL_SENDER

"from" Email address of the password Reset Email Sender

[email protected]

ENV Variables for the api-service image

Environment variable

Description

Default-Value

LOWCODER_PUID

ID of user running services. It will own all created logs and data.

9001

LOWCODER_PGID

ID of group of the user running services.

9001

LOWCODER_MONGODB_URL

Mongo database connection string

mongodb://localhost:27017/lowcoder?authSource=admin

LOWCODER_REDIS_URL

Redis server URL

redis://localhost:6379

LOWCODER_DB_ENCRYPTION_PASSWORD

Encryption password

lowcoder.org

LOWCODER_DB_ENCRYPTION_SALT

Salt used for encrypting password

lowcoder.org

LOWCODER_CORS_DOMAINS

CORS allowed domains

*

LOWCODER_PUBLIC_URL

The URL of the public User Interface

localhost:3000

LOWCODER_MAX_ORGS_PER_USER

Default maximum organizations per user

100

LOWCODER_MAX_MEMBERS_PER_ORG

Default maximum members per organization

1000

LOWCODER_MAX_GROUPS_PER_ORG

Default maximum groups per organization

100

LOWCODER_MAX_APPS_PER_ORG

Default maximum applications per organization

1000

LOWCODER_MAX_DEVELOPERS

Default maximum developers

100

LOWCODER_MAX_REQUEST_SIZE

Lowcoder max request size

20m

LOWCODER_MAX_QUERY_TIMEOUT

Lowcoder max query timeout (in seconds)

120

LOWCODER_DEFAULT_QUERY_TIMEOUT

Lowcoder default query timeout (in seconds)

10

LOWCODER_WORKSPACE_MODE

SAAS to activate, ENTERPRISE to switch off - Workspaces

SAAS

LOWCODER_EMAIL_SIGNUP_ENABLED

Control is users can create their own Workspace when Sign Up

true

LOWCODER_CREATE_WORKSPACE_ON_SIGNUP

IF LOWCODER_WORKSPACE_MODE = SAAS, controls if a own workspace is created for the user after sign up

true

LOWCODER_MARKETPLACE_PRIVATE_MODE

Control if not to show Apps on the local Marketplace to anonymous users

true

LOWCODER_SUPERUSER_USERNAME

Username of the Super-User of an Lowcoder Installation

admin@localhost

LOWCODER_SUPERUSER_PASSWORD

Password of the Super-User, if not present or empty, it will be generated

`generated and printed into log file

API Key Secret

Also, you should set the API-KEY secret, whcih should be a string of at least 32 random characters On linux/mac, generate one eg. with: head /dev/urandom | head -c 30 | shasum -a 256

Environment variable

Description

Default-Value

LOWCODER_API_KEY_SECRET

String to encrypt/sign API Keys that users may create

SMTP Server

To enable secure Password Reset flow for the users, you need to configure your own SMTP Server. You can do this with the following Variables (from Lowcoder v2.4.x on):

Environment Variable

Description

Default Value

LOWCODER_ADMIN_SMTP_HOST

SMTP Hostname of your Mail Relay Server

LOWCODER_ADMIN_SMTP_PORT

Port number for the SMTP service

587

LOWCODER_ADMIN_SMTP_USERNAME

Username for SMTP authentication

LOWCODER_ADMIN_SMTP_PASSWORD

Password for SMTP authentication

LOWCODER_ADMIN_SMTP_AUTH

Enable SMTP authentication

true

LOWCODER_ADMIN_SMTP_SSL_ENABLED

Enable SSL encryption

false

LOWCODER_ADMIN_SMTP_STARTTLS_ENABLED

Enable STARTTLS encryption

true

LOWCODER_ADMIN_SMTP_STARTTLS_REQUIRED

Require STARTTLS encryption

true

LOWCODER_LOST_PASSWORD_EMAIL_SENDER

"from" Email address of the password Reset Email Sender

[email protected]

ENV Variables for the node-service image

Environment variable

Description

Default-Value

LOWCODER_PUID

ID of user running services. It will own all created logs and data.

9001

LOWCODER_PGID

ID of group of the user running services.

9001

LOWCODER_API_SERVICE_URL

Lowcoder API service URL

http://localhost:8080

ENV Variables for the web frontend image

Environment variable

Description

Default-Value

LOWCODER_PUID

ID of user running services. It will own all created logs and data.

9001

LOWCODER_PGID

ID of group of the user running services.

9001

LOWCODER_MAX_QUERY_TIMEOUT

Lowcoder max query timeout (in seconds)

120

LOWCODER_MAX_REQUEST_SIZE

Lowcoder max request size

20m

LOWCODER_API_SERVICE_URL

Lowcoder API service URL

http://localhost:8080

LOWCODER_NODE_SERVICE_URL

Lowcoder Node service (js executor) URL

http://localhost:6060

Health checks

The API Service has an included health check endpoint from v2.4.1 on.

You can check the health of the running API Service and it's connected MongoDB & Redis by the following HTTP Call:

```GET /api/status/health HTTP/1.1```

In response, you will get a 200 Status code if the service is up and running and a JSON like this:

{    "status": "UP",    "components": {        "mongo": {            "status": "UP",            "components": {                "reactiveMongoSlaveTemplate": {                    "status": "UP"                },                "reactiveMongoTemplate": {                    "status": "UP"                }            }        },        "ping": {            "status": "UP"        },        "redis": {            "status": "UP"        }    }}

PreviousCloud & Private Cloud NextGoogle Cloud Platform

Last updated1 month ago

Was this helpful?

Movatterモバイル変換

1) Start easy:

All-in-one image

Prerequisites

Deploy

Update to the latest version

2) Scale

Separate images: services in stateless containers

Prerequisites

Deploy

3) Update to the latest version

4) Customize the deployment

Use your own MongoDB and Redis

Run as non-root user

5) Secure your deployment

Install SSL certificate

6) Configure the Environment

ENV Variables for the all-in-one image

API Key Secret

SMTP Server

ENV Variables for the api-service image

API Key Secret

SMTP Server

ENV Variables for the node-service image

ENV Variables for the web frontend image

Health checks