Deploy Status
Version: {{vm.dashboard.version}}
Status: {{vm.dashboard.status.message}} (view details)
{{vm.failedOperationDetail}}
Operation time: {{vm.dashboard.status.formattedDateTime}}

Deploy Operations
Update Umbraco Schema From Data Files
Update the Umbraco schema based on the information contained in the .uda files on disk.

{{vm.operationMessage}}

Export Schema To Data Files
Extract the schema from Umbraco and output it to the .uda files on disk.

{{vm.operationMessage}}

Clear Cached Signatures
Clear the cached artifact signatures from the Umbraco environment.
This should not be necessary in normal use. This may solve reports of schema mismatches when transferring content between environments that have been aligned.

{{vm.operationMessage}}

Set Cached Signatures
Sets the cached artifact signatures for all entities within the Umbraco environment. This can be used when signatures have been cleared and you want to ensure they are pre-generated before attempting a potentially long-running restore or transfer operation.

{{vm.operationMessage}}


Download Deploy Artifacts
Schema Files
This will download a zip with all Deploy artifacts representing Umbraco schema in the form of .uda files. These files are useful if you want to move to another Umbraco instance and migrate your data.

Configuration Details

The current environment's configuration is as follows. Updates should be applied to the UmbracoDeploy.Settings.config file.

Setting Options Current Value(s) Notes
Excluded Entity Types <settings> <excludedEntityTypes> <add type="[entity-type]" /> </excludedEntityTypes> </settings>
{{entityType}}

Optionally entity types can be excluded from deployment operations.

Read more

Ignore Broken Dependencies Behaviour <settings> <deploy ignoreBrokenDependencies="true|false" ignoreBrokenDependenciesBehavior="None|Transfer|Restore|All" /> </settings> {{vm.configurationDetails.ignoreBrokenDependencies}}
{{vm.configurationDetails.ignoreBrokenDependenciesBehavior}}

When restoring or transferring content, Umbraco Deploy will make checks to ensure that any dependent content, media or other items are either present in the target environment, or can be deployed from the source environment.

For example, if you have a media picker on a content item, that references a media item that's been deleted or is in the recycle bin, you'll get an error and the deploy won't complete until the issue is resolved (by removing the reference to the deleted media item).

You can configure deploy to ignore these issues and proceed with the operation without warning, by amending this setting.

Read more

Continue On Media File Path Too Long Exception <settings> <deploy continueOnMediaFilePathTooLongException="true|false" /> </settings> {{vm.configurationDetails.continueOnMediaFilePathTooLongException}}

When restoring or transferring content, Umbraco Deploy throw an exception if the media file contains a path that is too long for the file system.

You can configure deploy to ignore these issues and proceed with the operation, by amending this setting. The media item will still be created or updated, but the associated file will not be deployed.

The detail about media files skipped will be written to the logs.

Read more

Timeout Settings <settings> <deploy sessionTimeout="[timeout in seconds]" sourceDeployTimeout="[timeout in seconds]" httpClientTimeout="[timeout in seconds]" databaseCommandTimeout="[timeout in seconds]" diskOperationsTimeout="[timeout in seconds]" /> </settings> {{vm.configurationDetails.sessionTimeout}}
{{vm.configurationDetails.sourceDeployTimeout}}
{{vm.configurationDetails.httpClientTimeout}}
{{vm.configurationDetails.databaseCommandTimeout}}
{{vm.configurationDetails.diskOperationsTimeout}}

Umbraco Deploy has a few built-in timeouts, which on larger sites might need to be modified.

Read more

Batch Settings <settings> <deploy sourceDeployBatchSize="[batch size]" /> </settings> {{vm.configurationDetails.sourceDeployBatchSize}}

Platform limits can be reached when transferring large amounts of content or media. To try to avoid this, batch sizes for deploy operations can be configured.

When set, this setting controls how many items are selected per batch to transfer to an upstream environment, potentially resulting in multiple deployments.

This will take effect only for transfers to upstream environments (not for restores) and when multiple items are queued for transfer, such as a single media folder containing many files (queued using 'Include all items below'). Each batch will still include all determined dependencies and relations to successfully complete the deployment.

Read more

<settings> <deploy packageBatchSize="[batch size]" /> </settings> {{vm.configurationDetails.packageBatchSize}}

A batch setting is also available for the processing of a package. A package is an ordered structure containing all the items selected for the operation, plus all the determined dependencies and relations.

