mirror of
https://github.com/keycloak/keycloak.git
synced 2025-12-21 14:30:05 -06:00
Adjust introductory sentences
Closes #39008 Signed-off-by: AndyMunro <amunro@redhat.com>
This commit is contained in:
andymunro
@@ -2,7 +2,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Docker"
|
||||
summary="Get started with {project_name} on Docker">
|
||||
summary="Get started with {project_name} on Docker.">
|
||||
|
||||
:containerCommand: docker
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Kubernetes"
|
||||
summary="Get started with {project_name} on Kubernetes">
|
||||
summary="Get started with {project_name} on Kubernetes.">
|
||||
|
||||
:links-admin-console: {project_name} Admin Console
|
||||
:links-account-console: {project_name} Account Console
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="OpenShift"
|
||||
summary="Get started with {project_name} on OpenShift">
|
||||
summary="Get started with {project_name} on OpenShift.">
|
||||
|
||||
:links-admin-console: {project_name} Admin Console
|
||||
:links-account-console: {project_name} Account Console
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Podman"
|
||||
summary="Get started with {project_name} on Podman">
|
||||
summary="Get started with {project_name} on Podman.">
|
||||
|
||||
:containerCommand: podman
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Scaling"
|
||||
summary="Get started with {project_name} scaling and tuning">
|
||||
summary="Scale and tune your {project_name} installation.">
|
||||
|
||||
After starting {project_name}, consider adapting your instance to the required load using these scaling and tuning guidelines:
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="OpenJDK"
|
||||
summary="Get started with {project_name} on bare metal">
|
||||
summary="Get started with {project_name} on a physical or virtual server.">
|
||||
|
||||
:links-local: true
|
||||
:links-admin-console: http://localhost:8080/admin[{project_name} Admin Console]
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Building blocks multi-site deployments"
|
||||
summary="Overview of building blocks, alternatives and not considered options" >
|
||||
summary="Learn about building blocks and suggested setups for multi-site deployments." >
|
||||
|
||||
The following building blocks are needed to set up a multi-site deployment with synchronous replication.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Concepts for database connection pools"
|
||||
summary="Understand these concepts to avoid resource exhaustion and congestion"
|
||||
summary="Understand concepts for avoiding resource exhaustion and congestion."
|
||||
tileVisible="false" >
|
||||
|
||||
This section is intended when you want to understand considerations and best practices on how to configure database connection pools for {project_name}.
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Concepts for sizing CPU and memory resources"
|
||||
summary="Understand these concepts to avoid resource exhaustion and congestion"
|
||||
summary="Understand concepts for avoiding resource exhaustion and congestion."
|
||||
tileVisible="false" >
|
||||
|
||||
Use this as a starting point to size a product environment.
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Concepts for multi-site deployments"
|
||||
summary="Understanding a multi-site deployment with synchronous replication" >
|
||||
summary="Understand multi-site deployment with synchronous replication." >
|
||||
|
||||
This topic describes a highly available multi-site setup and the behavior to expect. It outlines the requirements of the high availability architecture and describes the benefits and tradeoffs.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Concepts for configuring thread pools"
|
||||
summary="Understand these concepts to avoid resource exhaustion and congestion"
|
||||
summary="Understand concepts for avoiding resource exhaustion and congestion."
|
||||
tileVisible="false" >
|
||||
|
||||
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Deploy AWS Aurora in multiple availability zones"
|
||||
summary="Building block for a database"
|
||||
title="Deploying AWS Aurora in multiple availability zones"
|
||||
summary="Deploy an AWS Aurora as the database building block in a multi-site deployment."
|
||||
tileVisible="false" >
|
||||
|
||||
This topic describes how to deploy an Aurora regional deployment of a PostgreSQL instance across multiple availability zones to tolerate one or more availability zone failures in a given AWS region.
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Deploy an AWS Lambda to disable a non-responding site"
|
||||
summary="Building block for load balancer resilience"
|
||||
title="Deploying an AWS Lambda to disable a non-responding site"
|
||||
summary="Deploy an AWS Lambda as part of the load-balancer building block in a multi-site deployment."
|
||||
tileVisible="false" >
|
||||
|
||||
This {section} explains how to resolve split-brain scenarios between two sites in a multi-site deployment.
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Deploy an AWS Global Accelerator load balancer"
|
||||
summary="Building block for a load balancer"
|
||||
title="Deploying an AWS Global Accelerator load balancer"
|
||||
summary="Deploy an AWS Global Accelerator as the load-balancer building block in a multi-site deployment."
|
||||
tileVisible="false" >
|
||||
|
||||
This topic describes the procedure required to deploy an AWS Global Accelerator to route traffic between multi-site {project_name} deployments.
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
<#import "/templates/profile.adoc" as profile>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Deploy {jdgserver_name} for HA with the {jdgserver_name} Operator"
|
||||
summary="Building block for an {jdgserver_name} deployment on Kubernetes"
|
||||
title="Deploying {jdgserver_name} for HA with the {jdgserver_name} Operator"
|
||||
summary="Deploy {jdgserver_name} for high availability in multi availability zones on Kubernetes."
|
||||
tileVisible="false"
|
||||
includedOptions="cache-remote-*">
|
||||
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Deploy {project_name} for HA with the {project_name} Operator"
|
||||
summary="Building block for a {project_name} deployment"
|
||||
title="Deploying {project_name} for HA with the Operator"
|
||||
summary="Deploy {project_name} for high availability with the {project_name} Operator as a building block."
|
||||
tileVisible="false" >
|
||||
|
||||
This guide describes advanced {project_name} configurations for Kubernetes which are load tested and will recover from single Pod failures.
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Health checks for multi-site deployments"
|
||||
summary="Validating the health of a multi-site deployment" >
|
||||
summary="Validate the health of a multi-site deployment." >
|
||||
|
||||
When running the <@links.ha id="introduction" /> in a Kubernetes environment,
|
||||
you should automate checks to see if everything is up and running as expected.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Multi-site deployments"
|
||||
summary="Connect multiple {project_name} deployments in different sites to increase the overall availability" >
|
||||
summary="Connect multiple {project_name} deployments in different sites to increase the overall availability." >
|
||||
|
||||
{project_name} supports deployments that consist of multiple {project_name} instances that connect to each other using its Infinispan caches; load balancers can distribute the load evenly across those instances.
|
||||
Those setups are intended for a transparent network on a single site.
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Take site offline"
|
||||
summary="This describes how to take a site offline so that it no longer processes client requests" >
|
||||
title="Taking a site offline"
|
||||
summary="Take a site offline so that it no longer processes client requests." >
|
||||
|
||||
== When to use this procedure
|
||||
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Bring site online"
|
||||
summary="This guide describes how to bring a site online so that it can process client requests." >
|
||||
title="Bringing a site online"
|
||||
summary="Bring a site online so that it can process client requests." >
|
||||
|
||||
== When to use this procedure
|
||||
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Synchronize Sites"
|
||||
summary="This describes the procedures required to synchronize an offline site with an online site" >
|
||||
title="Synchronizing sites"
|
||||
summary="Synchronize an offline site with an online site." >
|
||||
|
||||
include::partials/infinispan/infinispan-attributes.adoc[]
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Monitoring user activities with event metrics"
|
||||
summary="Event metrics provide admins an aggregated view of the different user activities in a {project_name} instance."
|
||||
summary="Event metrics provide an aggregated view of user activities in a {project_name} instance."
|
||||
includedOptions="metrics-enabled event-metrics-user-*">
|
||||
|
||||
For now, only metrics for user events are captured.
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Clustering metrics"
|
||||
summary="Learn about metrics monitoring communication between {project_name} nodes."
|
||||
summary="Use metrics to monitor communication between {project_name} nodes."
|
||||
tileVisible="false"
|
||||
>
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Database Metrics"
|
||||
summary="Learn about metrics describing {project_name}'s connection to the database"
|
||||
summary="Use metrics to describe {project_name}'s connection to the database."
|
||||
tileVisible="false"
|
||||
>
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Embedded Infinispan metrics for multi-site deployments"
|
||||
summary="Learn about metrics monitoring caching health"
|
||||
summary="Use metrics to monitor caching health."
|
||||
tileVisible="false"
|
||||
>
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Embedded Infinispan metrics for single site deployments"
|
||||
summary="Learn about metrics monitoring caching health and cluster replication"
|
||||
summary="Use metrics to monitor caching health and cluster replication."
|
||||
tileVisible="false"
|
||||
>
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="External {jdgserver_name} metrics"
|
||||
summary="Learn about metrics monitoring external {jdgserver_name} performance"
|
||||
summary="Use metrics to monitor external {jdgserver_name} performance."
|
||||
tileVisible="false"
|
||||
>
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="HTTP metrics"
|
||||
summary="Learn about metrics for monitoring the {project_name} HTTP requests processing"
|
||||
summary="Use metrics to monitor the {project_name} HTTP requests processing."
|
||||
tileVisible="false"
|
||||
includedOptions="http-metrics-histograms-enabled http-metrics-slos"
|
||||
>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="JVM metrics"
|
||||
summary="Learn about key JVM metrics for observing performance of {project_name}"
|
||||
summary="Use JVM metrics to observe performance of {project_name}."
|
||||
tileVisible="false"
|
||||
>
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Self-provided metrics"
|
||||
summary="Learn about key metrics that {project_name} provides"
|
||||
summary="Learn about the key metrics that {project_name} provides."
|
||||
tileVisible="false"
|
||||
>
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Troubleshooting using metrics"
|
||||
summary="Learn which metrics exist and how to use them for troubleshooting errors and performance issues."
|
||||
summary="Use metrics for troubleshooting errors and performance issues."
|
||||
>
|
||||
|
||||
For a running {project_name} deployment it is important to understand how the system performs and whether it meets your service level objectives (SLOs).
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Advanced configuration"
|
||||
summary="How to tune advanced aspects of the Keycloak CR">
|
||||
summary="Tune advanced aspects of the Keycloak CR.">
|
||||
|
||||
== Advanced configuration
|
||||
This {section} describes how to use Custom Resources (CRs) for advanced configuration of your {project_name} deployment.
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Basic {project_name} deployment"
|
||||
summary="How to install {project_name} using the Operator">
|
||||
summary="Install {project_name} using the Operator.">
|
||||
|
||||
== Performing a basic {project_name} deployment
|
||||
This {section} describes how to perform a basic {project_name} Deployment on
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Using custom {project_name} images"
|
||||
summary="How to customize and optimize the {project_name} Container">
|
||||
summary="Customize and optimize the {project_name} container.">
|
||||
|
||||
== {project_name} custom image with the Operator
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="{project_name} Operator Installation"
|
||||
summary="How to install the {project_name} Operator on Kubernetes and OpenShift">
|
||||
summary="Install the {project_name} Operator on Kubernetes and OpenShift.">
|
||||
|
||||
== Installing the {project_name} Operator
|
||||
This {section} describes how to install the {project_name} Operator in a Kubernetes or OpenShift cluster.
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="{project_name} Realm Import"
|
||||
summary="How to perform an automated {project_name} Realm Import using the operator">
|
||||
title="Automating a realm import"
|
||||
summary="Automate a realm import using the operator.">
|
||||
|
||||
== Importing a {project_name} Realm
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Avoiding downtime with rolling updates"
|
||||
summary="Avoid downtimes when changing themes, providers or configurations in optimized images.">
|
||||
summary="Avoid downtime when changing themes, providers, or configurations in optimized images.">
|
||||
|
||||
By default, the {project_name} Operator will perform rolling updates on configuration changes without downtime, and recreate updates with downtime when the image name or tag changes.
|
||||
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Client registration CLI"
|
||||
title="Automating client registration with the CLI"
|
||||
priority=110
|
||||
summary="Automating Client Registration with the CLI">
|
||||
summary="Use the CLI to automate client registration.">
|
||||
|
||||
The Client Registration CLI is a command-line interface (CLI) tool for application developers to configure new clients in a self-service manner when integrating with {project_name}. It is specifically designed to interact with {project_name} Client Registration REST endpoints.
|
||||
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Client registration service"
|
||||
title="Using the client registration service"
|
||||
priority=100
|
||||
summary="Using the client registration service">
|
||||
summary="Use the client registration service.">
|
||||
|
||||
In order for an application or service to utilize {project_name} it has to register a client in {project_name}.
|
||||
An admin can do this through the admin console (or admin REST endpoints), but clients can also register themselves through the {project_name} client registration service.
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Docker registry"
|
||||
title="Configuring a Docker registry"
|
||||
priority=90
|
||||
summary="Configuring a Docker registry to use {project_name}">
|
||||
summary="Configure a Docker registry to use {project_name}.">
|
||||
|
||||
NOTE: Docker authentication is disabled by default. To enable see the https://www.keycloak.org/server/features[Enabling and disabling features] {section}.
|
||||
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="mod_auth_mellon Apache Module"
|
||||
title="Configuring the mod_auth_mellon Apache Module"
|
||||
priority=80
|
||||
summary="Configuring the mod_auth_mellon Apache module with {project_name}">
|
||||
summary="Configure the mod_auth_mellon Apache module with {project_name}.">
|
||||
|
||||
The https://github.com/latchset/mod_auth_mellon[mod_auth_mellon] is an authentication module for Apache. If your language/environment supports using Apache HTTPD as a proxy, then you can use mod_auth_mellon to secure your web application with SAML. For more details on this module see the _mod_auth_mellon_ GitHub repo.
|
||||
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="mod_auth_openidc Apache HTTPD Module"
|
||||
title="Configuring the mod_auth_openidc Apache HTTPD Module"
|
||||
priority=50
|
||||
summary="Configuring the mod_auth_openidc Apache module with {project_name}">
|
||||
summary="Configure the mod_auth_openidc Apache module with {project_name}.">
|
||||
|
||||
|
||||
WARNING: {project_name} does not provide any official support to mod_auth_openidc. The instructions below are best-effort and may not be up-to-date.
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Secure applications and services with OpenID Connect"
|
||||
title="Securing applications and services with OpenID Connect"
|
||||
priority=20
|
||||
summary="Using OpenID Connect with Keycloak to secure applications and services">
|
||||
summary="Use OpenID Connect with {project_name} to secure applications and services.">
|
||||
|
||||
include::partials/oidc/available-endpoints.adoc[]
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
<@tmpl.guide
|
||||
title="Planning for securing applications and services"
|
||||
priority=10
|
||||
summary="Introduction and basic concepts for securing applications">
|
||||
summary="Understand basic concepts for securing applications.">
|
||||
|
||||
As an OAuth2, OpenID Connect and SAML compliant server, {project_name} can secure any application and service as long
|
||||
as the technology stack they are using supports any of these protocols. For more details about the security protocols
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
title="{project_name} SAML Galleon feature pack detailed configuration"
|
||||
priority=70
|
||||
tileVisible="false"
|
||||
summary="Detailed list of elements for the `keycloak-saml.xml` configuration file">
|
||||
summary="Review this detailed list of elements for the `keycloak-saml.xml` configuration file.">
|
||||
|
||||
This {section} contains the detailed list of elements for the `keycloak-saml.xml` configuration file used by the {project_name} SAML Galleon feature pack.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
<@tmpl.guide
|
||||
title="{project_name} SAML Galleon feature pack for WildFly and EAP"
|
||||
priority=60
|
||||
summary="Using {project_name} SAML Galleon feature pack to secure applications in WildFly and EAP">
|
||||
summary="Using {project_name} SAML Galleon feature pack to secure applications in WildFly and EAP.">
|
||||
|
||||
The SAML adapter is distributed as a Galleon feature pack for wildfly 29 or newer. More details about the subject
|
||||
in the https://docs.wildfly.org/32/WildFly_Elytron_Security.html#Keycloak_SAML_Integration[WildFly documentation].
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Using token exchange"
|
||||
title="Configuring and using token exchange"
|
||||
priority=120
|
||||
summary="Configuring and using Token exchange with {project_name}">
|
||||
summary="Configure and use token exchange for {project_name}.">
|
||||
|
||||
Token exchange is the process that allows a client application to exchange one token for another token. In {project_name}, two features implement token exchange:
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@template.guide
|
||||
title="All configuration"
|
||||
summary="Complete list of all build options and configuration for {project_name}">
|
||||
summary="Review build options and configuration for {project_name}.">
|
||||
|
||||
<#list ctx.options.categories as category>
|
||||
<#assign categoryOptions=ctx.options.getValues(category)>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@template.guide
|
||||
title="All provider configuration"
|
||||
summary="Complete list of all the available provider configuration options">
|
||||
summary="Review provider configuration options.">
|
||||
|
||||
<#list ctx.options.getProviderOptions() as spi, providers>
|
||||
== ${spi}
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Admin bootstrap and recovery"
|
||||
summary="Learn how to bootstrap and recover admin account.">
|
||||
title="Bootstrapping and recovering an admin account"
|
||||
summary="Bootstrap {project_name} and recover access by creating a temporary admin account.">
|
||||
|
||||
== A temporary admin account
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Configuring distributed caches"
|
||||
summary="Understand how to configure the caching layer">
|
||||
summary="Configure the caching layer to cluster multiple {project_name} instances and to increase performance.">
|
||||
|
||||
{project_name} is designed for high availability and multi-node clustered setups.
|
||||
The current distributed cache implementation is built on top of https://infinispan.org[Infinispan], a high-performance, distributable in-memory data grid.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Configuring {project_name} for production"
|
||||
summary="Learn how to make {project_name} ready for production."
|
||||
summary="Prepare {project_name} for use in production."
|
||||
includedOptions="">
|
||||
|
||||
A {project_name} production environment provides secure authentication and authorization for deployments that range from on-premise deployments that support a few thousand users to deployments that serve millions of users.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Configuring providers"
|
||||
summary="Understand how to configure providers">
|
||||
summary="Configure providers for {project_name}.">
|
||||
|
||||
The server is built with extensibility in mind and for that it provides a number of Service Provider Interfaces or SPIs, each one
|
||||
responsible for providing a specific capability to the server. In this {section}, you are going to understand the core concepts around
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Configuring {project_name}"
|
||||
summary="Understand how to configure and start {project_name}">
|
||||
summary="Configure and start {project_name}.">
|
||||
|
||||
This {section} explains the configuration methods for {project_name} and how to start and apply the preferred configuration. It includes configuration guidelines for optimizing {project_name} for faster startup and low memory footprint.
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Running {project_name} in a container"
|
||||
summary="Learn how to run {project_name} from a container image"
|
||||
summary="Run {project_name} from a container image."
|
||||
includedOptions="db db-url db-username db-password features hostname https-key-store-file https-key-store-password health-enabled metrics-enabled">
|
||||
|
||||
This {section} describes how to optimize and run the {project_name} container image to provide the best experience running a container.
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Configuring the database"
|
||||
summary="An overview about how to configure relational databases"
|
||||
summary="Configure a relational database for {project_name} to store user, client, and realm data."
|
||||
includedOptions="db db-* transaction-xa-enabled">
|
||||
|
||||
This {section} explains how to configure the {project_name} server to store data in a relational database.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Directory Structure"
|
||||
summary="Understand the purpose of the directories under the installation root"
|
||||
summary="Understand the purpose of the directories under the installation root."
|
||||
includedOptions="">
|
||||
|
||||
== Installation Locations
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Configuring TLS"
|
||||
summary="Learn how to configure {project_name}'s https certificates for ingoing and outgoing requests.">
|
||||
summary="Configure {project_name}'s https certificates for ingoing and outgoing requests.">
|
||||
|
||||
Transport Layer Security (short: TLS) is crucial to exchange data over a secured channel.
|
||||
For production environments, you should never expose {project_name} endpoints through HTTP, as sensitive data is at the core of what {project_name} exchanges with other applications.
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Enabling and disabling features"
|
||||
summary="Understand how to configure {project_name} to use optional features"
|
||||
summary="Configure {project_name} to use optional features."
|
||||
includedOptions="features features-*">
|
||||
|
||||
{project_name} has packed some functionality in features, including some disabled features, such as Technology Preview and deprecated features. Other features are enabled by default, but you can disable them if they do not apply to your use of {project_name}.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="FIPS 140-2 support"
|
||||
summary="How to configure {project_name} server for FIPS compliance"
|
||||
summary="Configure {project_name} server for FIPS compliance."
|
||||
includedOptions="">
|
||||
|
||||
The Federal Information Processing Standard Publication 140-2, (FIPS 140-2), is a U.S. government computer security standard used to approve cryptographic modules. {project_name} supports running in FIPS 140-2 compliant mode. In this case, {project_name} will use only FIPS approved cryptography algorithms for its functionality.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Configuring the hostname (v2)"
|
||||
summary="Learn how to configure the frontend and backchannel endpoints exposed by {project_name}."
|
||||
summary="Configure the frontend and backchannel endpoints exposed by {project_name}."
|
||||
includedOptions="hostname hostname-* proxy"
|
||||
deniedCategories="hostname_v1">
|
||||
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Importing and Exporting Realms"
|
||||
summary="An overview about how to import and export realms">
|
||||
title="Importing and exporting realms"
|
||||
summary="Import and export realms as JSON files.">
|
||||
|
||||
In this {section}, you are going to understand the different approaches for importing and exporting realms using JSON files.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Configuring trusted certificates"
|
||||
summary="How to configure the {project_name} Truststore to communicate through TLS."
|
||||
summary="Configure the {project_name} Truststore to communicate through TLS."
|
||||
includedOptions="truststore-paths tls-hostname-verifier">
|
||||
|
||||
When {project_name} communicates with external services or has an incoming connection through TLS, it has to validate the remote certificate in order to ensure it is connecting to a trusted server. This is necessary in order to prevent man-in-the-middle attacks.
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Configuring logging"
|
||||
summary="Learn how to configure Logging">
|
||||
summary="Configure logging for {project_name}.">
|
||||
|
||||
{project_name} uses the JBoss Logging framework.
|
||||
The following is a high-level overview for the available log handlers with the common parent log handler `root`:
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Configuring the Management Interface"
|
||||
summary="Learn how to configure {project_name}'s management interface for endpoints like metrics and health checks."
|
||||
summary="Configure {project_name}'s management interface for endpoints such as metrics and health checks."
|
||||
includedOptions="http-management-* https-management-* legacy-observability-interface">
|
||||
|
||||
The management interface allows accessing management endpoints via a different HTTP server than the primary one.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Configuring trusted certificates for mTLS"
|
||||
summary="Learn how to configure Mutual TLS to verify clients that are connecting to {project_name}."
|
||||
summary="Configure Mutual TLS to verify clients that are connecting to {project_name}."
|
||||
includedOptions="https-trust-store-* https-client-auth https-management-client-auth">
|
||||
|
||||
In order to properly validate client certificates and enable certain authentication methods like two-way TLS or mTLS, you can set
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Configuring outgoing HTTP requests"
|
||||
summary="How to configure the client used for outgoing HTTP requests."
|
||||
summary="Configure the client used for outgoing HTTP requests."
|
||||
includedOptions="truststore-*">
|
||||
|
||||
{project_name} often needs to make requests to the applications and services that it secures. {project_name} manages these outgoing connections using an HTTP client. This {section} shows how to configure the client, connection pool, proxy environment settings, timeouts, and more.
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Using a reverse proxy"
|
||||
summary="Learn how to configure {project_name} together with a reverse proxy, api gateway, or load balancer."
|
||||
title="Configuring a reverse proxy"
|
||||
summary="Configure {project_name} with a reverse proxy, API gateway, or load balancer."
|
||||
includedOptions="proxy-* hostname hostname-admin http-relative-path">
|
||||
|
||||
Distributed environments frequently require the use of a reverse proxy. {project_name} offers several options to securely integrate with such environments.
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<@tmpl.guide
|
||||
title="Using a vault"
|
||||
summary="Learn how to use and configure a vault in {project_name}"
|
||||
summary="Configure and use a vault in {project_name}."
|
||||
includedOptions="vault vault-*">
|
||||
|
||||
{project_name} provides two out-of-the-box implementations of the Vault SPI: a plain-text file-based vault and Java KeyStore-based vault.
|
||||
|
||||
Reference in New Issue
Block a user