Openblocks Docs
OpenblocksGitHubDiscord
Search
⌃K
Links

Enterprise Edition

In this article, you will be guided through self-hosting Openblocks Enterprise Edition (EE) using Docker or Docker Compose:
A License Key is necessary to deploy or upgrade to Enterprise Edition. Feel free to contact our team at [email protected] or on Discord if needed.
The lack of License Key will not hinder the process of starting and maintaining Openblocks EE services but display the paid features as disabled.

Premium features

  • Enterprise ID providers: Google, GitHub, Azure AD, Okta, Keycloak, CAS, LDAP, JWT and more
  • White labeling (Custom branding)
  • Air-gapped deployment
  • Audit logs
  • Priority support

All-in-one image: all services in one container

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

Prerequisites

Recommended system spec: 1-core CPU and 2 GB RAM.
Windows users are recommended to use PowerShell for running terminal commands below.
In your working directory, run the following commands to make a directory named openblocks to store the data of Openblocks:
mkdir openblocks
cd openblocks

Deploy

Docker-Compose (Recommend)
Docker
Follow the steps below:
  1. 1.
    Download the configuration file by clicking docker-compose.yml or running the curl command:
    curl https://cdn-files.openblocks.dev/docker-compose.yml -o $PWD/docker-compose.yml
  2. 2.
    Edit the yaml file just downloaded:
    • image: should be modified to openblocksdev/openblocks-ee.
    • contanier_name: should be changed only when you run into container-naming conflicts. If changed, please remember to also replace default container name openblocks with the new one in commands like docker logs, docker-compose rm, docker restart, and so on.
  3. 3.
    Start the Docker container by running this command:
    docker-compose up -d
    The docker image will be pulled from docker hub during the initial start-up.
  4. 4.
    Fill in your License Key in stacks/configuration/application-selfhost.yml, as shown below. Note that the key: should always be followed by a space, then the license key.
  5. 5.
    Restart the container using this command:
    docker restart openblocks
  6. 6.
    Check the logs by running this command:
    docker logs -f openblocks
    ​
    When you see frontend, backend, redis, and mongo entered the RUNNING state, the Openblocks service has officially started.
  7. 7.
    Visit http://localhost:3000 and click Sign up. Openblocks will automatically create a workspace for you, then you can start building your apps and invite members to your workspace.
  1. 1.
    Run the command below to pull openblocks-ee image and start the container openblocks:
    docker run -d --name openblocks -p 3000:3000 -v "$PWD/stacks:/openblocks-stacks" openblocksdev/openblocks-ee
  2. 2.
    Fill in your License Key in stacks/configuration/application-selfhost.yml. Note that the key: should always be followed by a space, then the license key.
  3. 3.
    Restart the container using this command:
    docker restart openblocks

Update

Docker-Compose
Docker
Run the following commands to update to the latest Openblocks image:
docker-compose pull
docker-compose rm -fsv openblocks
docker-compose up -d
Run the following commands to update to the latest Openblocks image:
docker pull openblocksdev/openblocks-ee
docker rm -fv openblocks
docker run -d --name openblocks -p 3000:3000 -v "$PWD/stacks:/openblocks-stacks" openblocksdev/openblocks-ee

Customize configurations

You can customize deployment configurations by setting environment variables. For detailed information, see Customize configurations.

Upgrade to Enterprise Edition

If you have been using Openblocks Community Edition and want to upgrade to Enterprise Edition, follow the steps below to start Openblocks(EE) containers based on your current data stored in MongoDB.
Feel free to contact us at [email protected] or on Discord when you encounter any problem.
Docker-Compose
Docker
  1. 1.
    Edit the Dockerfile docker-compose.yml in your working directory:
    • For developers self-hosting with the all-in-one image: the image field of openblocks service should be modified to openblocksdev/openblocks-ee.
  2. 2.
    Pull the latest all-in-one image of Enterprise Edition using the modified Dockerfile.
docker-compose pull
  1. 3.
    Stop and remove the Openblocks CE service container.
docker-compose rm -fsv YOUR_CE_CONTAINER_NAME
  1. 4.
    Run the Openblocks EE container in the background (the Detached mode).
docker-compose up -d
  1. 5.
    Fill in your License Key in stacks/configuration/application-selfhost.yml. Note that the key: should always be followed by a space, then the license key.
    ​
  2. 6.
    Restart the Openblocks EE container.
docker restart YOUR_EE_CONTAINER_NAME
  1. 7.
    Check the log of the container, and wait for frontend, backend, redis, and mongo services to have entered the RUNNING state.
docker logs -f YOUR_EE_CONTAINER_NAME
Before starting, make sure you have redirected to the working directory where your current data is stored.
  1. 1.
    Pull the latest all-in-one image of Enterprise Edition.
docker pull openblocksdev/openblocks-ee
  1. 2.
    Stop and remove the Openblocks CE service container.
docker rm -fv YOUR_CE_CONTAINER_NAME
  1. 3.
    Run the Openblocks EE container in the background (the Detached mode).
docker run -d --name YOUR_EE_CONTAINER_NAME -p 3000:3000 -v "$PWD/stacks:/openblocks-stacks" openblocksdev/openblocks-ee
  1. 4.
    Fill in your License Key in stacks/configuration/application-selfhost.yml. Note that the key: should always be followed by a space, then the license key.
    ​
  2. 5.
    Restart the Openblocks EE container.
docker restart YOUR_EE_CONTAINER_NAME
  1. 6.
    Check the log of the container, and wait for frontend, backend, redis, and mongo services to have entered the RUNNING state.
docker logs -f YOUR_EE_CONTAINER_NAME
Previous
Self-hosting
Next
Access local database or API
Last modified 6mo ago