Installing on-premise

This guide describes how to deploy a ui-bakery on-prem via install.sh script.

The script installs docker and docker-compose, which may upgrade some dependencies under the hood. Please be advised that if you run this script on the OS used as a server for other applications, those applications may break due to that potential dependencies upgrade.

Installation requirements

  • OS Linux Ubuntu 18.04 and above

  • 2 vCPUs, 4 GiB memory, 20GiB disk space

  • Must have full rights to use "sudo"

  • These domains are accessible from your network:

    • https://cruibakeryonprem.westeurope.data.azurecr.io

    • https://cruibakeryonprem.centralus.data.azurecr.io

    • https://raw.githubusercontent.com

Installation steps

  1. Run this command preferably from /home Linux directory to download, install and launch UI Bakery:

    curl -k -L -o install.sh https://raw.githubusercontent.com/uibakery/self-hosted/main/install.sh && bash ./install.sh
  2. In the process, upon request, enter the license key, hosting URL, and port.

On the Free plan, your license key is generated automatically during the installation process. On the paid plans, reach out to our Support team to obtain it.

  1. Once the installation is completed, open the browser using the URL and port provided earlier. By default it is http://localhost:3030/.

  2. By default, the login page will open where you will need to sign up first before creating your workspace and building apps.

You can sign up with your own credentials.

NOTE: If Docker of a version less than the required (minimum 20.10.11) is already installed on the server, and/or Docker Compose (minimum 1.29.2), the script will be stopped. You need to update the versions of components manually and run the script again.

Deployment by instance

To deploy the self-hosted version to specific instances, follow these comprehensive guides:

UI Bakery installation is ready for production out of the box. However, there are additional setup steps we recommend following.

Last updated

Was this helpful?