hazza/dspace-angular
1
0
Fork 1
mirror of https://github.com/DSpace/dspace-angular.git synced 2025-10-07 01:54:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DURACOM-288] Change properties description

Browse Source
This commit is contained in:
Giuseppe Digilio
2025-01-30 20:42:20 +01:00
parent d52a09406d
commit f3534537ea
3 changed files with 10 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
config/config.example.yml
View File

@@ -19,14 +19,9 @@ ui:
# Angular Server Side Rendering (SSR) settings # Angular Server Side Rendering (SSR) settings
ssr: ssr:
# A boolean flag indicating whether the SSR configuration is enabled
# Defaults to true.
enabled: boolean;
# Enable request performance profiling data collection and printing the results in the server console. # Enable request performance profiling data collection and printing the results in the server console.
# Defaults to false. # Defaults to false. Enabling in production is NOT recommended
enablePerformanceProfiler: boolean; enablePerformanceProfiler: false
# Whether to tell Angular to inline "critical" styles into the server-side rendered HTML. # Whether to tell Angular to inline "critical" styles into the server-side rendered HTML.
# Determining which styles are critical is a relatively expensive operation; this option is # Determining which styles are critical is a relatively expensive operation; this option is
# disabled (false) by default to boost server performance at the expense of loading smoothness. # disabled (false) by default to boost server performance at the expense of loading smoothness.
@@ -43,19 +38,16 @@ ssr:
# If set to true the component will be included in the HTML returned from the server side rendering. # If set to true the component will be included in the HTML returned from the server side rendering.
# If set to false the component will not be included in the HTML returned from the server side rendering. # If set to false the component will not be included in the HTML returned from the server side rendering.
enableBrowseComponent: false enableBrowseComponent: false
# Enable state transfer from the server-side application to the client-side application. # Enable state transfer from the server-side application to the client-side application.
# Defaults to true. # Defaults to true.
# Note: When using an external application cache layer, it's recommended not to transfer the state to avoid caching it. # Note: When using an external application cache layer, it's recommended not to transfer the state to avoid caching it.
# Disabling it ensures that dynamic state information is not inadvertently cached, which can improve security and # Disabling it ensures that dynamic state information is not inadvertently cached, which can improve security and
# ensure that users always use the most up-to-date state. # ensure that users always use the most up-to-date state.
transferState: boolean; transferState: true
# When a different REST base URL is used for the server-side application, the generated state contains references to # When a different REST base URL is used for the server-side application, the generated state contains references to
# REST resources with the internal URL configured, so it is not transferred to the client application, by default. # REST resources with the internal URL configured. By default, these internal URLs are replaced with public URLs.
# Enabling this setting transfers the state to the client application and replaces internal URLs with the public # Disable this setting to avoid URL replacement during SSR. In this the state is not transferred to avoid security issues.
# URLs used by the client application. replaceRestUrl: true
replaceRestUrl: boolean;
# The REST API server settings # The REST API server settings
# NOTE: these settings define which (publicly available) REST API to use. They are usually # NOTE: these settings define which (publicly available) REST API to use. They are usually

2
src/config/server-config.interface.ts
View File

@@ -7,5 +7,7 @@ export class ServerConfig implements Config {
public nameSpace: string; public nameSpace: string;
public baseUrl?: string; public baseUrl?: string;
public ssrBaseUrl?: string; public ssrBaseUrl?: string;
// This boolean will be automatically set on server startup based on whether "baseUrl" and "ssrBaseUrl"
// have different values.
public hasSsrBaseUrl?: boolean; public hasSsrBaseUrl?: boolean;
} }

5
src/config/ssr-config.interface.ts
View File

@@ -33,9 +33,8 @@ export interface SSRConfig extends Config {
/** /**
* When a different REST base URL is used for the server-side application, the generated state contains references to * When a different REST base URL is used for the server-side application, the generated state contains references to
* REST resources with the internal URL configured, so it is not transferred to the client application, by default. * REST resources with the internal URL configured. By default, these internal URLs are replaced with public URLs.
* Enabling this setting transfers the state to the client application and replaces internal URLs with the public * Disable this setting to avoid URL replacement during SSR. In this the state is not transferred to avoid security issues.
* URLs used by the client application.
*/ */
replaceRestUrl: boolean; replaceRestUrl: boolean;