Install and manage custom source apps

You can install a custom source app into an account or for the whole site. The account owner installs apps for the users of one account, and a site admin installs apps for the users of all accounts of the site.

Install a custom source app

Account owners install apps into their accounts, and site admins install apps for the site. You can install a ready-made app from the eazyBI Marketplace, or an app you built, with the eazyBI CLI or in the eazyBI UI.

An app installed into an account overrides a site app of the same type in that account. Install a new version of the site app into a test account first. When it works as expected, update the site app.

Install from the eazyBI Marketplace

On the Custom Source Apps tab, click Install from Marketplace, select the app, and click Install. For the steps, see Install an app from the Marketplace.

If an app of the same type is already installed from another repository, eazyBI asks you to confirm that the Marketplace app replaces it.

Install with the eazyBI CLI

We recommend using the eazyBI CLI to install the custom source apps you build. The CLI installs an app from a local directory, a ZIP file, or a GitHub or Bitbucket Cloud repository with one command. The CLI includes only the app's required files in the package and excludes other files, such as the .git directory. Your agent can run the same command after each change.

To install an app into an account, add -a ACCOUNT_ID. Site admins omit -a to install the app for all accounts of the site.

# From a local directory into one account
eazybi custom-source-apps install ./github_actions -a 1234

# From a local directory for all accounts of the site (site admins)
eazybi custom-source-apps install ./github_actions

# From a subdirectory of a GitHub repository
eazybi custom-source-apps install https://github.com/eazybi/eazybi_custom_sources --subdir github

# From a specific tag, branch, or commit of a repository
eazybi custom-source-apps install https://github.com/example/eazybi-apps --ref v1.2.0

The application type is determined by the app manifest, so you do not specify it when installing the app. When you reinstall the same app, eazyBI updates it and retains its status and settings.

To install from a private repository, a site admin needs to add the repository credentials to the site advanced settings first. The custom source apps skill describes these settings.

Install in the eazyBI UI

On the Custom Source Apps tab, click Install package. In Install from, select one of the following, and then click Install:

Upload ZIP file – a ZIP file with the app files.
Git repository – the URL of a GitHub or Bitbucket Cloud repository, or of a subdirectory in it, for example, https://github.com/eazybi/eazybi_custom_sources/tree/master/github.

Enable the app

A newly installed app is in the draft status. Only the account owner or site admins can select a draft app as a new source application. Test the import of the app, and then enable it for all users of its scope:

eazybi custom-source-apps list -a 1234 # find the app ID
eazybi custom-source-apps enable 7 -a 1234 # enable app 7

In the UI, open the app on the Custom Source Apps tab, click Edit, and change the Status to enabled. Set the status to disabled to prevent users from adding new source applications with the app.

Update the app

An app installed from a Git repository or from the eazyBI Marketplace remembers its origin. To install the latest version from the origin, run eazybi custom-source-apps update-from-origin APP_ID or click Update from origin on the app page. You can also select Update automatically from origin in the app settings, and eazyBI installs new versions automatically.

Manage custom source apps

Account owners manage the apps of an account, and site admins manage the apps of the site. Open the list of apps in one of the following ways:

In the Source Data tab, open the Custom Source Apps tab to see the apps available in the account.
Site admins can open the site administration dropdown in the top navigation and select Custom source apps to see the site's apps.

The list shows the installed apps with their type, name, scope, status, version, and origin. Account owners and site admins can do the following:

Install new apps with Install from Marketplace or Install package. In an account, Build new with AI shows instructions to copy to an AI coding agent. See Build a custom source app with an AI coding agent.
Open an app to see its description, author, license, version, origin, implementation files, and the number of source applications that use it.
Click Edit to change the status of the app, enable automatic updates from the origin, or add advanced settings for all source applications that use the app.
Update an app from its origin, or delete it.

Data admins of an account can view the list of available apps and browse the Marketplace. To install an app, ask the account owner or a site admin.

When you delete an app, the source applications that use it can no longer import data unless an app of the same type is installed at a broader scope.

Disable custom source apps

Custom source apps are enabled for all sites by default. A site admin can disable them for the whole site, or disable only the installation into accounts by account owners, in the site advanced settings:

[custom_source_apps]
# Disable custom source apps for the whole site
enable = false
# Or disable only the installation into accounts by account owners
# account = false