diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/databases/pgbouncer.nix')
| -rw-r--r-- | nixpkgs/nixos/modules/services/databases/pgbouncer.nix | 84 |
1 files changed, 42 insertions, 42 deletions
diff --git a/nixpkgs/nixos/modules/services/databases/pgbouncer.nix b/nixpkgs/nixos/modules/services/databases/pgbouncer.nix index 157d49c13161..32538789fb17 100644 --- a/nixpkgs/nixos/modules/services/databases/pgbouncer.nix +++ b/nixpkgs/nixos/modules/services/databases/pgbouncer.nix @@ -77,14 +77,14 @@ in { # NixOS settings - enable = mkEnableOption (lib.mdDoc "PostgreSQL connection pooler"); + enable = mkEnableOption "PostgreSQL connection pooler"; package = mkPackageOption pkgs "pgbouncer" { }; openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to automatically open the specified TCP port in the firewall. ''; }; @@ -94,7 +94,7 @@ in { logFile = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Specifies a log file in addition to journald. ''; }; @@ -103,7 +103,7 @@ in { type = types.nullOr types.commas; example = "*"; default = null; - description = lib.mdDoc '' + description = '' Specifies a list (comma-separated) of addresses where to listen for TCP connections. You may also use * meaning “listen on all addresses”. When not set, only Unix socket connections are accepted. @@ -115,7 +115,7 @@ in { listenPort = mkOption { type = types.port; default = 6432; - description = lib.mdDoc '' + description = '' Which port to listen on. Applies to both TCP and Unix sockets. ''; }; @@ -123,7 +123,7 @@ in { poolMode = mkOption { type = types.enum [ "session" "transaction" "statement" ]; default = "session"; - description = lib.mdDoc '' + description = '' Specifies when a server connection can be reused by other clients. session @@ -139,7 +139,7 @@ in { maxClientConn = mkOption { type = types.int; default = 100; - description = lib.mdDoc '' + description = '' Maximum number of client connections allowed. When this setting is increased, then the file descriptor limits in the operating system @@ -160,7 +160,7 @@ in { defaultPoolSize = mkOption { type = types.int; default = 20; - description = lib.mdDoc '' + description = '' How many server connections to allow per user/database pair. Can be overridden in the per-database configuration. ''; @@ -169,7 +169,7 @@ in { maxDbConnections = mkOption { type = types.int; default = 0; - description = lib.mdDoc '' + description = '' Do not allow more than this many server connections per database (regardless of user). This considers the PgBouncer database that the client has connected to, not the PostgreSQL database of the outgoing connection. @@ -189,7 +189,7 @@ in { maxUserConnections = mkOption { type = types.int; default = 0; - description = lib.mdDoc '' + description = '' Do not allow more than this many server connections per user (regardless of database). This considers the PgBouncer user that is associated with a pool, which is either the user specified for the server connection @@ -211,7 +211,7 @@ in { type = types.nullOr types.commas; example = "extra_float_digits"; default = null; - description = lib.mdDoc '' + description = '' By default, PgBouncer allows only parameters it can keep track of in startup packets: client_encoding, datestyle, timezone and standard_conforming_strings. @@ -236,7 +236,7 @@ in { bardb = "host=localhost dbname=bazdb"; foodb = "host=host1.example.com port=5432"; }; - description = lib.mdDoc '' + description = '' Detailed information about PostgreSQL database definitions: <https://www.pgbouncer.org/config.html#section-databases> ''; @@ -249,7 +249,7 @@ in { example = { user1 = "pool_mode=session"; }; - description = lib.mdDoc '' + description = '' Optional. Detailed information about PostgreSQL user definitions: @@ -265,7 +265,7 @@ in { "1" = "host=host1.example.com"; "2" = "host=/tmp/pgbouncer-2 port=5555"; }; - description = lib.mdDoc '' + description = '' Optional. Detailed information about PostgreSQL database definitions: @@ -277,7 +277,7 @@ in { authType = mkOption { type = types.enum [ "cert" "md5" "scram-sha-256" "plain" "trust" "any" "hba" "pam" ]; default = "md5"; - description = lib.mdDoc '' + description = '' How to authenticate users. cert @@ -312,7 +312,7 @@ in { type = types.nullOr types.path; default = null; example = "/secrets/pgbouncer_hba"; - description = lib.mdDoc '' + description = '' HBA configuration file to use when authType is hba. See HBA file format details: @@ -324,7 +324,7 @@ in { type = types.nullOr types.path; default = null; example = "/secrets/pgbouncer_authfile"; - description = lib.mdDoc '' + description = '' The name of the file to load user names and passwords from. See section Authentication file format details: @@ -339,7 +339,7 @@ in { type = types.nullOr types.str; default = null; example = "pgbouncer"; - description = lib.mdDoc '' + description = '' If authUser is set, then any user not specified in authFile will be queried through the authQuery query from pg_shadow in the database, using authUser. The password of authUser will be taken from authFile. @@ -354,7 +354,7 @@ in { type = types.nullOr types.str; default = null; example = "SELECT usename, passwd FROM pg_shadow WHERE usename=$1"; - description = lib.mdDoc '' + description = '' Query to load user's password from database. Direct access to pg_shadow requires admin rights. @@ -369,7 +369,7 @@ in { type = types.nullOr types.str; default = null; example = "authdb"; - description = lib.mdDoc '' + description = '' Database name in the [database] section to be used for authentication purposes. This option can be either global or overriden in the connection string if this parameter is specified. ''; @@ -382,7 +382,7 @@ in { sslmode = mkOption { type = types.enum [ "disable" "allow" "prefer" "require" "verify-ca" "verify-full" ]; default = "disable"; - description = lib.mdDoc '' + description = '' TLS mode to use for connections from clients. TLS connections are disabled by default. @@ -409,22 +409,22 @@ in { certFile = mkOption { type = types.path; example = "/secrets/pgbouncer.key"; - description = lib.mdDoc "Path to certificate for private key. Clients can validate it"; + description = "Path to certificate for private key. Clients can validate it"; }; keyFile = mkOption { type = types.path; example = "/secrets/pgbouncer.crt"; - description = lib.mdDoc "Path to private key for PgBouncer to accept client connections"; + description = "Path to private key for PgBouncer to accept client connections"; }; caFile = mkOption { type = types.path; example = "/secrets/pgbouncer.crt"; - description = lib.mdDoc "Path to root certificate file to validate client certificates"; + description = "Path to root certificate file to validate client certificates"; }; }; }); default = null; - description = lib.mdDoc '' + description = '' <https://www.pgbouncer.org/config.html#tls-settings> ''; }; @@ -435,7 +435,7 @@ in { sslmode = mkOption { type = types.enum [ "disable" "allow" "prefer" "require" "verify-ca" "verify-full" ]; default = "disable"; - description = lib.mdDoc '' + description = '' TLS mode to use for connections to PostgreSQL servers. TLS connections are disabled by default. @@ -461,22 +461,22 @@ in { certFile = mkOption { type = types.path; example = "/secrets/pgbouncer_server.key"; - description = lib.mdDoc "Certificate for private key. PostgreSQL server can validate it."; + description = "Certificate for private key. PostgreSQL server can validate it."; }; keyFile = mkOption { type = types.path; example = "/secrets/pgbouncer_server.crt"; - description = lib.mdDoc "Private key for PgBouncer to authenticate against PostgreSQL server."; + description = "Private key for PgBouncer to authenticate against PostgreSQL server."; }; caFile = mkOption { type = types.path; example = "/secrets/pgbouncer_server.crt"; - description = lib.mdDoc "Root certificate file to validate PostgreSQL server certificates."; + description = "Root certificate file to validate PostgreSQL server certificates."; }; }; }); default = null; - description = lib.mdDoc '' + description = '' <https://www.pgbouncer.org/config.html#tls-settings> ''; }; @@ -488,28 +488,28 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Toggles syslog on/off. ''; }; syslogIdent = mkOption { type = types.str; default = "pgbouncer"; - description = lib.mdDoc '' + description = '' Under what name to send logs to syslog. ''; }; syslogFacility = mkOption { type = types.enum [ "auth" "authpriv" "daemon" "user" "local0" "local1" "local2" "local3" "local4" "local5" "local6" "local7" ]; default = "daemon"; - description = lib.mdDoc '' + description = '' Under what facility to send logs to syslog. ''; }; }; }); default = null; - description = lib.mdDoc '' + description = '' <https://www.pgbouncer.org/config.html#log-settings> ''; }; @@ -517,7 +517,7 @@ in { verbose = lib.mkOption { type = lib.types.int; default = 0; - description = lib.mdDoc '' + description = '' Increase verbosity. Mirrors the “-v” switch on the command line. ''; }; @@ -526,7 +526,7 @@ in { adminUsers = mkOption { type = types.nullOr types.commas; default = null; - description = lib.mdDoc '' + description = '' Comma-separated list of database users that are allowed to connect and run all commands on the console. Ignored when authType is any, in which case any user name is allowed in as admin. ''; @@ -535,7 +535,7 @@ in { statsUsers = mkOption { type = types.nullOr types.commas; default = null; - description = lib.mdDoc '' + description = '' Comma-separated list of database users that are allowed to connect and run read-only queries on the console. That means all SHOW commands except SHOW FDS. ''; @@ -545,7 +545,7 @@ in { openFilesLimit = lib.mkOption { type = lib.types.int; default = 65536; - description = lib.mdDoc '' + description = '' Maximum number of open files. ''; }; @@ -553,7 +553,7 @@ in { user = mkOption { type = types.str; default = "pgbouncer"; - description = lib.mdDoc '' + description = '' The user pgbouncer is run as. ''; }; @@ -561,7 +561,7 @@ in { group = mkOption { type = types.str; default = "pgbouncer"; - description = lib.mdDoc '' + description = '' The group pgbouncer is run as. ''; }; @@ -569,7 +569,7 @@ in { homeDir = mkOption { type = types.path; default = "/var/lib/pgbouncer"; - description = lib.mdDoc '' + description = '' Specifies the home directory. ''; }; @@ -577,7 +577,7 @@ in { # Extra settings extraConfig = mkOption { type = types.lines; - description = lib.mdDoc '' + description = '' Any additional text to be appended to config.ini <https://www.pgbouncer.org/config.html>. ''; |