diff options
Diffstat (limited to 'nixos/modules/services/web-apps/keycloak.nix')
| -rw-r--r-- | nixos/modules/services/web-apps/keycloak.nix | 39 |
1 files changed, 16 insertions, 23 deletions
diff --git a/nixos/modules/services/web-apps/keycloak.nix b/nixos/modules/services/web-apps/keycloak.nix index de76babbaedd9..c1091bc09a06f 100644 --- a/nixos/modules/services/web-apps/keycloak.nix +++ b/nixos/modules/services/web-apps/keycloak.nix @@ -210,14 +210,13 @@ in name = mkOption { type = str; default = "keycloak"; - description = '' + description = lib.mdDoc '' Database name to use when connecting to an external or manually provisioned database; has no effect when a local database is automatically provisioned. - To use this with a local database, set <xref - linkend="opt-services.keycloak.database.createLocally" /> to - <literal>false</literal> and create the database and user + To use this with a local database, set [](#opt-services.keycloak.database.createLocally) to + `false` and create the database and user manually. ''; }; @@ -225,14 +224,13 @@ in username = mkOption { type = str; default = "keycloak"; - description = '' + description = lib.mdDoc '' Username to use when connecting to an external or manually provisioned database; has no effect when a local database is automatically provisioned. - To use this with a local database, set <xref - linkend="opt-services.keycloak.database.createLocally" /> to - <literal>false</literal> and create the database and user + To use this with a local database, set [](#opt-services.keycloak.database.createLocally) to + `false` and create the database and user manually. ''; }; @@ -329,10 +327,8 @@ in want to set this to <literal>/auth</literal> to keep compatibility with your clients. - See <link - xlink:href="https://www.keycloak.org/migration/migrating-to-quarkus" - /> for more information on migrating from Wildfly - to Quarkus. + See <link xlink:href="https://www.keycloak.org/migration/migrating-to-quarkus"/> + for more information on migrating from Wildfly to Quarkus. </para> </note> ''; @@ -404,9 +400,7 @@ in </varlistentry> </variablelist> - See <link - xlink:href="https://www.keycloak.org/server/reverseproxy" - /> for more information. + See <link xlink:href="https://www.keycloak.org/server/reverseproxy"/> for more information. ''; }; }; @@ -421,22 +415,21 @@ in } ''; - description = '' + description = lib.mdDoc '' Configuration options corresponding to parameters set in - <filename>conf/keycloak.conf</filename>. + {file}`conf/keycloak.conf`. - Most available options are documented at <link - xlink:href="https://www.keycloak.org/server/all-config" />. + Most available options are documented at <https://www.keycloak.org/server/all-config>. Options containing secret data should be set to an attribute - set containing the attribute <literal>_secret</literal> - a + set containing the attribute `_secret` - a string pointing to a file containing the value the option should be set to. See the example to get a better picture of this: in the resulting - <filename>conf/keycloak.conf</filename> file, the - <literal>https-key-store-password</literal> key will be set + {file}`conf/keycloak.conf` file, the + `https-key-store-password` key will be set to the contents of the - <filename>/run/keys/store_password</filename> file. + {file}`/run/keys/store_password` file. ''; }; }; |