diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/web-apps/keycloak.nix')
| -rw-r--r-- | nixpkgs/nixos/modules/services/web-apps/keycloak.nix | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/nixpkgs/nixos/modules/services/web-apps/keycloak.nix b/nixpkgs/nixos/modules/services/web-apps/keycloak.nix index 6d2948913b19..cf1282b3d4cf 100644 --- a/nixpkgs/nixos/modules/services/web-apps/keycloak.nix +++ b/nixpkgs/nixos/modules/services/web-apps/keycloak.nix @@ -99,7 +99,7 @@ in type = bool; default = false; example = true; - description = lib.mdDoc '' + description = '' Whether to enable the Keycloak identity and access management server. ''; @@ -110,7 +110,7 @@ in default = null; example = "/run/keys/ssl_cert"; apply = assertStringPath "sslCertificate"; - description = lib.mdDoc '' + description = '' The path to a PEM formatted certificate to use for TLS/SSL connections. ''; @@ -121,7 +121,7 @@ in default = null; example = "/run/keys/ssl_key"; apply = assertStringPath "sslCertificateKey"; - description = lib.mdDoc '' + description = '' The path to a PEM formatted private key to use for TLS/SSL connections. ''; @@ -130,7 +130,7 @@ in plugins = lib.mkOption { type = lib.types.listOf lib.types.path; default = [ ]; - description = lib.mdDoc '' + description = '' Keycloak plugin jar, ear files or derivations containing them. Packaged plugins are available through `pkgs.keycloak.plugins`. @@ -142,7 +142,7 @@ in type = enum [ "mysql" "mariadb" "postgresql" ]; default = "postgresql"; example = "mariadb"; - description = lib.mdDoc '' + description = '' The type of database Keycloak should connect to. ''; }; @@ -150,7 +150,7 @@ in host = mkOption { type = str; default = "localhost"; - description = lib.mdDoc '' + description = '' Hostname of the database to connect to. ''; }; @@ -167,7 +167,7 @@ in type = port; default = dbPorts.${cfg.database.type}; defaultText = literalMD "default port of selected database"; - description = lib.mdDoc '' + description = '' Port of the database to connect to. ''; }; @@ -176,7 +176,7 @@ in type = bool; default = cfg.database.host != "localhost"; defaultText = literalExpression ''config.${opt.database.host} != "localhost"''; - description = lib.mdDoc '' + description = '' Whether the database connection should be secured by SSL / TLS. ''; @@ -185,7 +185,7 @@ in caCert = mkOption { type = nullOr path; default = null; - description = lib.mdDoc '' + description = '' The SSL / TLS CA certificate that verifies the identity of the database server. @@ -200,7 +200,7 @@ in createLocally = mkOption { type = bool; default = true; - description = lib.mdDoc '' + description = '' Whether a database should be automatically created on the local host. Set this to false if you plan on provisioning a local database yourself. This has no effect if @@ -211,7 +211,7 @@ in name = mkOption { type = str; default = "keycloak"; - description = lib.mdDoc '' + description = '' Database name to use when connecting to an external or manually provisioned database; has no effect when a local database is automatically provisioned. @@ -225,7 +225,7 @@ in username = mkOption { type = str; default = "keycloak"; - description = lib.mdDoc '' + description = '' Username to use when connecting to an external or manually provisioned database; has no effect when a local database is automatically provisioned. @@ -240,7 +240,7 @@ in type = path; example = "/run/keys/db_password"; apply = assertStringPath "passwordFile"; - description = lib.mdDoc '' + description = '' The path to a file containing the database password. ''; }; @@ -251,7 +251,7 @@ in initialAdminPassword = mkOption { type = str; default = "changeme"; - description = lib.mdDoc '' + description = '' Initial password set for the `admin` user. The password is not stored safely and should be changed immediately in the admin panel. @@ -261,7 +261,7 @@ in themes = mkOption { type = attrsOf package; default = { }; - description = lib.mdDoc '' + description = '' Additional theme packages for Keycloak. Each theme is linked into subdirectory with a corresponding attribute name. @@ -281,7 +281,7 @@ in type = str; default = "0.0.0.0"; example = "127.0.0.1"; - description = lib.mdDoc '' + description = '' On which address Keycloak should accept new connections. ''; }; @@ -290,7 +290,7 @@ in type = port; default = 80; example = 8080; - description = lib.mdDoc '' + description = '' On which port Keycloak should listen for new HTTP connections. ''; }; @@ -299,7 +299,7 @@ in type = port; default = 443; example = 8443; - description = lib.mdDoc '' + description = '' On which port Keycloak should listen for new HTTPS connections. ''; }; @@ -309,7 +309,7 @@ in default = "/"; example = "/auth"; apply = x: if !(hasPrefix "/") x then "/" + x else x; - description = lib.mdDoc '' + description = '' The path relative to `/` for serving resources. @@ -331,7 +331,7 @@ in type = nullOr str; default = null; example = "keycloak.example.com"; - description = lib.mdDoc '' + description = '' The hostname part of the public URL used as base for all frontend requests. @@ -344,7 +344,7 @@ in type = bool; default = false; example = true; - description = lib.mdDoc '' + description = '' Whether Keycloak should force all requests to go through the frontend URL. By default, Keycloak allows backend requests to instead use its local hostname or @@ -360,7 +360,7 @@ in type = enum [ "edge" "reencrypt" "passthrough" "none" ]; default = "none"; example = "edge"; - description = lib.mdDoc '' + description = '' The proxy address forwarding mode if the server is behind a reverse proxy. @@ -389,7 +389,7 @@ in } ''; - description = lib.mdDoc '' + description = '' Configuration options corresponding to parameters set in {file}`conf/keycloak.conf`. |