From 7af46ce88d7f0ee4ff9c94a0cc8a8062ace3013f Mon Sep 17 00:00:00 2001 From: Andy Butland Date: Mon, 8 Jul 2024 12:19:23 +0200 Subject: [PATCH] Corrected details of default values for IP tracking across Forms versions. --- 10/umbraco-forms/developer/configuration/README.md | 2 +- 12/umbraco-forms/developer/configuration/README.md | 6 +++--- 12/umbraco-forms/upgrading/version-specific.md | 2 +- 13/umbraco-forms/developer/configuration/README.md | 7 +++---- 14/umbraco-forms/developer/configuration/README.md | 6 +++--- 5 files changed, 11 insertions(+), 12 deletions(-) diff --git a/10/umbraco-forms/developer/configuration/README.md b/10/umbraco-forms/developer/configuration/README.md index f0a497d6246..8842e95e5de 100644 --- a/10/umbraco-forms/developer/configuration/README.md +++ b/10/umbraco-forms/developer/configuration/README.md @@ -83,7 +83,7 @@ For illustration purposes, the following structure represents the full set of op }, "DisableRecordIndexing": false, "EnableFormsApi": false, - "EnableRecordingOfIpWithFormSubmission": "true", + "EnableRecordingOfIpWithFormSubmission": true, "UseSemanticFieldsetRendering": false, "DisableRelationTracking": false, "TrackRenderedFormsStorageMethod": "TempData" diff --git a/12/umbraco-forms/developer/configuration/README.md b/12/umbraco-forms/developer/configuration/README.md index c9cf18b5ca4..53672631db3 100644 --- a/12/umbraco-forms/developer/configuration/README.md +++ b/12/umbraco-forms/developer/configuration/README.md @@ -83,7 +83,7 @@ For illustration purposes, the following structure represents the full set of op }, "DisableRecordIndexing": false, "EnableFormsApi": false, - "EnableRecordingOfIpWithFormSubmission": "true", + "EnableRecordingOfIpWithFormSubmission": false, "UseSemanticFieldsetRendering": false, "DisableClientSideValidationDependencyCheck": false, "DisableRelationTracking": false, @@ -371,9 +371,9 @@ Set this value to `true` to enable the Forms API supporting headless and AJAX fo ### EnableRecordingOfIpWithFormSubmission -The user's IP address is recorded by default when a form is submitted and stored in the `UFRecords` database table. +By default, the user's IP address is not recorded when a form is submitted and stored in the `UFRecords` database table. -To remove this behavior set this value to `false`. +To include this information in the saved data, set this value to `true`. If recording IPs and your site is behind a proxy, load balancer or CDN, we recommend using [ASP.NET's forwarded headers middleware](https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/proxy-load-balancer?view=aspnetcore-7.0) to ensure the correct value for the client IP is resolved. diff --git a/12/umbraco-forms/upgrading/version-specific.md b/12/umbraco-forms/upgrading/version-specific.md index 79d4c78f1e0..3c9d6af434f 100644 --- a/12/umbraco-forms/upgrading/version-specific.md +++ b/12/umbraco-forms/upgrading/version-specific.md @@ -24,7 +24,7 @@ For reference, the full details are listed here: #### **Behavior** -* The default value for configuration of request IP tracking has been changed to `None` from `RemoteIpAddress`. +* The default value for configuration of request IP tracking via the `EnableRecordingOfIpWithFormSubmission` setting has been changed to `true` from `false`. * The session variable `ContourMemberKey` is no longer set. * Exception handling in the Forms API has been aligned with the CMS Delivery API. This leads to subtle differences in the population of the `ProblemDetails` exposed. * Use of the Forms API has to be enabled in configuration, via setting the `Umbraco:Forms:Options:EnableFormsApi` key to `true`. diff --git a/13/umbraco-forms/developer/configuration/README.md b/13/umbraco-forms/developer/configuration/README.md index f81c03bc45f..e9ca1a8af48 100644 --- a/13/umbraco-forms/developer/configuration/README.md +++ b/13/umbraco-forms/developer/configuration/README.md @@ -84,7 +84,7 @@ For illustration purposes, the following structure represents the full set of op }, "DisableRecordIndexing": false, "EnableFormsApi": false, - "EnableRecordingOfIpWithFormSubmission": "true", + "EnableRecordingOfIpWithFormSubmission": false, "UseSemanticFieldsetRendering": false, "DisableClientSideValidationDependencyCheck": false, "DisableRelationTracking": false, @@ -379,10 +379,9 @@ Set this value to `true` to enable the Forms API supporting headless and AJAX fo ### EnableRecordingOfIpWithFormSubmission -The user's IP address is recorded by default when a form is submitted and stored in the `UFRecords` database table. - -To remove this behavior set this value to `false`. +By default, the user's IP address is not recorded when a form is submitted and stored in the `UFRecords` database table. +To include this information in the saved data, set this value to `true`. If recording IPs and your site is behind a proxy, load balancer or CDN, we recommend using [ASP.NET's forwarded headers middleware](https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/proxy-load-balancer?view=aspnetcore-7.0) to ensure the correct value for the client IP is resolved. ### UseSemanticFieldsetRendering diff --git a/14/umbraco-forms/developer/configuration/README.md b/14/umbraco-forms/developer/configuration/README.md index 287afffe29b..f8ac7bcb136 100644 --- a/14/umbraco-forms/developer/configuration/README.md +++ b/14/umbraco-forms/developer/configuration/README.md @@ -84,7 +84,7 @@ For illustration purposes, the following structure represents the full set of op }, "DisableRecordIndexing": false, "EnableFormsApi": false, - "EnableRecordingOfIpWithFormSubmission": "true", + "EnableRecordingOfIpWithFormSubmission": false, "UseSemanticFieldsetRendering": false, "DisableClientSideValidationDependencyCheck": false, "DisableRelationTracking": false, @@ -379,9 +379,9 @@ Set this value to `true` to enable the Forms API supporting headless and AJAX fo ### EnableRecordingOfIpWithFormSubmission -The user's IP address is recorded by default when a form is submitted and stored in the `UFRecords` database table. +By default, the user's IP address is not recorded when a form is submitted and stored in the `UFRecords` database table. -To remove this behavior set this value to `false`. +To include this information in the saved data, set this value to `true`. If recording IPs and your site is behind a proxy, load balancer or CDN, we recommend using [ASP.NET's forwarded headers middleware](https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/proxy-load-balancer?view=aspnetcore-7.0) to ensure the correct value for the client IP is resolved.