Skip to content

Commit d738851

Browse files
committed
[DURACOM-288] Change properties description
1 parent 290c24b commit d738851

3 files changed

Lines changed: 8 additions & 10 deletions

File tree

config/config.example.yml

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,16 @@ universal:
3535
# If set to true the component will be included in the HTML returned from the server side rendering.
3636
# If set to false the component will not be included in the HTML returned from the server side rendering.
3737
enableBrowseComponent: false
38-
3938
# Enable state transfer from the server-side application to the client-side application.
4039
# Defaults to true.
4140
# Note: When using an external application cache layer, it's recommended not to transfer the state to avoid caching it.
4241
# Disabling it ensures that dynamic state information is not inadvertently cached, which can improve security and
4342
# ensure that users always use the most up-to-date state.
44-
transferState: boolean;
45-
43+
transferState: true
4644
# When a different REST base URL is used for the server-side application, the generated state contains references to
47-
# REST resources with the internal URL configured, so it is not transferred to the client application, by default.
48-
# Enabling this setting transfers the state to the client application and replaces internal URLs with the public
49-
# URLs used by the client application.
50-
replaceRestUrl: boolean;
45+
# REST resources with the internal URL configured. By default, these internal URLs are replaced with public URLs.
46+
# Disable this setting to avoid URL replacement during SSR. In this the state is not transferred to avoid security issues.
47+
replaceRestUrl: true
5148

5249
# The REST API server settings
5350
# NOTE: these settings define which (publicly available) REST API to use. They are usually

src/config/server-config.interface.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,7 @@ export class ServerConfig implements Config {
77
public nameSpace: string;
88
public baseUrl?: string;
99
public ssrBaseUrl?: string;
10+
// This boolean will be automatically set on server startup based on whether "baseUrl" and "ssrBaseUrl"
11+
// have different values.
1012
public hasSsrBaseUrl?: boolean;
1113
}

src/config/universal-config.interface.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,8 @@ export interface UniversalConfig extends Config {
2626

2727
/**
2828
* When a different REST base URL is used for the server-side application, the generated state contains references to
29-
* REST resources with the internal URL configured, so it is not transferred to the client application, by default.
30-
* Enabling this setting transfers the state to the client application and replaces internal URLs with the public
31-
* URLs used by the client application.
29+
* REST resources with the internal URL configured. By default, these internal URLs are replaced with public URLs.
30+
* Disable this setting to avoid URL replacement during SSR. In this the state is not transferred to avoid security issues.
3231
*/
3332
replaceRestUrl: boolean;
3433

0 commit comments

Comments
 (0)