Skip to content

Commit 596e270

Browse files
Add settings anchors for Deploy 14
1 parent 807c6c5 commit 596e270

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

14/umbraco-deploy/getting-started/deploy-settings.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Our recommended approach is to leave this setting as `Default` and use source co
115115

116116
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.
117117

118-
### ExcludedEntityTypes
118+
### ExcludedEntityTypes {#excludedentitytypes}
119119

120120
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:
121121

@@ -154,7 +154,7 @@ Here is an example of how the setting can look:
154154
},
155155
```
156156

157-
### Timeout settings
157+
### Timeout settings {#timeout-settings}
158158

159159
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.
160160

@@ -179,7 +179,7 @@ This setting defaults to 5 minutes.
179179

180180
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).
181181

182-
### Batch settings
182+
### Batch settings {#batch-settings}
183183

184184
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.
185185

@@ -204,21 +204,21 @@ From 10.1, a database-backed queue was implemented and is used by default.
204204

205205
If for any reason there was a need to revert to the previous implementation, the value of this setting can be set to `false`.
206206

207-
### TransferFormsAsContent
207+
### TransferFormsAsContent {#transfer-forms-data-as-content}
208208

209209
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`.
210210

211211
{% hint style="info" %}
212212
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.
213213
{% endhint %}
214214

215-
### TransferDictionaryAsContent
215+
### TransferDictionaryAsContent {#transfer-dictionary-items-as-content}
216216

217217
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`.
218218

219219
Please see the note above under _TransferFormsAsContent_ on the topic of removing any existing serialized files having changed this value to `true`.
220220

221-
### IgnoreMissingLanguagesForDictionaryItems
221+
### IgnoreMissingLanguagesForDictionaryItems {#ignore-missing-languages-for-dictionary-items}
222222

223223
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.
224224

@@ -228,15 +228,15 @@ If you have deleted languages that have already existing translations, you may w
228228

229229
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.
230230

231-
### SetEmptyDictionaryItemsOnTransfer
231+
### SetEmptyDictionaryItemsOnTransfer {#set-empty-dictionary-items-on-transfer}
232232

233233
When deploying dictionary items, Umbraco Deploy follows the approach used for all content, emptying values that are transferred and set.
234234

235235
If you transfer a dictionary item with an empty translation to another environment that already contains a translation, it will be overwritten.
236236

237237
Set this value to `false` to not overwrite already populated values with empty strings.
238238

239-
### AllowMembersDeploymentOperations and TransferMemberGroupsAsContent
239+
### AllowMembersDeploymentOperations and TransferMemberGroupsAsContent {#transfer-members}
240240

241241
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.
242242

@@ -253,13 +253,13 @@ With `TransferMemberGroupsAsContent` set to `true`, member groups can also be tr
253253

254254
Please see the note above under _TransferFormsAsContent_ on the topic of removing any existing serialized files having changed this value to `true`.
255255

256-
### ExportMemberGroups
256+
### ExportMemberGroups {#exporting-member-groups}
257257

258258
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.
259259

260260
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.
261261

262-
### IgnoreBrokenDependenciesBehavior
262+
### IgnoreBrokenDependenciesBehavior {#ignore-broken-dependencies}
263263

264264
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.
265265

@@ -284,7 +284,7 @@ When configuring for Deploy 9, an additional `IgnoreBrokenDependencies` setting
284284
"IgnoreBrokenDependenciesBehavior": "Restore",
285285
```
286286

287-
### Memory cache reload
287+
### Memory cache reload {#memory-cache-reload}
288288

289289
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:
290290

@@ -294,7 +294,7 @@ Some customers have reported intermittent issues related to Umbraco's memory cac
294294

295295
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.
296296

297-
### Deployment of culture & hostnames settings
297+
### Deployment of culture & hostnames settings {#deployment-of-culture--hostnames-settings}
298298

299299
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.
300300

@@ -310,7 +310,7 @@ To enable this, set the configuration value as appropriate for the types of doma
310310

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

313-
## Deployment of public access settings
313+
## Deployment of public access settings {#deployment-of-public-access-settings}
314314

315315
When deploying content items, public access rules based on member groups are transferred. You can amend this behavior using this setting.
316316

@@ -325,7 +325,7 @@ When deploying content items, public access rules based on member groups are tra
325325

326326
`AddOrUpdate` is the default setting used if no value is configured.
327327

328-
### Deployment of webhooks
328+
### Deployment of webhooks {#deployment-of-webhooks}
329329

330330
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.
331331

@@ -338,7 +338,7 @@ If you would like you include them you can adjust this setting:
338338
* `None` - webhooks are not deployed and are expected to be managed independently in each environment
339339
* `All` - webhooks included in schema deployments
340340

341-
## Deployment of trashed content
341+
## Deployment of trashed content {#deployment-of-trashed-content}
342342

343343
Specifies options for handling trashed content (documents, media and members) on export or import:
344344

@@ -365,7 +365,7 @@ If you would prefer to use SQL Server LocalDb when it's available on your local
365365
"PreferLocalDbConnectionString": true
366366
```
367367

368-
### MediaFileChecksumCalculationMethod
368+
### MediaFileChecksumCalculationMethod {#media-file-checksum-calculation-method}
369369

370370
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.
371371

@@ -375,37 +375,37 @@ If a lot of files need to be checked, this can be slow, and a faster option is a
375375

376376
To use this method, set the value to `Metadata`.
377377

378-
### NumberOfSignaturesToUseAllRelationCache
378+
### NumberOfSignaturesToUseAllRelationCache {#number-of-signatures-to-use-all-relation-cache}
379379

380380
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.
381381

382382
For small deployment operations, the former is the more optimal approach. It gets slow though when the number of items being transferred is large.
383383

384384
The cut-off before switching methods is set by this configuration value, and it defaults to an operation size of `100` items.
385385

386-
### ContinueOnMediaFilePathTooLongException
386+
### ContinueOnMediaFilePathTooLongException {#ignore-media-file-path-too-long-exception}
387387

388388
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.
389389

390390
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.
391391

392-
### SuppressCacheRefresherNotifications
392+
### SuppressCacheRefresherNotifications {#suppress-cache-refresher-notifications}
393393

394394
When a Deploy operation completes, cache refresher notifications are fired. These are used to update Umbraco's cache and search index.
395395

396396
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.
397397

398398
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.
399399

400-
## ResolveUserInTargetEnvironment
400+
## ResolveUserInTargetEnvironment {#resolve-user-in-target-environment}
401401

402402
With this setting assigned a value of `true`, Umbraco Deploy will attempt to resolve users when transfers are made to new environments.
403403

404404
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.
405405

406406
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.
407407

408-
### Suspensions
408+
### Suspensions {#suspensions}
409409

410410
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.
411411

@@ -457,11 +457,11 @@ internal sealed class DeploySuspensionsComposer : IComposer
457457
}
458458
```
459459

460-
### HideConfigurationDetails
460+
### HideConfigurationDetails {#hide-configuration-details}
461461

462462
If set to `true` the configuration details shown on the setting's dashboard will be hidden.
463463

464-
### HideVersionDetails
464+
### HideVersionDetails {#hide-version-details}
465465

466466
If set to `true` the version details shown on the setting's dashboard will be hidden.
467467

0 commit comments

Comments
 (0)