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: 13/umbraco-deploy/getting-started/deploy-settings.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -114,7 +114,7 @@ Our recommended approach is to leave this setting as `Default` and use source co
114
114
115
115
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.
116
116
117
-
### ExcludedEntityTypes
117
+
### ExcludedEntityTypes {#excludedentitytypes}
118
118
119
119
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:
120
120
@@ -153,7 +153,7 @@ Here is an example of how the setting can look:
153
153
},
154
154
```
155
155
156
-
### Timeout settings
156
+
### Timeout settings {#timeout-settings}
157
157
158
158
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.
159
159
@@ -178,7 +178,7 @@ This setting defaults to 5 minutes.
178
178
179
179
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).
180
180
181
-
### Batch settings
181
+
### Batch settings {#batch-settings}
182
182
183
183
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.
184
184
@@ -197,15 +197,15 @@ From 10.1, a database-backed queue was implemented and is used by default.
197
197
198
198
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`.
203
203
204
204
{% hint style="info" %}
205
205
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`.
211
211
@@ -229,7 +229,7 @@ If you transfer a dictionary item with an empty translation to another environme
229
229
230
230
Set this value to `false` to not overwrite already populated values with empty strings.
231
231
232
-
### AllowMembersDeploymentOperations and TransferMemberGroupsAsContent
232
+
### AllowMembersDeploymentOperations and TransferMemberGroupsAsContent {#transfer-members}
233
233
234
234
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.
235
235
@@ -246,13 +246,13 @@ With `TransferMemberGroupsAsContent` set to `true`, member groups can also be tr
246
246
247
247
Please see the note above under _TransferFormsAsContent_ on the topic of removing any existing serialized files having changed this value to `true`.
248
248
249
-
### ExportMemberGroups
249
+
### ExportMemberGroups {#exporting-member-groups}
250
250
251
251
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.
252
252
253
253
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.
258
258
@@ -277,7 +277,7 @@ When configuring for Deploy 9, an additional `IgnoreBrokenDependencies` setting
277
277
"IgnoreBrokenDependenciesBehavior": "Restore",
278
278
```
279
279
280
-
### Memory cache reload
280
+
### Memory cache reload {#memory-cache-reload}
281
281
282
282
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:
283
283
@@ -287,7 +287,7 @@ Some customers have reported intermittent issues related to Umbraco's memory cac
287
287
288
288
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.
289
289
290
-
### Deployment of culture & hostnames settings
290
+
### Deployment of culture & hostnames settings {#deployment-of-culture--hostnames-settings}
291
291
292
292
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.
293
293
@@ -303,7 +303,7 @@ To enable this, set the configuration value as appropriate for the types of doma
303
303
304
304
Combinations of settings can be applied, e.g. `Hostname,AbsolutePath`.
305
305
306
-
## Deployment of public access settings
306
+
## Deployment of public access settings {#deployment-of-public-access-settings}
307
307
308
308
When deploying content items, public access rules based on member groups are transferred. You can amend this behavior using this setting.
309
309
@@ -318,7 +318,7 @@ When deploying content items, public access rules based on member groups are tra
318
318
319
319
`AddOrUpdate` is the default setting used if no value is configured.
320
320
321
-
### Deployment of webhooks
321
+
### Deployment of webhooks {#deployment-of-webhooks}
322
322
323
323
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.
324
324
@@ -331,7 +331,7 @@ If you would like you include them you can adjust this setting:
331
331
*`None` - webhooks are not deployed and are expected to be managed independently in each environment
332
332
*`All` - webhooks included in schema deployments
333
333
334
-
## Deployment of trashed content
334
+
## Deployment of trashed content {#deployment-of-trashed-content}
335
335
336
336
Specifies options for handling trashed content (documents, media and members) on export or import:
337
337
@@ -358,7 +358,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.
364
364
@@ -368,15 +368,15 @@ 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.
374
374
375
375
For small deployment operations, the former is the more optimal approach. It gets slow though when the number of items being transferred is large.
376
376
377
377
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.
382
382
@@ -398,7 +398,7 @@ Users and user groups are maintained separately in different environments, so it
398
398
399
399
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.
400
400
401
-
### Suspensions
401
+
### Suspensions {#suspensions}
402
402
403
403
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.
0 commit comments