Skip to content

Commit f353453

Browse files
committed
[DURACOM-288] Change properties description
1 parent d52a094 commit f353453

File tree

3 files changed

+10
-17
lines changed

3 files changed

+10
-17
lines changed

config/config.example.yml

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,9 @@ ui:
1919

2020
# Angular Server Side Rendering (SSR) settings
2121
ssr:
22-
# A boolean flag indicating whether the SSR configuration is enabled
23-
# Defaults to true.
24-
enabled: boolean;
25-
2622
# Enable request performance profiling data collection and printing the results in the server console.
27-
# Defaults to false.
28-
enablePerformanceProfiler: boolean;
29-
23+
# Defaults to false. Enabling in production is NOT recommended
24+
enablePerformanceProfiler: false
3025
# Whether to tell Angular to inline "critical" styles into the server-side rendered HTML.
3126
# Determining which styles are critical is a relatively expensive operation; this option is
3227
# disabled (false) by default to boost server performance at the expense of loading smoothness.
@@ -43,19 +38,16 @@ ssr:
4338
# If set to true the component will be included in the HTML returned from the server side rendering.
4439
# If set to false the component will not be included in the HTML returned from the server side rendering.
4540
enableBrowseComponent: false
46-
4741
# Enable state transfer from the server-side application to the client-side application.
4842
# Defaults to true.
4943
# Note: When using an external application cache layer, it's recommended not to transfer the state to avoid caching it.
5044
# Disabling it ensures that dynamic state information is not inadvertently cached, which can improve security and
5145
# ensure that users always use the most up-to-date state.
52-
transferState: boolean;
53-
46+
transferState: true
5447
# When a different REST base URL is used for the server-side application, the generated state contains references to
55-
# REST resources with the internal URL configured, so it is not transferred to the client application, by default.
56-
# Enabling this setting transfers the state to the client application and replaces internal URLs with the public
57-
# URLs used by the client application.
58-
replaceRestUrl: boolean;
48+
# REST resources with the internal URL configured. By default, these internal URLs are replaced with public URLs.
49+
# Disable this setting to avoid URL replacement during SSR. In this the state is not transferred to avoid security issues.
50+
replaceRestUrl: true
5951

6052
# The REST API server settings
6153
# 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/ssr-config.interface.ts

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

3434
/**
3535
* When a different REST base URL is used for the server-side application, the generated state contains references to
36-
* REST resources with the internal URL configured, so it is not transferred to the client application, by default.
37-
* Enabling this setting transfers the state to the client application and replaces internal URLs with the public
38-
* URLs used by the client application.
36+
* REST resources with the internal URL configured. By default, these internal URLs are replaced with public URLs.
37+
* Disable this setting to avoid URL replacement during SSR. In this the state is not transferred to avoid security issues.
3938
*/
4039
replaceRestUrl: boolean;
4140

0 commit comments

Comments
 (0)