diff options
Diffstat (limited to 'nixos/modules/services/web-servers/phpfpm/default.nix')
-rw-r--r-- | nixos/modules/services/web-servers/phpfpm/default.nix | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/nixos/modules/services/web-servers/phpfpm/default.nix b/nixos/modules/services/web-servers/phpfpm/default.nix index 87c68fa074a..e24c77d056a 100644 --- a/nixos/modules/services/web-servers/phpfpm/default.nix +++ b/nixos/modules/services/web-servers/phpfpm/default.nix @@ -51,7 +51,7 @@ let type = types.str; default = ""; example = "/path/to/unix/socket"; - description = '' + description = lib.mdDoc '' The address on which to accept FastCGI requests. ''; }; @@ -60,22 +60,22 @@ let type = types.package; default = cfg.phpPackage; defaultText = literalExpression "config.services.phpfpm.phpPackage"; - description = '' + description = lib.mdDoc '' The PHP package to use for running this PHP-FPM pool. ''; }; phpOptions = mkOption { type = types.lines; - description = '' - "Options appended to the PHP configuration file <filename>php.ini</filename> used for this PHP-FPM pool." + description = lib.mdDoc '' + "Options appended to the PHP configuration file {file}`php.ini` used for this PHP-FPM pool." ''; }; phpEnv = lib.mkOption { type = with types; attrsOf str; default = {}; - description = '' + description = lib.mdDoc '' Environment variables used for this PHP-FPM pool. ''; example = literalExpression '' @@ -90,22 +90,22 @@ let user = mkOption { type = types.str; - description = "User account under which this pool runs."; + description = lib.mdDoc "User account under which this pool runs."; }; group = mkOption { type = types.str; - description = "Group account under which this pool runs."; + description = lib.mdDoc "Group account under which this pool runs."; }; settings = mkOption { type = with types; attrsOf (oneOf [ str int bool ]); default = {}; - description = '' + description = lib.mdDoc '' PHP-FPM pool directives. Refer to the "List of pool directives" section of - <link xlink:href="https://www.php.net/manual/en/install.fpm.configuration.php"/> + <https://www.php.net/manual/en/install.fpm.configuration.php> for details. Note that settings names must be enclosed in quotes (e.g. - <literal>"pm.max_children"</literal> instead of <literal>pm.max_children</literal>). + `"pm.max_children"` instead of `pm.max_children`). ''; example = literalExpression '' { @@ -122,9 +122,9 @@ let extraConfig = mkOption { type = with types; nullOr lines; default = null; - description = '' + description = lib.mdDoc '' Extra lines that go into the pool configuration. - See the documentation on <literal>php-fpm.conf</literal> for + See the documentation on `php-fpm.conf` for details on configuration directives. ''; }; @@ -154,24 +154,24 @@ in { settings = mkOption { type = with types; attrsOf (oneOf [ str int bool ]); default = {}; - description = '' + description = lib.mdDoc '' PHP-FPM global directives. Refer to the "List of global php-fpm.conf directives" section of - <link xlink:href="https://www.php.net/manual/en/install.fpm.configuration.php"/> + <https://www.php.net/manual/en/install.fpm.configuration.php> for details. Note that settings names must be enclosed in quotes (e.g. - <literal>"pm.max_children"</literal> instead of <literal>pm.max_children</literal>). - You need not specify the options <literal>error_log</literal> or - <literal>daemonize</literal> here, since they are generated by NixOS. + `"pm.max_children"` instead of `pm.max_children`). + You need not specify the options `error_log` or + `daemonize` here, since they are generated by NixOS. ''; }; extraConfig = mkOption { type = with types; nullOr lines; default = null; - description = '' + description = lib.mdDoc '' Extra configuration that should be put in the global section of the PHP-FPM configuration file. Do not specify the options - <literal>error_log</literal> or - <literal>daemonize</literal> here, since they are generated by + `error_log` or + `daemonize` here, since they are generated by NixOS. ''; }; @@ -180,7 +180,7 @@ in { type = types.package; default = pkgs.php; defaultText = literalExpression "pkgs.php"; - description = '' + description = lib.mdDoc '' The PHP package to use for running the PHP-FPM service. ''; }; @@ -192,8 +192,8 @@ in { '' date.timezone = "CET" ''; - description = '' - Options appended to the PHP configuration file <filename>php.ini</filename>. + description = lib.mdDoc '' + Options appended to the PHP configuration file {file}`php.ini`. ''; }; @@ -216,7 +216,7 @@ in { }; } }''; - description = '' + description = lib.mdDoc '' PHP-FPM pools. If no pools are defined, the PHP-FPM service is disabled. ''; |