When set, if the number of items determined for the package exceeds the batch size, the processing will be chunked into batches. Although this will result in a single deployment, the batches are processed twice: the second reprocessing operation ensures consistency of the deployed content (e.g. when a dependency didn't exist yet during the initial processing of a batch).

This will take effect for both transfers to and (partial) restores from upstream environments, regardless of the number of items selected.

Read more

Transfer Forms Behaviour <settings> <forms transferFormsAsContent="true|false" /> </settings> {{vm.configurationDetails.transferFormsAsContent}}

Forms can be transferred as schema (i.e. serialized to .uda files on disk) or as content via the backoffice.

Read more

Transfer Dictionary Items Behaviour <settings> <dictionary transferDictionaryAsContent="true|false" /> </settings> {{vm.configurationDetails.transferDictionaryAsContent}}

Dictionary items can be transferred as schema (i.e. serialized to .uda files on disk) or as content via the backoffice.

Read more

Transfer Members Behaviour <settings> <deploy exportMemberGroups="true|false" /> </settings> {{vm.configurationDetails.exportMemberGroups}}

By default, member groups are transferred as schema items unless they are disabled via this configuration.

Read more

<settings> <members allowMembersDeploymentOperations="None|Restore|Transfer|All" transferMemberGroupsAsContent="true|false" /> </settings> {{vm.configurationDetails.allowMembersDeploymentOperations}}
{{vm.configurationDetails.transferMemberGroupsAsContent}}

Members, and optionally also member groups, can be transferred via the backoffice if the feature is enabled using these settings.

Read more

Domains Deployment <settings> <content allowDomainsDeploymentOperations="None|Culture|AbsolutePath|Hostname|All" /> </settings> {{vm.configurationDetails.allowDomainsDeploymentOperations}}

When restoring or transferring content for culture invariant content, the information managed under "Culture & Hostnames" can be transferred between environments using Umbraco Deploy.

To enable this, set the configuration value as appropriate for the types of domains you want to allow:

  • Culture - selected culture for the content
  • AbsolutePath - values defined under "Domains" with an absolute path, e.g. "/en"
  • Hostname - values defined under "Domains" with a full host name, e.g. "en.mysite.com"

Combinations of settings can be applied, e.g. Hostname,AbsolutePath

Read more

Memory Cache Reload <settings> <deploy reloadMemoryCacheFollowingDiskReadOperation="true|false" /> </settings> {{vm.configurationDetails.reloadMemoryCacheFollowingDiskReadOperation}}

Some customers have reported sporadic issues with Umbraco's memory cache following deploy operations where schema information in Umbraco is updated from the serialized .uda files.

These can be resolved manually by reloading the memory cache via the Settings > Published Status > Caches dashboard.

This configuration option can be used to enable an automated reload of this cache.

Read more

Media File Checksum Calculation <settings> <deploy mediaFileChecksumCalculationMethod="PartialFileContents|Metadata" /> </settings> {{vm.configurationDetails.mediaFileChecksumCalculationMethod}}

By default the first bytes of a media file's content are used to create a checksum value, which in turn is used for comparisons between files in different environments.

A faster approach is to use the file's metadata, with the small risk of increasing the chance of a file that has changed being considered the same and so not included in a deployment operation.

Read more

Number Of Signatures To Use All Relation Cache <settings> <deploy numberOfSignaturesToUseAllRelationCache="[numeric value]" /> </settings> {{vm.configurationDetails.numberOfSignaturesToUseAllRelationCache}}

When processing a large number of items in a deploy operation, rather than looking up each relation individually in the database, it can be quicker to retrieve all into memory and cache them for processing.

This setting determines the cut-off for when this option is used.

Read more

Suppress Cache Refresher Notifications <settings> <deploy suppressCacheRefresherNotifications="true|false" /> </settings> {{vm.configurationDetails.suppressCacheRefresherNotifications}}

Following a deployment operations, cache refresher events are fired to ensure all nodes in a load balanced Umbraco setup are up to date.

This setting can be used to suppress these notifications. It should not be used in a production setup but can be useful for one-off, large content transfers, if otherwise issues caused by post-deploy notification handlers can't be resolved.


Schema Comparison

The following table shows the schema information managed by Umbraco Deploy. A comparison between the information held in Umbraco and that in the .uda files found on disk (in /data/revision) is shown.

If any differences exist, a Schema Deployment From Data Files (to update Umbraco) or an Extract Schema To Data Files (to update the .uda files) operation can be triggered to align the information.

{{entityType}} - {{vm.getSchemaComparisonSummary(comparisonData)}}

Name File Exists In Umbraco File Exists Is Up To Date
{{item.label}} {{(item.filename)}} View Details
Umbraco Deploy is not licensed: {{ vm.licenseFailureMessage }}