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: 15/umbraco-deploy/README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,14 @@ description: Documentation on how to work with Umbraco Deploy.
6
6
7
7
Umbraco Deploy is a deployment tool that helps you with the process of transferring code and data between multiple environments. Deploy can be configured for many different setups and is great for both small setups as well as large and more complex infrastructures.
8
8
9
-
<tabledata-view="cards"><thead><tr><th></th><th></th><thdata-hiddendata-card-coverdata-type="files"></th><thdata-hiddendata-card-targetdata-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Set up Umbraco Deploy</strong></td><td>Learn how you can set up Umbraco Deploy on new and existing Umbraco projects.</td><td><ahref=".gitbook/assets/update.png">update.png</a></td><td><ahref="installation/install-configure.md">install-configure.md</a></td></tr><tr><td><strong>Deployment workflow in</strong></td><td>Learn about how the Deployment workflow in Umbraco Deploy work.</td><td><ahref=".gitbook/assets/lightbulb.png">lightbulb.png</a></td><td><ahref="deployment-workflow/">deployment-workflow</a></td></tr><tr><td><strong>Upgrading</strong></td><td>Learn how you can upgrade Umbraco Deploy.</td><td><ahref=".gitbook/assets/code_cursor.png">code_cursor.png</a></td><td><ahref="upgrades/">upgrades</a></td></tr></tbody></table>
9
+
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Set up Umbraco Deploy</strong></td><td>Learn how you can set up Umbraco Deploy on new and existing Umbraco projects.</td><td><a href=".gitbook/assets/Documentations Icons_Umbraco_Deploy_Setup.png">Documentations Icons_Umbraco_Deploy_Setup.png</a></td><td><a href="installation/install-configure.md">install-configure.md</a></td></tr><tr><td><strong>Deployment workflow in</strong></td><td>Learn about how the Deployment workflow in Umbraco Deploy work.</td><td><a href=".gitbook/assets/Documentations Icons_Umbraco_Deploy_Deployment_Workflow.png">Documentations Icons_Umbraco_Deploy_Deployment_Workflow.png</a></td><td><a href="deployment-workflow/">deployment-workflow</a></td></tr><tr><td><strong>Upgrading</strong></td><td>Learn how you can upgrade Umbraco Deploy.</td><td><a href=".gitbook/assets/Documentations Icons_Umbraco_Deploy_Upgrading.png">Documentations Icons_Umbraco_Deploy_Upgrading.png</a></td><td><a href="upgrades/">upgrades</a></td></tr></tbody></table>
Copy file name to clipboardExpand all lines: 15/umbraco-deploy/deploy-settings.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -184,7 +184,7 @@ If encountering this issue, there are two batch settings that can be applied wit
184
184
185
185
When Deploy transfers files between unconnected environments (like a non-public local environment), it falls back from fetching/downloading the files to uploading them. This is done in fixed-sized chunks, so multiple files can be combined in a single request or a large file into multiple requests. This setting can specify the size of these chunks **(in bytes)**.
186
186
187
-
If no value is set, Deploy will create 16MB chunks, unless the [CMS `MaxRequestLength` setting](../../umbraco-cms/reference/configuration/runtimesettings.md) is lower (CMS setting is configured in kilobytes). Setting a value higher than the CMS `MaxRequestLength` (multiplied by 1024) will cause a validation error. Similarly, configuring a value higher than the [server or infrastructure limits](../../umbraco-cms/reference/configuration/maximumuploadsizesettings.md) will result in file transfers failures.
187
+
If no value is set, Deploy will create 16MB chunks, unless the [CMS `MaxRequestLength` setting](../umbraco-cms/reference/configuration/runtimesettings.md) is lower (CMS setting is configured in kilobytes). Setting a value higher than the CMS `MaxRequestLength` (multiplied by 1024) will cause a validation error. Similarly, configuring a value higher than the [server or infrastructure limits](../umbraco-cms/reference/configuration/maximumuploadsizesettings.md) will result in file transfers failures.
Each setting within this section represents a Deploy operation. For each, the suspensions that are carried out can be amended with one or more of following values:
Copy file name to clipboardExpand all lines: 15/umbraco-deploy/deployment-workflow/content-transfer.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ You want to transfer the whole site. You start from the `Home` node and choose t
25
25
4. Choose if you want to include all pages under the chosen page or only transfer the chosen node.
26
26
* If you wish to transfer all your content at once, click **...** next to the Content tree where you will also find **Queue for transfer** - this will queue all your content for transfer.
27
27
5. Select the language versions that you want to queue for transfer. Only languages for which you have permission to access will be selectable.
28
-
6. Set the publish date and time if you want to change when the transferred content should be published.
28
+
6.Set the publish date and time if you want to change when the transferred content should be published.
29
29
30
30
{% hint style="info" %}
31
31
By default, the content will be transferred in its current published state. So if the content is published in the current environment, the changes will be deployed and the item immediately be published in the destination. If you prefer to schedule the publishing of the changes, you can do so by selecting a publish date.
@@ -52,7 +52,7 @@ Media items are transferred the same way as content:
52
52
53
53
### Umbraco Forms
54
54
55
-
In order for Deploy to handle Forms data as content, you will need to ensure that the `transferFormsAsContent` setting in configuration is set to `true`. See details in the [Deploy Settings for Umbraco 9+](../getting-started/deploy-settings.md) article.
55
+
In order for Deploy to handle Forms data as content, you will need to ensure that the `transferFormsAsContent` setting in configuration is set to `true`. See details in the [Deploy Settings for Umbraco 9+](../deploy-settings.md) article.
56
56
57
57
Once the setting have been added to the source and target environment forms can be transferred the same way as content and media:
Copy file name to clipboardExpand all lines: 15/umbraco-deploy/deployment-workflow/deploy-dashboard.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ This operation is useful if you want to move to another Umbraco instance and mig
56
56
57
57
## Configuration Details
58
58
59
-
In the Configuration details, you can see how Umbraco Deploy has been [configured](../getting-started/deploy-settings.md) 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.
59
+
In the Configuration details, you can see how Umbraco Deploy has been [configured](../deploy-settings.md) 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.
60
60
61
61
<figure><imgsrc="../.gitbook/assets/image (2) (1).png"alt=""><figcaption><p>Example of Umbraco Deploy configuration.</p></figcaption></figure>
Copy file name to clipboardExpand all lines: 15/umbraco-deploy/troubleshooting.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,21 +42,21 @@ As this process requires less inter-environment communication, it's possible to
42
42
43
43
### Review timeouts
44
44
45
-
Firstly, you can review and update the [timeout settings available with Deploy](getting-started/deploy-settings.md#timeout-settings). Increasing these from the default values may help, but won't necessarily resolve all issues. This is because, as noted, some timeouts are fixed values set by the hosting environment.
45
+
Firstly, you can review and update the [timeout settings available with Deploy](deploy-settings.md#timeout-settings). Increasing these from the default values may help, but won't necessarily resolve all issues. This is because, as noted, some timeouts are fixed values set by the hosting environment.
46
46
47
47
### Use batch configurations
48
48
49
49
There are two places where Deploy operations can be batched. This allows breaking up of a single, long process into multiple, smaller ones. By doing this it's possible to complete each smaller operation within the platform imposed timeout.
50
50
51
51
#### For transfers to upstream environments
52
52
53
-
If transferring items from a downstream environment to an upstream one, it's possible to [configure a batch size](getting-started/deploy-settings.md#batch-settings). With this in place, transfers will be batched into separate operations, allowing each single operation to complete before any hosting environment-enforced timeout.
53
+
If transferring items from a downstream environment to an upstream one, it's possible to [configure a batch size](deploy-settings.md#batch-settings). With this in place, transfers will be batched into separate operations, allowing each single operation to complete before any hosting environment-enforced timeout.
54
54
55
55
This will take effect only for transfers to upstream environments and when multiple items are selected in the backoffice. An example is the selection of a single media folder containing many files.
56
56
57
57
#### For processing of a Deploy "package"
58
58
59
-
A package is an ordered structure containing all the items selected for a Deploy operation, plus all the determined dependencies and relations. The processing of this package in the target environment can also be batched via a [configuration setting](getting-started/deploy-settings.md#batch-settings).
59
+
A package is an ordered structure containing all the items selected for a Deploy operation, plus all the determined dependencies and relations. The processing of this package in the target environment can also be batched via a [configuration setting](deploy-settings.md#batch-settings).
60
60
61
61
When set, if the number of items determined for the package exceeds the batch size, the processing will be chunked into batches.
62
62
@@ -76,27 +76,27 @@ Deploy will do comparisons between the entities in different environments to det
76
76
77
77
If a lot of files need to be checked, this can be slow, and a faster option is available that uses the file metadata. The only downside of changing this option is a marginally increased chance of Deploy considering a media file hasn't changed when it has. This would omit it from the deployment.
78
78
79
-
This option can be [set in configuration](getting-started/deploy-settings.md#mediafilechecksumcalculationmethod).
79
+
This option can be [set in configuration](deploy-settings.md#mediafilechecksumcalculationmethod).
When a Deploy operation completes, cache refresher notifications are fired. These are used to update Umbraco's cache and search index.
84
84
85
85
In production these should always be enabled, to ensure these additional data stores are kept up to date.
86
86
87
-
If attempting a one-off, large transfer operation, before a site is live, you could disable these via a [configuration setting](getting-started/deploy-settings.md#suppresscacherefreshernotifications). 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.
87
+
If attempting a one-off, large transfer operation, before a site is live, you could disable these via a [configuration setting](deploy-settings.md#suppresscacherefreshernotifications). 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.
88
88
89
89
### Review relation types included in deploy operations
90
90
91
91
As well as transferring entities between environments Deploy will also include the relations between them. As of 10.1.2 and 11.0.1, two relation types used for usage tracking are omitted by default. These do not need to be transferred as they are recreated by the CMS as part of the save operation on the entity.
92
92
93
-
If using an earlier version, or to make further adjustments, modify the [settings for relation types](getting-started/deploy-settings.md#relationtypes) in configuration.
93
+
If using an earlier version, or to make further adjustments, modify the [settings for relation types](deploy-settings.md#relationtypes) in configuration.
94
94
95
95
## Path too long exceptions
96
96
97
97
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.
98
98
99
-
If you are happy to continue without throwing exceptions in these instances you can [modify the configuration](getting-started/deploy-settings.md#continueonmediafilepathtoolongexception). If this is done such files will be skipped, and although the media item will exist there will be no associated file.
99
+
If you are happy to continue without throwing exceptions in these instances you can [modify the configuration](deploy-settings.md#continueonmediafilepathtoolongexception). If this is done such files will be skipped, and although the media item will exist there will be no associated file.
0 commit comments