Umbraco Deploy
CMSCloudHeartcoreDXP
14.latest
14.latest
  • Umbraco Deploy Documentation
  • Legacy Documentation
  • Release notes
  • Troubleshooting
  • Installation
    • Installing Umbraco Deploy
    • Licensing
  • Upgrading
    • Upgrading Umbraco Deploy
    • Version Specific Upgrade Details
  • Getting Started
    • Getting started
    • CI/CD Build and Deployment Pipeline
      • Azure DevOps
      • GitHub Actions
    • Streamlining Local Development
    • Configuration
  • Deployment Workflow
    • Deployment
    • Transferring Content, Media and Forms
    • Import and Export
      • Import and Export with Migrations
      • Import and Export from version 7
      • Import on startup
    • Deploying Changes
    • Deploying deletions
    • Restoring content
      • Partial Restores
    • Deploy Dashboard
  • Extending
    • Extend Deploy
    • Handling Cache Refresher Notifications
Powered by GitBook
On this page
  • Deploy Status
  • Deploy Operations
  • Update Umbraco Schema From Data Files
  • Export Schema To Data Files
  • Clear Cached Signatures
  • Set Cached Signatures
  • Download Deploy Artifacts
  • Configuration Details
  • Schema Comparison

Was this helpful?

Edit on GitHub
Export as PDF
  1. Deployment Workflow

Deploy Dashboard

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

PreviousPartial RestoresNextExtend Deploy

Last updated 11 months ago

Was this helpful?

In this article, we will show the different sections on the Deploy dashboard and how they can be used.

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.

Deploy Operations

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

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.

Configuration Details

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

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.

In the Configuration details, you can see how Umbraco Deploy has been 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.

configured
Umbraco Deploy status
The different Deploy operations.
Donwload the Deploy artifacts
Example of Umbraco Deploy configuration.
Document type schema comparison
Showing how you can compare schema in the deploy dashboard
Umbraco Deploy status
The different Deploy operations.
Donwload the Deploy artifacts