Skip to content

Commit d0f5a19

Browse files
Merge pull request #5756 from wso2/fixing-product-is-issue-25846-1764911127
Fix: Add documentation for cookie consent banner configuration for all affected versions (Product IS issue #25846)
2 parents d3452be + 97dedaf commit d0f5a19

File tree

10 files changed

+66
-1
lines changed

10 files changed

+66
-1
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{% include "../../../../../includes/deploy/configure/cookie-consent-banner.md" %}

en/identity-server/7.0.0/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -769,6 +769,7 @@ nav:
769769
- Data Purging: deploy/configure/databases/data-purging.md
770770
- Remove References to Deleted User Identities: deploy/configure/databases/remove-references-to-deleted-user-identities.md
771771
- Session persistence: deploy/configure/session-persistence.md
772+
- Cookie consent banner: deploy/configure/cookie-consent-banner.md
772773
- Cross-Origin Resource Sharing (CORS): deploy/configure/configure-cors.md
773774
- Email sending module : deploy/configure/email-sending-module.md
774775
- Secure:
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{% include "../../../../../includes/deploy/configure/cookie-consent-banner.md" %}

en/identity-server/7.1.0/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -843,6 +843,7 @@ nav:
843843
- Session persistence: deploy/configure/session-persistence.md
844844
- Cross-Origin Resource Sharing (CORS): deploy/configure/configure-cors.md
845845
- Clock tolerance: deploy/configure/clock-tolerance.md
846+
- Cookie consent banner: deploy/configure/cookie-consent-banner.md
846847
- Email sending module: deploy/configure/email-sending-module.md
847848

848849
- Secure:
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{% include "../../../../../includes/deploy/configure/cookie-consent-banner.md" %}

en/identity-server/7.2.0/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -902,6 +902,7 @@ nav:
902902
- Session persistence: deploy/configure/session-persistence.md
903903
- Cross-Origin Resource Sharing (CORS): deploy/configure/configure-cors.md
904904
- Clock tolerance: deploy/configure/clock-tolerance.md
905+
- Cookie consent banner: deploy/configure/cookie-consent-banner.md
905906
- Secure:
906907
- Mitigate attacks:
907908
- Mitigate attacks: deploy/mitigate-attacks/index.md
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{% include "../../../../../includes/deploy/configure/cookie-consent-banner.md" %}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{% include "../../../../../includes/guides/branding/index.md" %}
1+
{% include "../../../../../includes/guides/branding/index.md" %}

en/identity-server/next/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -903,6 +903,7 @@ nav:
903903
- Session persistence: deploy/configure/session-persistence.md
904904
- Cross-Origin Resource Sharing (CORS): deploy/configure/configure-cors.md
905905
- Clock tolerance: deploy/configure/clock-tolerance.md
906+
- Cookie consent banner: deploy/configure/cookie-consent-banner.md
906907
- Secure:
907908
- Mitigate attacks:
908909
- Mitigate attacks: deploy/mitigate-attacks/index.md
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Configure cookie consent banner
2+
3+
{{ product_name }} displays a cookie consent banner on the Console and MyAccount portals by default. This banner informs users about cookie usage and allows them to accept or manage their cookie preferences.
4+
5+
You can control the visibility of the cookie consent banner at different levels:
6+
7+
- **Globally**: Enable or disable the banner across all applications
8+
- **Per application**: Control the banner visibility for specific applications (Console or MyAccount)
9+
10+
## Enable/Disable cookie consent banner globally
11+
12+
To enable/disable the cookie consent banner globally across all applications, add the following configuration to the `<IS_HOME>/repository/conf/deployment.toml` file.
13+
14+
```toml
15+
[ui.cookie_consent_banner]
16+
enabled=false
17+
```
18+
19+
!!! note
20+
By default, the cookie consent banner is enabled. Set `enabled=false` to disable it globally.
21+
22+
## Enable/Disable cookie consent banner per application
23+
24+
You can control the cookie consent banner visibility for specific applications without affecting the global configuration. This allows you to disable the banner for the Console or MyAccount portal independently.
25+
26+
### For Console
27+
28+
To control the visibility of the cookie consent banner only for the Console application, add the following configuration to the `<IS_HOME>/repository/conf/deployment.toml` file:
29+
30+
```toml
31+
[console.ui]
32+
is_cookie_consent_banner_enabled=false
33+
```
34+
35+
### For My Account
36+
37+
To control the visibility of the cookie consent banner only for the MyAccount portal, add the following configuration to the `<IS_HOME>/repository/conf/deployment.toml` file:
38+
39+
```toml
40+
[myaccount.ui]
41+
is_cookie_consent_banner_enabled=false
42+
```
43+
44+
!!! note "Important"
45+
- These configurations do not affect the authentication or recovery portals. They only determine whether the banner is shown within the respective applications.
46+
- Per-application settings override the global configuration for that specific application.
47+
- By default, the cookie consent banner is enabled for both Console and MyAccount applications.
48+
49+
## Priority order for configurations
50+
51+
When determining whether to display the cookie consent banner, {{ product_name }} follows this priority order:
52+
53+
1. **Per-application configuration**: If a global and a per-application setting are present, the per-application configuration takes precedence for that application.
54+
55+
2. **Global configuration**: If no per-application configuration exists, the global setting applies.
56+
57+
3. **Default behavior**: If no configuration is specified, the cookie consent banner is enabled by default.

0 commit comments

Comments
 (0)