Install Domino Official Extensions

Domino Official Extensions are pre-built Extensions that Domino develops, tests, and distributes, such as AutoML Studio, Clinical Data Explorer, and Auto Model Documentation. Instead of building an App and creating an Extension yourself, an administrator installs one from a catalog in the Admin panel. The installer creates and configures every entity the Extension needs, and handles upgrades and uninstalls. Installing, upgrading, and uninstalling a Domino Official Extension requires a SysAdmin or CloudAdmin role. To build your own Extension, see Create and manage Extensions.

​

How installation works

Each Domino Official Extension is published in a public GitHub repository maintained by Domino. Every released version of an Extension includes a manifest that tells Domino how to set that version up. When you install a version, Domino creates four managed entities in your deployment, in order:

1. A Project that hosts the Extension, with the Extension’s GitHub repository attached.
2. A Compute Environment for the Extension’s App, either a Domino standard environment or a custom environment built from the Extension’s Dockerfile.
3. An App, published from the released code and configured per the manifest.
4. The Extension, enabled at the mount points the manifest defines and marked as Domino Official.

Installation runs in the background. The installer shows per-step progress and logs in the Admin panel, and you can retry or cancel if a step fails. Because the manifest defines the App configuration and mount points, there is nothing to configure during installation.

​

Prerequisites

• A SysAdmin or CloudAdmin role.
• Extensions enabled on the deployment. Extensions and the identity propagation controls Apps rely on (SecureIdentityPropagationToAppsEnabled and com.cerebro.domino.apps.extendedIdentityPropagationToAppsEnabled) are on by default in Domino Cloud.
• Network access from the Domino platform to GitHub. The installer downloads the catalog, manifests, and code from Domino’s public GitHub repositories.

​

Browse available extensions

1. In the Admin panel, open Extensions.
2. Select the Manage Domino-official Extensions tab.

Each Domino Official Extension is listed with a version selector. The list shows only versions compatible with your Domino version.

​

Install an extension

1. In the Manage Domino-official Extensions tab, find the Extension.
2. Select the version to install. Choose the latest available version unless you have a specific reason not to.
3. Select Install. The installation is queued and continues in the background.
4. Monitor per-step progress and logs from the same tab. You can leave the page, and installation continues.

When installation completes, the Extension appears in the Extensions tab marked as Domino Official and is enabled at the mount points its manifest defines. Users who have permission to view the underlying App can use the Extension immediately.

​

Upgrade an extension

When a newer compatible version is released, it appears in the Extension’s version selector.

1. Select the new version.
2. Select Install.

The installer updates the managed entities in place. The existing Project and App are updated to the new release, and the Compute Environment is rebuilt only if it changed between versions. The installer does not create a duplicate set of entities. Downgrades are not supported. To move to an older version, uninstall the Extension first, then install the version you want.

​

Retry a failed install or upgrade

If a step fails, the install pauses and the step’s logs explain what went wrong. Two retry options are available:

• Retry from failed step undoes only the failed step, then runs it again. Try this first.
• Clean retry undoes all completed steps and starts the installation from the beginning.

​

Cancel an in-progress install

Cancelling stops the installation and reverts every step that already completed, returning the deployment to its prior state.

​

Uninstall an extension

Uninstalling removes the Extension and archives or deletes all the managed entities the installer created: the Project, the Compute Environment, and the App. If Domino cannot remove an entity immediately, the installer reports it and keeps retrying the cleanup in the background. You can start a fresh install without waiting.

​

Do not modify managed entities

Nothing prevents an administrator from editing an installed Extension’s Project, Compute Environment, App, or Extension configuration, but avoid it. The Extension was tested only with its installed configuration, and manual changes can break the Extension or complicate a future upgrade. Domino records the configuration each version was installed with, and Domino support can compare that record against the live configuration to diagnose issues. Routine management is fine. Use the toggle in the Extensions tab to enable or disable an installed Domino Official Extension, the same as any other Extension. Use the Manage Domino-official Extensions tab, not Manage Extension > Edit, to change versions.

​

Limitations

• An Extension created manually cannot be converted to a Domino Official Extension. The Domino Official designation is only applied by the installer.
• Downgrades are not supported. Uninstall the current version, then install the older version.
• The installer creates entities with fixed names, such as the Project name and the App’s vanity URL. If your deployment already has a resource with a conflicting name, the install fails at that step. Resolve the conflict, then retry. Contact Domino support if you cannot resolve it.

​

Next steps

• Create and manage Extensions covers building your own Extension from a Domino App.
• The Extensions overview lists the Extensions Domino publishes and links their public source.