Deploy Dashboard

With the Deploy Dashboard, it is possible to get an overview of your Umbraco Deploy installation and perform Deploy operations.

In this article, you'll find an overview of the different sections on the Deploy dashboard and how they can be used.

Accessing the Deploy Dashboard

To access the Deploy dashboard, follow these steps:

  1. Log in to the Umbraco Cloud Portal.

  2. Select your project from the project list.

  3. Choose the environment you want to work with (for example, Development, Staging, or Live).

  4. Click Backoffice to open the Umbraco backoffice for that environment.

Backoffice link in the Portal
  1. Navigate to the Settings section in the Backoffice. You will find the Deploy Dashboard at the end.

Deploy Dashboard in the Backoffice

Deploy Status

Here you can see whether the latest deployment has been completed or failed. You can see the version of Umbraco Deploy you are running, and the last time an operation was run.

Umbraco Deploy status

Deploy Operations

With the Deploy operations, you can run different operations in Umbraco Deploy.

Deploy Operations

Below you can read what each operation will do when run through the dashboard.

Update Umbraco Schema From Data Files

Running this operation will update the Umbraco Schema based on the information in the .uda files on disk.

Export Schema To Data Files

Running this operation will extract the schema from Umbraco and output it to the .uda files on disk.

Clear Cached Signatures

Running this operation will clear the cached artifact signatures from the Umbraco environment. This should not be necessary, however, it may resolve reports of schema mismatches when transferring content that has been aligned.

Set Cached Signatures

This operation will set the cached artifact signatures for all entities within the Umbraco environment. Use this when signatures have been cleared and you want to ensure they are pre-generated before attempting a potentially longer restore or transfer operation.

Download Deploy Artifacts

Running this operation will download a zip file with all the Deploy artifacts representing the Umbraco schema in the form of .uda files.

This operation is useful if you want to move to another Umbraco instance and migrate the data with you.

Download Deploy artifacts

Configuration Details

In the Configuration details, you can see how Umbraco Deploy has been configured on your environment. You get an overview of the Setting options, the current value(s), and notes help you understand each of the settings. Updates to the need to be applied in the appsettings.json file.

Deploy configuration

Schema Comparison

The Schema Comparison table shows the schema information managed by Umbraco Deploy.

You can see a comparison between the information that is held in Umbraco and the information in the .uda files on disk.

The table shows:

  • The name of the schema

  • The file name

  • Whether the file exists in Umbraco

  • Whether the file exists

  • Whether the file is up-to-date

Deploy configuration
Document type schema comparison

You can also view details about a certain element by selecting "View Details".

This will show the difference between entities stored in Umbraco and the .uda file stored on disk.

Showing how you can compare schema in the deploy dashboard

Last updated

Was this helpful?