You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 14/umbraco-deploy/getting-started/deploy-settings.md
+23-23Lines changed: 23 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -115,7 +115,7 @@ Our recommended approach is to leave this setting as `Default` and use source co
115
115
116
116
However, we are aware that some customers prefer the option to use the backoffice for all data transfers. If that is the case, the `BackOfficeOnly` setting will allow this.
117
117
118
-
### ExcludedEntityTypes
118
+
### ExcludedEntityTypes {#excludedentitytypes}
119
119
120
120
This setting allows you to exclude a certain type of entity from being deployed. This is **not** recommended to set, but sometimes there may be issues with the way a custom media fileprovider works with your site and you will need to set it for media files. Here is an example:
121
121
@@ -154,7 +154,7 @@ Here is an example of how the setting can look:
154
154
},
155
155
```
156
156
157
-
### Timeout settings
157
+
### Timeout settings {#timeout-settings}
158
158
159
159
Umbraco Deploy has a few built-in timeouts, which on larger sites might need to be modified. You will usually see these timeouts in the backoffice with an exception mentioning a timeout. It will be as part of a full restore or a full deployment of an entire site. In the normal workflow, you should never hit these timeouts.
160
160
@@ -179,7 +179,7 @@ This setting defaults to 5 minutes.
179
179
180
180
All of these times are configured using [standard timespan format strings](https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-timespan-format-strings).
181
181
182
-
### Batch settings
182
+
### Batch settings {#batch-settings}
183
183
184
184
Even with appropriate settings of the above timeouts, Deploy's backoffice transfer operations can hit a hard limit imposed by the hosting environment. For Azure, this is around 4 minutes. This will typically only be reached if deploying a considerable amount of items in one go. For example, a media folder with thousands of items can reach this limit.
185
185
@@ -204,21 +204,21 @@ From 10.1, a database-backed queue was implemented and is used by default.
204
204
205
205
If for any reason there was a need to revert to the previous implementation, the value of this setting can be set to `false`.
In order for Deploy to handle Forms data as content, you'll to ensure the `TransferFormsAsContent` setting is set to `true`. To transfer Forms data as schema, i.e. via .uda files committed to source control, use a value of `false`.
210
210
211
211
{% hint style="info" %}
212
212
On changing this value from `false` to `true`, make sure to remove any `.uda` files for Forms entities that have already been serialized to disk. These will no longer be updated. By deleting them you avoid any risk of them being processed in the future and inadvertently reverting a form to an earlier state.
In a similar way, Deploy can be configured to allow for backoffice transfers of dictionary items instead of using files serialized to disk, by setting `TransferDictionaryAsContent` as `true`.
218
218
219
219
Please see the note above under _TransferFormsAsContent_ on the topic of removing any existing serialized files having changed this value to `true`.
When deploying dictionary items, an exception will be thrown if a translation is provided for a language that doesn't exist in the target environment.
224
224
@@ -228,15 +228,15 @@ If you have deleted languages that have already existing translations, you may w
228
228
229
229
When this is in place a translation for a language that doesn't exist in the target environment will be ignored. A warning message will be output to the log.
When deploying dictionary items, Umbraco Deploy follows the approach used for all content, emptying values that are transferred and set.
234
234
235
235
If you transfer a dictionary item with an empty translation to another environment that already contains a translation, it will be overwritten.
236
236
237
237
Set this value to `false` to not overwrite already populated values with empty strings.
238
238
239
-
### AllowMembersDeploymentOperations and TransferMemberGroupsAsContent
239
+
### AllowMembersDeploymentOperations and TransferMemberGroupsAsContent {#transfer-members}
240
240
241
241
It's also possible to transfer members and member groups via the backoffice between environments. This is disabled by default as a deliberate decision to make use of the feature needs to be taken, as for most installations it will make sense to have member data created and managed only in production. There are obvious potential privacy concerns to consider too. However, if being able to deploy and restore this information between environments makes sense for the specific workflow of your project, it's a supported scenario.
242
242
@@ -253,13 +253,13 @@ With `TransferMemberGroupsAsContent` set to `true`, member groups can also be tr
253
253
254
254
Please see the note above under _TransferFormsAsContent_ on the topic of removing any existing serialized files having changed this value to `true`.
255
255
256
-
### ExportMemberGroups
256
+
### ExportMemberGroups {#exporting-member-groups}
257
257
258
258
This setting is to be defined and set to `false` only if you are using an external membership provider for your members. You will not want to export Member Groups that would no longer be managed by Umbraco but by an external membership provider.
259
259
260
260
Setting `exportMemberGroups` to `false` will no longer export Member Groups to .uda files on disk. The default for this setting is `true`, as most sites use Umbraco's built-in membership provider and thus will want the membership groups exported.
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.
265
265
@@ -284,7 +284,7 @@ When configuring for Deploy 9, an additional `IgnoreBrokenDependencies` setting
284
284
"IgnoreBrokenDependenciesBehavior": "Restore",
285
285
```
286
286
287
-
### Memory cache reload
287
+
### Memory cache reload {#memory-cache-reload}
288
288
289
289
Some customers have reported intermittent issues related to Umbraco's memory cache following deployments, which are resolved by a manual reload of the cache via the _Settings > Published Status > Caches_ dashboard. If you are running into such issues and are able to accommodate a cache clear after deployment, this workaround can be automated via the following setting:
290
290
@@ -294,7 +294,7 @@ Some customers have reported intermittent issues related to Umbraco's memory cac
294
294
295
295
By upgrading to the most recent available version of the CMS major you are running, you'll be able to benefit from the latest bug fixes and optimizations in this area. That should be your first option if encountering cache related issues. Failing that, or if a CMS upgrade is not an option, then this workaround can be considered.
296
296
297
-
### Deployment of culture & hostnames settings
297
+
### Deployment of culture & hostnames settings {#deployment-of-culture--hostnames-settings}
298
298
299
299
Culture and hostname settings, defined per content item for culture invariant content, are not deployed between environments by default. They can be opted into via configuration.
300
300
@@ -310,7 +310,7 @@ To enable this, set the configuration value as appropriate for the types of doma
310
310
311
311
Combinations of settings can be applied, e.g. `Hostname,AbsolutePath`.
312
312
313
-
## Deployment of public access settings
313
+
## Deployment of public access settings {#deployment-of-public-access-settings}
314
314
315
315
When deploying content items, public access rules based on member groups are transferred. You can amend this behavior using this setting.
316
316
@@ -325,7 +325,7 @@ When deploying content items, public access rules based on member groups are tra
325
325
326
326
`AddOrUpdate` is the default setting used if no value is configured.
327
327
328
-
### Deployment of webhooks
328
+
### Deployment of webhooks {#deployment-of-webhooks}
329
329
330
330
Webhooks may be considered environment specific or schema information that you would like to synchronize between environments. As such, by default, Umbraco Deploy does not include webhooks in schema deployment operations.
331
331
@@ -338,7 +338,7 @@ If you would like you include them you can adjust this setting:
338
338
*`None` - webhooks are not deployed and are expected to be managed independently in each environment
339
339
*`All` - webhooks included in schema deployments
340
340
341
-
## Deployment of trashed content
341
+
## Deployment of trashed content {#deployment-of-trashed-content}
342
342
343
343
Specifies options for handling trashed content (documents, media and members) on export or import:
344
344
@@ -365,7 +365,7 @@ If you would prefer to use SQL Server LocalDb when it's available on your local
Deploy will do comparisons between the entities in different environments to determine if they match and decide whether to include them in the operation. By default, for media files, a check is made on a portion of the initial bytes of the file.
371
371
@@ -375,37 +375,37 @@ If a lot of files need to be checked, this can be slow, and a faster option is a
When reviewing a set of items for a deployment operation, Deploy will retrieve and include relations. It does this either via single database lookups, or by bringing all relations into memory in one step, and retrieving them from there.
381
381
382
382
For small deployment operations, the former is the more optimal approach. It gets slow though when the number of items being transferred is large.
383
383
384
384
The cut-off before switching methods is set by this configuration value, and it defaults to an operation size of `100` items.
When restoring between different media systems exceptions can occur due to file paths. They can happen between a local file system and a remote system based on blob storage. What is accepted on one system may be rejected on another as the file path is too long. Normally this will only happen for files with particularly long names.
389
389
390
390
If you are happy to continue without throwing exceptions in these instances you can set this value to `true`. For example, this may make sense if restoring to a local or development environment. If this is done such files will be skipped, and although the media item will exist there will be no associated file.
When a Deploy operation completes, cache refresher notifications are fired. These are used to update Umbraco's cache and search index.
395
395
396
396
In production this setting shouldn't be changed from it's default value of `false`, to ensure these additional data stores are kept up to date.
397
397
398
398
If attempting a one-off, large transfer operation, before a site is live, you could set this value to `true`. That would omit the firing and handling of these notifications and remove their performance overhead. Following which you would need to ensure to rebuild the cache and search index manually via the backoffice _Settings_ dashboards.
With this setting assigned a value of `true`, Umbraco Deploy will attempt to resolve users when transfers are made to new environments.
403
403
404
404
Users and user groups are maintained separately in different environments, so it isn't always the case that an editor has accounts across all environments. When an account exists matching by email address, Deploy will associate the changes made in upstream environments with the user that initiated the transfer. Allowing the expected information about save and publish operations to be available in the audit log of the environment where the data was transferred.
405
405
406
406
When the setting is set to `false`, or a matching account isn't found, the audit records will be associated with the super-user administrator account.
407
407
408
-
### Suspensions
408
+
### Suspensions {#suspensions}
409
409
410
410
Deploy operations suspend scheduled publishing, Examine indexing, document cache and/or signature database update events by default. You can amend this behavior for all supported or specific operations using these settings.
411
411
@@ -457,11 +457,11 @@ internal sealed class DeploySuspensionsComposer : IComposer
0 commit comments