Export and import workspaces

Methods for moving an application or backing up the design and data of an application

You can use the methods below to move a Budibase workspace from one Budibase installation to another or back up your workspace app and data. Admins and Developers can export any app as a JSON blob text file.

The exported file will include all Budibase DB data, data connector configurations, query configs, and builder data for all your screens.

🚧

Security

When exporting a production workspace, be vigilant about whom you share the workspace export files with.
Are you confident you won't leak database credentials, user identity information, authentication keys, or other sensitive information?

We also recommend that you make use of the password-based app export encryption.

Export a workspace

  1. To export a workspace, first select the workspace you wish to export from the workspace dropdown.
  1. Next click on Settings at the bottom left of your screen.

  2. Click on General

  3. Scroll down to where it says Export section

This will bring up a few options to choose from:

  • Export latest edited will export the development version of your app, including any changes since your last publish
  • Export latest published will export only the last published version of your workspace

After choosing an export option, you will be given the option to Export rows from internal tables. This will include or exclude all the data rows from your internal Budibase DB tables in the export; however, data source configuration and credentials will still be exported.


In addition to that, you'll be presented with the option Encrypt my export which will allow you to add a password to encrypt your export:

👍

Environment variables

By using Environment variables 🔒, you can exclude secrets and datasource credentials from your workspace exports.

Import a workspace

You can create a workspace by importing a workspace export file.

Within the workspace picker, you should see a + symbol to the right. Click this, and it will prompt you to either Import or create a new workspace.

If you click the import button, the UI will change slightly. This will change the modal window so you can drag the workspace export file and click Create workspace to finish.

👍

Backups

Workspace backups 🔒 can be imported like you would import a manual export.

The benefit of using backups is that they will automatically be created when publishing your app.

Import a workspace and retain your users table

If you need to retain your users and data tables, but override your screens and automations, you can import your screens and datasources within your workspace settings.