Enterprise Edition
In this article, you will be guided through self-hosting Openblocks Enterprise Edition (EE) using Docker or Docker Compose:
- For current users of Openblocks Community Edition (CE), please follow instructions in Upgrade to Enterprise Edition section.
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.
- Enterprise ID providers: Google, GitHub, Azure AD, Okta, Keycloak, CAS, LDAP, JWT and more
- Air-gapped deployment
- Audit logs
- Priority support
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.
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
Docker-Compose (Recommend)
Docker
Follow the steps below:
- 1.curl https://cdn-files.openblocks.dev/docker-compose.yml -o $PWD/docker-compose.yml
- 2.Edit the yaml file just downloaded:
image
: should be modified toopenblocksdev/openblocks-ee
.contanier_name
: should be changed only when you run into container-naming conflicts. If changed, please remember to also replace default container nameopenblocks
with the new one in commands likedocker logs
,docker-compose rm
,docker restart
, and so on.
- 3.Start the Docker container by running this command:docker-compose up -dThe docker image will be pulled from docker hub during the initial start-up.
- 4.Fill in your License Key in
stacks/configuration/application-selfhost.yml
, as shown below. Note that thekey:
should always be followed by a space, then the license key. - 5.Restart the container using this command:docker restart openblocks
- 6.Check the logs by running this command:docker logs -f openblocksWhen you see frontend, backend, redis, and mongo entered the RUNNING state, the Openblocks service has officially started.
- 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.Run the command below to pull
openblocks-ee
image and start the containeropenblocks
:docker run -d --name openblocks -p 3000:3000 -v "$PWD/stacks:/openblocks-stacks" openblocksdev/openblocks-ee - 2.Fill in your License Key in
stacks/configuration/application-selfhost.yml
. Note that thekey:
should always be followed by a space, then the license key. - 3.Restart the container using this command:docker restart openblocks
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
You can customize deployment configurations by setting environment variables. For detailed information, see Customize configurations.
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.
Docker-Compose
Docker
- 1.
- For developers self-hosting with the all-in-one image: the
image
field ofopenblocks
service should be modified toopenblocksdev/openblocks-ee
.
- 2.Pull the latest all-in-one image of Enterprise Edition using the modified Dockerfile.
docker-compose pull
- 3.Stop and remove the Openblocks CE service container.
docker-compose rm -fsv YOUR_CE_CONTAINER_NAME
- 4.Run the Openblocks EE container in the background (the Detached mode).
docker-compose up -d
- 5.Fill in your License Key in
stacks/configuration/application-selfhost.yml
. Note that thekey:
should always be followed by a space, then the license key. - 6.Restart the Openblocks EE container.
docker restart YOUR_EE_CONTAINER_NAME
- 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.Pull the latest all-in-one image of Enterprise Edition.
docker pull openblocksdev/openblocks-ee
- 2.Stop and remove the Openblocks CE service container.
docker rm -fv YOUR_CE_CONTAINER_NAME
- 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
- 4.Fill in your License Key in
stacks/configuration/application-selfhost.yml
. Note that thekey:
should always be followed by a space, then the license key. - 5.Restart the Openblocks EE container.
docker restart YOUR_EE_CONTAINER_NAME
- 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
Last modified 6mo ago