Deploying to main from @ 870569161c0a5c302511f7910e8dd2e0056137e9 🚀

keycloak · Feb 5, 2025 · 90516e1 · 90516e1
1 parent c1d166f
commit 90516e1
Show file tree

Hide file tree

Showing 4 changed files with 418 additions and 92 deletions.
diff --git a/nightly/server/all-config.html b/nightly/server/all-config.html
@@ -2077,6 +2077,26 @@ <h2 id="category-logging">Logging</h2>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
+<p><span class="options-key"><code>log-console-json-format</code></span></p>
+</div>
+<div class="paragraph">
+<p><span class="options-description">Set the format of the produced JSON.</span></p>
+</div>
+<div id="option-extended-log-console-json-format" class="openblock options-extended">
+<div class="content">
+<div class="paragraph">
+<p><strong>CLI:</strong> <code>--log-console-json-format</code><br>
+<strong>Env:</strong> <code>KC_LOG_CONSOLE_JSON_FORMAT</code></p>
+</div>
+</div>
+</div>
+<div class="paragraph">
+<p>Available only when Console log handler is activated and output is set to 'json'</p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>default</code> (default), <code>ecs</code></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
 <p><span class="options-key"><code>log-console-level</code></span></p>
 </div>
 <div class="paragraph">
@@ -2183,6 +2203,26 @@ <h2 id="category-logging">Logging</h2>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
+<p><span class="options-key"><code>log-file-json-format</code></span></p>
+</div>
+<div class="paragraph">
+<p><span class="options-description">Set the format of the produced JSON.</span></p>
+</div>
+<div id="option-extended-log-file-json-format" class="openblock options-extended">
+<div class="content">
+<div class="paragraph">
+<p><strong>CLI:</strong> <code>--log-file-json-format</code><br>
+<strong>Env:</strong> <code>KC_LOG_FILE_JSON_FORMAT</code></p>
+</div>
+</div>
+</div>
+<div class="paragraph">
+<p>Available only when File log handler is activated and output is set to 'json'</p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>default</code> (default), <code>ecs</code></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
 <p><span class="options-key"><code>log-file-level</code></span></p>
 </div>
 <div class="paragraph">
@@ -2349,6 +2389,26 @@ <h2 id="category-logging">Logging</h2>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
+<p><span class="options-key"><code>log-syslog-json-format</code></span></p>
+</div>
+<div class="paragraph">
+<p><span class="options-description">Set the format of the produced JSON.</span></p>
+</div>
+<div id="option-extended-log-syslog-json-format" class="openblock options-extended">
+<div class="content">
+<div class="paragraph">
+<p><strong>CLI:</strong> <code>--log-syslog-json-format</code><br>
+<strong>Env:</strong> <code>KC_LOG_SYSLOG_JSON_FORMAT</code></p>
+</div>
+</div>
+</div>
+<div class="paragraph">
+<p>Available only when Syslog is activated and output is set to 'json'</p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>default</code> (default), <code>ecs</code></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
 <p><span class="options-key"><code>log-syslog-level</code></span></p>
 </div>
 <div class="paragraph">

diff --git a/nightly/server/caching.html b/nightly/server/caching.html
@@ -710,15 +710,15 @@ <h2 id="_network_ports">Network Ports</h2>
 <tbody>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>7800</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>jgroups.bind.address</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>jgroups.bind.port</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Unicast data transmission.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>57800</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>jgroups.fd.port-offset</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Failure detection by protocol <code>FD_SOCK2</code>.
 It listens to the abrupt closing of a socket to suspect a Keycloak server failure.
-The <code>jgroups.fd.port-offset</code> property defines the offset from the <code>jgroups.bind.address</code>.</p></td>
+The <code>jgroups.fd.port-offset</code> property defines the offset from the <code>jgroups.bind.port</code>.</p></td>
 </tr>
 </tbody>
 </table>
@@ -771,6 +771,52 @@ <h2 id="network-bind-address">Network bind address</h2>
 </div>
 </div>
 <div class="sect1">
