From 45ee56fe8f64e36b8f24f8b4dc71f0fecf23b2c4 Mon Sep 17 00:00:00 2001
From: Giuseppe Digilio <giuseppe.digilio@4science.com>
Date: Thu, 9 Jan 2025 18:46:45 +0100
Subject: [PATCH] [DURACOM-288] Add missing settings to config.example.yml

---
 config/config.example.yml | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/config/config.example.yml b/config/config.example.yml
index 099bea2614..dca0d698c6 100644
--- a/config/config.example.yml
+++ b/config/config.example.yml
@@ -19,6 +19,14 @@ ui:
 
 # Angular Server Side Rendering (SSR) settings
 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.
+  # Defaults to false.
+  enablePerformanceProfiler: boolean;
+
   # 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
   # disabled (false) by default to boost server performance at the expense of loading smoothness.
@@ -34,6 +42,19 @@ ssr:
   # If set to false the component will not be included in the HTML returned from the server side rendering.
   enableBrowseComponent: false,
 
+  # Enable state transfer from the server-side application to the client-side application.
+  # Defaults to true.
+  # 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
+  # ensure that users always use the most up-to-date state.
+  transferState: boolean;
+
+  # 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.
+  # Enabling this setting transfers the state to the client application and replaces internal URLs with the public
+  # URLs used by the client application.
+  replaceRestUrl: boolean;
+
 # The REST API server settings
 # NOTE: these settings define which (publicly available) REST API to use. They are usually
 # 'synced' with the 'dspace.server.url' setting in your backend's local.cfg.
@@ -43,6 +64,9 @@ rest:
   port: 443
   # NOTE: Space is capitalized because 'namespace' is a reserved string in TypeScript
   nameSpace: /server
+  # Provide a different REST url to be used during SSR execution. It must contain the whole url including protocol, server port and
+  # server namespace (uncomment to use it).
+  #ssrBaseUrl: http://localhost:8080/server
 
 # Caching settings
 cache: