diff options
Diffstat (limited to 'nixos/modules/services/misc/redmine.nix')
-rw-r--r-- | nixos/modules/services/misc/redmine.nix | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/nixos/modules/services/misc/redmine.nix b/nixos/modules/services/misc/redmine.nix index 696b8d1a25d..13b62f43557 100644 --- a/nixos/modules/services/misc/redmine.nix +++ b/nixos/modules/services/misc/redmine.nix @@ -55,40 +55,40 @@ in type = types.package; default = pkgs.redmine; defaultText = literalExpression "pkgs.redmine"; - description = "Which Redmine package to use."; + description = lib.mdDoc "Which Redmine package to use."; example = literalExpression "pkgs.redmine.override { ruby = pkgs.ruby_2_7; }"; }; user = mkOption { type = types.str; default = "redmine"; - description = "User under which Redmine is ran."; + description = lib.mdDoc "User under which Redmine is ran."; }; group = mkOption { type = types.str; default = "redmine"; - description = "Group under which Redmine is ran."; + description = lib.mdDoc "Group under which Redmine is ran."; }; port = mkOption { type = types.port; default = 3000; - description = "Port on which Redmine is ran."; + description = lib.mdDoc "Port on which Redmine is ran."; }; stateDir = mkOption { type = types.str; default = "/var/lib/redmine"; - description = "The state directory, logs and plugins are stored here."; + description = lib.mdDoc "The state directory, logs and plugins are stored here."; }; settings = mkOption { type = format.type; default = {}; - description = '' - Redmine configuration (<filename>configuration.yml</filename>). Refer to - <link xlink:href="https://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration"/> + description = lib.mdDoc '' + Redmine configuration ({file}`configuration.yml`). Refer to + <https://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration> for details. ''; example = literalExpression '' @@ -107,10 +107,10 @@ in extraEnv = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration in additional_environment.rb. - See <link xlink:href="https://svn.redmine.org/redmine/trunk/config/additional_environment.rb.example"/> + See <https://svn.redmine.org/redmine/trunk/config/additional_environment.rb.example> for details. ''; example = '' @@ -121,7 +121,7 @@ in themes = mkOption { type = types.attrsOf types.path; default = {}; - description = "Set of themes."; + description = lib.mdDoc "Set of themes."; example = literalExpression '' { dkuk-redmine_alex_skin = builtins.fetchurl { @@ -135,7 +135,7 @@ in plugins = mkOption { type = types.attrsOf types.path; default = {}; - description = "Set of plugins."; + description = lib.mdDoc "Set of plugins."; example = literalExpression '' { redmine_env_auth = builtins.fetchurl { @@ -151,41 +151,41 @@ in type = types.enum [ "mysql2" "postgresql" ]; example = "postgresql"; default = "mysql2"; - description = "Database engine to use."; + description = lib.mdDoc "Database engine to use."; }; host = mkOption { type = types.str; default = "localhost"; - description = "Database host address."; + description = lib.mdDoc "Database host address."; }; port = mkOption { type = types.int; default = if cfg.database.type == "postgresql" then 5432 else 3306; defaultText = literalExpression "3306"; - description = "Database host port."; + description = lib.mdDoc "Database host port."; }; name = mkOption { type = types.str; default = "redmine"; - description = "Database name."; + description = lib.mdDoc "Database name."; }; user = mkOption { type = types.str; default = "redmine"; - description = "Database user."; + description = lib.mdDoc "Database user."; }; passwordFile = mkOption { type = types.nullOr types.path; default = null; example = "/run/keys/redmine-dbpassword"; - description = '' + description = lib.mdDoc '' A file containing the password corresponding to - <option>database.user</option>. + {option}`database.user`. ''; }; @@ -197,13 +197,13 @@ in else null; defaultText = literalExpression "/run/mysqld/mysqld.sock"; example = "/run/mysqld/mysqld.sock"; - description = "Path to the unix socket file to use for authentication."; + description = lib.mdDoc "Path to the unix socket file to use for authentication."; }; createLocally = mkOption { type = types.bool; default = true; - description = "Create the database and database user locally."; + description = lib.mdDoc "Create the database and database user locally."; }; }; }; |