Export and import workspaces

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

To export a workspace from the Workspace dashboard with just a few clicks, select the three dots next to the app that you'd like to export:

This will bring up a few options to choose from:

• Duplicate will create a copy of your workspace
• 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
• Delete will delete 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:

Alternatively, you can click on the app you'd like to export, navigate to the Settings section, select General, and scroll down to export, and you should be able to export your workspace form here as well, whilst inside it.

👍

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 Apps screen, click the Create new workspace button. From here, click on the Import workspace button:

This will present a modal window into which you can drag the app export file and click Import 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.