2021-11-18 12:40:02 +00:00
|
|
|
<#import "/templates/guide.adoc" as tmpl>
|
|
|
|
|
<#import "/templates/kc.adoc" as kc>
|
|
|
|
|
<#import "/templates/options.adoc" as opts>
|
|
|
|
|
|
|
|
|
|
<@tmpl.guide
|
|
|
|
|
title="Relational database setup"
|
|
|
|
|
summary="Understand how to configure different relational databases for Keycloak"
|
2022-01-14 12:39:22 +00:00
|
|
|
priority=10
|
2021-11-18 12:40:02 +00:00
|
|
|
includedOptions="db db.* hostname">
|
|
|
|
|
|
|
|
|
|
First step is to decide which database vendor you are going to use. Keycloak has support for a number of different vendors.
|
|
|
|
|
|
|
|
|
|
Selecting the database vendor is done at build-time rather than at runtime. To select the database vendor run:
|
|
|
|
|
|
|
|
|
|
<@kc.build parameters="--db <vendor>"/>
|
|
|
|
|
|
|
|
|
|
Valid options for database vendors include:
|
|
|
|
|
|
|
|
|
|
<@opts.expectedValues option="db"/>
|
|
|
|
|
|
|
|
|
|
Once configured you can easily connect to the database with:
|
|
|
|
|
|
|
|
|
|
<@kc.start parameters="--db-host <hostname> --db-schema <schema> --db-user <username> --db-password <password>"/>
|
|
|
|
|
</@tmpl.guide>
|
