Updating on-premise version

Please note that the on-premise version differs from the cloud version and is not updated automatically.

On-premise version release notes

You can follow the updates here with the ON-PREMISE RELEASE tag.

Update to the latest version

To update your UI Bakery on-premise version to the latest one, follow the steps below:

1. Take a full backup of the UI Bakery instance.

2. Go to your ui-bakery-on-premise folder:

cd ./ui-bakery-on-premise

3. Run ./update.sh that will download new images and restart your instance:

./update.sh

4. If you use Git to manage your apps in UI Bakery, follow "Migrate app model to the latest version" guide to properly migrate the application model.

Update to the specific version

To update your UI Bakery on-premise version to the specific version, follow the steps below:

1. Take a full backup of the UI Bakery instance.

2. Go to your ui-bakery-on-premise folder:

cd ./ui-bakery-on-premise

3. Set the UI_BAKERY_VERSION environment variable to the desired version in the .env file.

4. Then restart the system

# pull new images
docker compose pull
# restart UI Bakery
docker compose down && docker compose up -d

5. Optionally delete old images

docker image prune -a -f

6. If you use Git to manage your apps in UI Bakery, follow "Migrate app model to the latest version" guide to properly migrate the application model.

Updating from version 2.25.0 and lower to the new version

If you are on a 2.25.0 UI Bakery version or lower, please follow the guide below to update to a newer version.

Please note this is a one-time procedure! You need to follow these steps only once to upgrade from any version lower than 2.25.0. If you are on a higher version, please use this guide.

1. Create a backup of ui-bakery-on-premise folder:

cp -R ui-bakery-on-premise ui-bakery-on-premise_old

2. Go to ui-bakery-on-premise folder and run:

curl -k -L -o docker-compose.yml <https://raw.githubusercontent.com/uibakery/self-hosted/main/docker-compose.yml>

3. Comment UI_BAKERY_WORKBENCH_PATH variable by adding # at the beginning of the line in .env file:

nano .env

#UI_BAKERY_WORKBENCH_PATH=...

• Press control + O to save.

• Press control + X to exit.

4. Run the next command to rerun containers:

sudo docker compose build --pull
sudo docker compose pull
sudo docker compose up -d

5. Check your UI Bakery instance.

Migrating your app model to the latest version

To continuously enhance functionality and improve user experience, new versions of UI Bakery may include app model migrations. These migrations modify the app model stored in your Git repositories. Therefore, a manual app model migration is necessary to ensure a smooth development process and prevent developers from encountering merge conflicts.

App model migration is not strictly required but is highly recommended. If the migration is not performed immediately following an update using this guide, it will be done separately in each branch automatically.

Consequently, all developers will see similar changes in their pull requests until the migration changes are merged into the main branch and subsequently into their individual branches.

Follow these steps for a successful migration:

1. Create a migration branch

   • Start by creating a new branch named migrate-release/0.0.0 from the main branch.

   • The newly created branch will be automatically migrated by UI Bakery.

2. Merge migrated changes in the main branch

   • Commit the changes to the migration branch.

   • Create a pull request from the migrate-release/0.0.0 branch to the main branch.

   • Merge the pull request into the main branch.

3. Merge migrated model into branches under active development

   • Switch back to the main branch in UI Bakery and pull the latest changes.

   • Using Git, merge the updated main branch into any branches under active development.

   • Go to these development branches and pull the changes.

By following this process, you will ensure that your app model is consistently up-to-date, minimizing the risk of conflicts and maintaining a smooth development workflow.