+<h2 id="_running_instances_on_different_networks">Running instances on different networks</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>If you run Keycloak instances on different networks, for example behind firewalls or in containers, the different instances will not be able to reach each other by their local IP address.
+In such a case, set up a port forwarding rule (sometimes called &#8220;virtual server&#8221;) to their local IP address.</p>
+</div>
+<div class="paragraph">
+<p>When using port forwarding, use the following properties so each node correctly advertises its external address to the other nodes:</p>
+</div>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Property</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>jgroups.external_port</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Port that other instances in the Keycloak cluster should use to contact this node.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>jgroups.external_addr</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">IP address that other instances in the Keycloak should use to contact this node.</p></td>
+</tr>
+</tbody>
+</table>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+Use <code>-D&lt;property&gt;=&lt;value&gt;</code> set this in your <code>JAVA_OPTS_APPEND</code> environment variable or in your CLI command.
+</td>
+</tr>
+</table>
+</div>
+</div>
+</div>
+<div class="sect1">
 <h2 id="_exposing_metrics_from_caches">Exposing metrics from caches</h2>
 <div class="sectionbody">
 <div class="paragraph">
@@ -847,6 +893,66 @@ <h2 id="_relevant_options">Relevant options</h2>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
+<p><span class="options-key"><code>cache-metrics-histograms-enabled</code></span></p>
+</div>
+<div class="paragraph">
+<p><span class="options-description">Enable histograms for metrics for the embedded caches.</span></p>
+</div>
+<div class="openblock options-extended">
+<div class="content">
+<div class="paragraph">
+<p><strong>CLI:</strong> <code>--cache-metrics-histograms-enabled</code><br>
+<strong>Env:</strong> <code>KC_CACHE_METRICS_HISTOGRAMS_ENABLED</code></p>
+</div>
+</div>
+</div>
+<div class="paragraph">
+<p>Available only when metrics are enabled</p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code>, <code>false</code> (default)</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
+<p><span class="options-key"><code>cache-stack</code></span></p>
+</div>
+<div class="paragraph">
+<p><span class="options-description">Define the default stack to use for cluster communication and node discovery.</span></p>
+</div>
+<div class="openblock options-extended">
+<div class="content">
+<div class="paragraph">
+<p><strong>CLI:</strong> <code>--cache-stack</code><br>
+<strong>Env:</strong> <code>KC_CACHE_STACK</code></p>
+</div>
+</div>
+</div>
+<div class="paragraph">
+<p>Available only when 'cache' type is set to 'ispn'</p>
+</div>
+<div class="paragraph">
+<p>Use 'jdbc-ping' instead
+<strong>Deprecated values: <code>azure</code>, <code>ec2</code>, <code>google</code>, <code>tcp</code>, <code>udp</code>, <code>jdbc-ping-udp</code></strong></p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>jdbc-ping</code> (default), <code>kubernetes</code>, <code>jdbc-ping-udp</code> (deprecated), <code>tcp</code> (deprecated), <code>udp</code> (deprecated), <code>ec2</code> (deprecated), <code>azure</code> (deprecated), <code>google</code> (deprecated), or any</p></td>
+</tr>
+</tbody>
+</table>
+<div class="sect2">
+<h3 id="_embedded_cache">Embedded Cache</h3>
+<table class="tableblock frame-all grid-all stretch options">
+<colgroup>
+<col style="width: 75%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top"></th>
+<th class="tableblock halign-left valign-top">Value</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
 <p><span class="options-key"><code>cache-embedded-authorization-max-count</code></span></p>
 </div>
 <div class="paragraph">
@@ -1101,26 +1207,23 @@ <h2 id="_relevant_options">Relevant options</h2>
 </div></div></td>
 <td class="tableblock halign-left valign-top"></td>
 </tr>
-<tr>
-<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
-<p><span class="options-key"><code>cache-metrics-histograms-enabled</code></span></p>
-</div>
-<div class="paragraph">
-<p><span class="options-description">Enable histograms for metrics for the embedded caches.</span></p>
-</div>
-<div class="openblock options-extended">
-<div class="content">
-<div class="paragraph">
-<p><strong>CLI:</strong> <code>--cache-metrics-histograms-enabled</code><br>
-<strong>Env:</strong> <code>KC_CACHE_METRICS_HISTOGRAMS_ENABLED</code></p>
-</div>
-</div>
+</tbody>
+</table>
 </div>
-<div class="paragraph">
-<p>Available only when metrics are enabled</p>
-</div></div></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code>, <code>false</code> (default)</p></td>
+<div class="sect2">
+<h3 id="_remote_cache">Remote Cache</h3>
+<table class="tableblock frame-all grid-all stretch options">
+<colgroup>
+<col style="width: 75%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top"></th>
+<th class="tableblock halign-left valign-top">Value</th>
 </tr>
+</thead>
+<tbody>
 <tr>
 <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
 <p><span class="options-key"><code>cache-remote-host</code></span></p>
@@ -1230,33 +1333,10 @@ <h2 id="_relevant_options">Relevant options</h2>
 </div></div></td>
 <td class="tableblock halign-left valign-top"></td>
 </tr>
-<tr>
-<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
-<p><span class="options-key"><code>cache-stack</code></span></p>
-</div>
-<div class="paragraph">
-<p><span class="options-description">Define the default stack to use for cluster communication and node discovery.</span></p>
-</div>
-<div class="openblock options-extended">
-<div class="content">
-<div class="paragraph">
-<p><strong>CLI:</strong> <code>--cache-stack</code><br>
-<strong>Env:</strong> <code>KC_CACHE_STACK</code></p>
-</div>
-</div>
-</div>
-<div class="paragraph">
-<p>Available only when 'cache' type is set to 'ispn'</p>
-</div>
-<div class="paragraph">
-<p>Use 'jdbc-ping' instead
-<strong>Deprecated values: <code>azure</code>, <code>ec2</code>, <code>google</code>, <code>tcp</code>, <code>udp</code>, <code>jdbc-ping-udp</code></strong></p>
-</div></div></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>jdbc-ping</code> (default), <code>kubernetes</code>, <code>jdbc-ping-udp</code> (deprecated), <code>tcp</code> (deprecated), <code>udp</code> (deprecated), <code>ec2</code> (deprecated), <code>azure</code> (deprecated), <code>google</code> (deprecated), or any</p></td>
-</tr>
 </tbody>
 </table>
 </div>
+</div>
 </div>            </div>
         </div>
 

diff --git a/nightly/server/enabletls.html b/nightly/server/enabletls.html
@@ -405,6 +405,22 @@ <h2 id="_relevant_options">Relevant options</h2>
 </div></div></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><span class="options-default"><code>[TLSv1.3,TLSv1.2]</code></span> (default)</p></td>
 </tr>
+</tbody>
+</table>
+<div class="sect2">
+<h3 id="_management_server">Management server</h3>
+<table class="tableblock frame-all grid-all stretch options">
+<colgroup>
+<col style="width: 75%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top"></th>
+<th class="tableblock halign-left valign-top">Value</th>
+</tr>
+</thead>
+<tbody>
 <tr>
 <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
 <p><span class="options-key"><code>https-management-certificate-file</code></span></p>
@@ -488,6 +504,7 @@ <h2 id="_relevant_options">Relevant options</h2>
 </tbody>
 </table>
 </div>
+</div>
 </div>            </div>
         </div>