You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.
You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@DGuhr@stianst Here is what I have in mind as the very first guides we should be looking at:
Configuring Keycloak
Main configuration aspects of the server (e.g.: build/runtime configuration, how to check if a configuration is related to build or runtime)
Why building a server image is important for optimal startup and how to do it
Briefly explain the format of configuration options: CLI, ENV, properties
Configuration file: keycloak.properties
Property replacement
Configuration Profiles
Managing providers
Explain how to deploy custom providers
Explain how to configure providers
Configuring Keycloak for Optimal Runtime
More detailed guide about how to optimize Keycloak to run faster and with lower memory footprint
Examples on how to extend docker image
Examples on how to do it in bare metal
Configuring a Database
Explain how to configure a database
Explain how to externalize database credentials using a vault (quarkus-based approach)
Enabling TLS
Explain how to enable TLS
Configuring Clustering
Explain the main concepts around clustering (e.g.: config file, cache modes, cache stacks)
Clustering on Kubernetes
Exposing Keycloak Endpoints
Explain how to configure Keycloak hostname provider
Enabling/Disabling Features
Explain how to enable/disable features
Configuring a Vault
How to use mounted secrets
How to use Hashicorp
Deploying in Production
Explain the necessary configuration and steps about how to deploy in production
The idea is to explain the steps and probably have some references to other guides like database, proxy, clustering, etc. And also references to our official doc?
Starting in Development Mode
Explain the core concepts behind dev mode
Explain how to debug the server
Running a container
Explain how to run Keycloak as a container
Explain how to create custom container images
Perhaps some of the items above could be split into different guides.
Reacted by Markus Till, Dominik Guhr, Tobias Wolf and Eugene Bykov
Is the order artificial? If not I would like to kindly ask to put the dev experience tasks (14.) earlier so the community could easier start to contribute. Also its handy in case of SPI development to know how those can be tested in that context
Is the order artificial? If not I would like to kindly ask to put the dev experience tasks (14.) earlier so the community could easier start to contribute. Also its handy in case of SPI development to know how those can be tested in that context
Yeah, it is artificial. We should try to deliver all of them at once.
For the clustering part, besides you wrote : Explain the main concepts around clustering (e.g.: config file, cache modes, cache stacks), I would like to emphasis on the infinispan remote store configuration.
Activity
pedroigor commentedon Jan 5, 2022
@DGuhr @stianst Here is what I have in mind as the very first guides we should be looking at:
Perhaps some of the items above could be split into different guides.
bs-matil commentedon Jan 5, 2022
Is the order artificial? If not I would like to kindly ask to put the dev experience tasks (14.) earlier so the community could easier start to contribute. Also its handy in case of SPI development to know how those can be tested in that context
andreaTP commentedon Jan 6, 2022
Should we add a section like "Migration from Wildfly distribution"?
Mentioning e.g. bulk import/export, configuration changes etc.
pedroigor commentedon Jan 6, 2022
Yeah, it is artificial. We should try to deliver all of them at once.
pedroigor commentedon Jan 6, 2022
@andreaTP We have this keycloak/keycloak-web#274.
DGuhr commentedon Jan 7, 2022
See #9432 for a first draft PR for Point 1 of your list
olivierboudet commentedon Jan 13, 2022
Hello,
For the clustering part, besides you wrote :
Explain the main concepts around clustering (e.g.: config file, cache modes, cache stacks), I would like to emphasis on the infinispan remote store configuration.[-]Documentation[/-][+]Documentation for Quarkus distribution[/+]