diff options
author | stuebinm <stuebinm@disroot.org> | 2024-04-13 14:54:15 +0200 |
---|---|---|
committer | Jonathan Ringer <jonringer@users.noreply.github.com> | 2024-04-13 10:07:35 -0700 |
commit | 6afb255d976f85f3359e4929abd6f5149c323a02 (patch) | |
tree | ced23a118ee0852174d31005acd16f04cad3a781 /nixos/modules/services/backup | |
parent | 1dd996e59a5e67694b7a252aacba71a88d51b41e (diff) |
nixos: remove all uses of lib.mdDoc
these changes were generated with nixq 0.0.2, by running
nixq ">> lib.mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
nixq ">> mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
nixq ">> Inherit >> mdDoc[remove]" --batchmode nixos/**.nix
two mentions of the mdDoc function remain in nixos/, both of which
are inside of comments.
Since lib.mdDoc is already defined as just id, this commit is a no-op as
far as Nix (and the built manual) is concerned.
Diffstat (limited to 'nixos/modules/services/backup')
21 files changed, 297 insertions, 298 deletions
diff --git a/nixos/modules/services/backup/automysqlbackup.nix b/nixos/modules/services/backup/automysqlbackup.nix index 27bbff813b10..cf3b6b8d13a4 100644 --- a/nixos/modules/services/backup/automysqlbackup.nix +++ b/nixos/modules/services/backup/automysqlbackup.nix @@ -34,12 +34,12 @@ in options = { services.automysqlbackup = { - enable = mkEnableOption (lib.mdDoc "AutoMySQLBackup"); + enable = mkEnableOption "AutoMySQLBackup"; calendar = mkOption { type = types.str; default = "01:15:00"; - description = lib.mdDoc '' + description = '' Configured when to run the backup service systemd unit (DayOfWeek Year-Month-Day Hour:Minute:Second). ''; }; @@ -47,7 +47,7 @@ in settings = mkOption { type = with types; attrsOf (oneOf [ str int bool (listOf str) ]); default = {}; - description = lib.mdDoc '' + description = '' automysqlbackup configuration. Refer to {file}`''${pkgs.automysqlbackup}/etc/automysqlbackup.conf` for details on supported values. diff --git a/nixos/modules/services/backup/bacula.nix b/nixos/modules/services/backup/bacula.nix index 39975adf5909..94f6e6ba4fd5 100644 --- a/nixos/modules/services/backup/bacula.nix +++ b/nixos/modules/services/backup/bacula.nix @@ -10,7 +10,6 @@ let concatStringsSep literalExpression mapAttrsToList - mdDoc mkIf mkOption optional @@ -147,7 +146,7 @@ let enable = mkOption { type = types.bool; default = false; - description = mdDoc '' + description = '' Specifies if TLS should be enabled. If this set to `false` TLS will be completely disabled, even if ${tlsLink "tls.require" submodulePath} is true. ''; @@ -155,7 +154,7 @@ let require = mkOption { type = types.nullOr types.bool; default = null; - description = mdDoc '' + description = '' Require TLS or TLS-PSK encryption. This directive is ignored unless one of ${tlsLink "tls.enable" submodulePath} is true or TLS PSK Enable is set to `yes`. If TLS is not required while TLS or TLS-PSK are enabled, then the Bacula component @@ -168,7 +167,7 @@ let certificate = mkOption { type = types.nullOr types.path; default = null; - description = mdDoc '' + description = '' The full path to the PEM encoded TLS certificate. It will be used as either a client or server certificate, depending on the connection direction. @@ -179,7 +178,7 @@ let }; key = mkOption { type = types.path; - description = mdDoc '' + description = '' The path of a PEM encoded TLS private key. It must correspond to the TLS certificate. ''; @@ -187,7 +186,7 @@ let verifyPeer = mkOption { type = types.nullOr types.bool; default = null; - description = mdDoc '' + description = '' Verify peer certificate. Instructs server to request and verify the client's X.509 certificate. Any client certificate signed by a known-CA will be accepted. @@ -203,7 +202,7 @@ let allowedCN = mkOption { type = types.listOf types.str; default = [ ]; - description = mdDoc '' + description = '' Common name attribute of allowed peer certificates. This directive is valid for a server and in a client context. If this directive is specified, the peer certificate will be verified against this list. @@ -214,7 +213,7 @@ let caCertificateFile = mkOption { type = types.nullOr types.path; default = null; - description = mdDoc '' + description = '' The path specifying a PEM encoded TLS CA certificate(s). Multiple certificates are permitted in the file. One of TLS CA Certificate File or TLS CA Certificate Dir are required in a server context, unless @@ -230,7 +229,7 @@ let password = mkOption { type = types.str; # TODO: required? - description = mdDoc '' + description = '' Specifies the password that must be supplied for the default Bacula Console to be authorized. The same password must appear in the Director resource of the Console configuration file. For added @@ -251,7 +250,7 @@ let type = types.enum [ "no" "yes" ]; default = "no"; example = "yes"; - description = mdDoc '' + description = '' If Monitor is set to `no`, this director will have full access to this Storage daemon. If Monitor is set to `yes`, this director will only be able to fetch the @@ -265,7 +264,7 @@ let tls = mkOption { type = types.submodule (tlsOptions "${submodulePath}.director.<name>"); - description = mdDoc '' + description = '' TLS Options for the Director in this Configuration. ''; }; @@ -277,7 +276,7 @@ let options = { changerDevice = mkOption { type = types.str; - description = mdDoc '' + description = '' The specified name-string must be the generic SCSI device name of the autochanger that corresponds to the normal read/write Archive Device specified in the Device resource. This generic SCSI device name @@ -296,7 +295,7 @@ let changerCommand = mkOption { type = types.str; - description = mdDoc '' + description = '' The name-string specifies an external program to be called that will automatically change volumes as required by Bacula. Normally, this directive will be specified only in the AutoChanger resource, which @@ -318,14 +317,14 @@ let }; devices = mkOption { - description = mdDoc ""; + description = ""; type = types.listOf types.str; }; extraAutochangerConfig = mkOption { default = ""; type = types.lines; - description = mdDoc '' + description = '' Extra configuration to be passed in Autochanger directive. ''; example = '' @@ -342,7 +341,7 @@ let archiveDevice = mkOption { # TODO: required? type = types.str; - description = mdDoc '' + description = '' The specified name-string gives the system file name of the storage device managed by this storage daemon. This will usually be the device file name of a removable storage device (tape drive), for @@ -359,7 +358,7 @@ let mediaType = mkOption { # TODO: required? type = types.str; - description = mdDoc '' + description = '' The specified name-string names the type of media supported by this device, for example, `DLT7000`. Media type names are arbitrary in that you set them to anything you want, but they must be @@ -397,7 +396,7 @@ let extraDeviceConfig = mkOption { default = ""; type = types.lines; - description = mdDoc '' + description = '' Extra configuration to be passed in Device directive. ''; example = '' @@ -418,7 +417,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = mdDoc '' + description = '' Whether to enable the Bacula File Daemon. ''; }; @@ -427,7 +426,7 @@ in { default = "${config.networking.hostName}-fd"; defaultText = literalExpression ''"''${config.networking.hostName}-fd"''; type = types.str; - description = mdDoc '' + description = '' The client name that must be used by the Director when connecting. Generally, it is a good idea to use a name related to the machine so that error messages can be easily identified if you have multiple @@ -438,7 +437,7 @@ in { port = mkOption { default = 9102; type = types.port; - description = mdDoc '' + description = '' This specifies the port number on which the Client listens for Director connections. It must agree with the FDPort specified in the Client resource of the Director's configuration file. @@ -447,7 +446,7 @@ in { director = mkOption { default = {}; - description = mdDoc '' + description = '' This option defines director resources in Bacula File Daemon. ''; type = types.attrsOf (types.submodule (directorOptions "services.bacula-fd")); @@ -457,7 +456,7 @@ in { tls = mkOption { type = types.submodule (tlsOptions "services.bacula-fd"); default = { }; - description = mdDoc '' + description = '' TLS Options for the File Daemon. Important notice: The backup won't be encrypted. ''; @@ -466,7 +465,7 @@ in { extraClientConfig = mkOption { default = ""; type = types.lines; - description = mdDoc '' + description = '' Extra configuration to be passed in Client directive. ''; example = '' @@ -478,7 +477,7 @@ in { extraMessagesConfig = mkOption { default = ""; type = types.lines; - description = mdDoc '' + description = '' Extra configuration to be passed in Messages directive. ''; example = '' @@ -491,7 +490,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = mdDoc '' + description = '' Whether to enable Bacula Storage Daemon. ''; }; @@ -500,7 +499,7 @@ in { default = "${config.networking.hostName}-sd"; defaultText = literalExpression ''"''${config.networking.hostName}-sd"''; type = types.str; - description = mdDoc '' + description = '' Specifies the Name of the Storage daemon. ''; }; @@ -508,7 +507,7 @@ in { port = mkOption { default = 9103; type = types.port; - description = mdDoc '' + description = '' Specifies port number on which the Storage daemon listens for Director connections. ''; @@ -516,7 +515,7 @@ in { director = mkOption { default = {}; - description = mdDoc '' + description = '' This option defines Director resources in Bacula Storage Daemon. ''; type = types.attrsOf (types.submodule (directorOptions "services.bacula-sd")); @@ -524,7 +523,7 @@ in { device = mkOption { default = {}; - description = mdDoc '' + description = '' This option defines Device resources in Bacula Storage Daemon. ''; type = types.attrsOf (types.submodule deviceOptions); @@ -532,7 +531,7 @@ in { autochanger = mkOption { default = {}; - description = mdDoc '' + description = '' This option defines Autochanger resources in Bacula Storage Daemon. ''; type = types.attrsOf (types.submodule autochangerOptions); @@ -541,7 +540,7 @@ in { extraStorageConfig = mkOption { default = ""; type = types.lines; - description = mdDoc '' + description = '' Extra configuration to be passed in Storage directive. ''; example = '' @@ -553,7 +552,7 @@ in { extraMessagesConfig = mkOption { default = ""; type = types.lines; - description = mdDoc '' + description = '' Extra configuration to be passed in Messages directive. ''; example = '' @@ -563,7 +562,7 @@ in { tls = mkOption { type = types.submodule (tlsOptions "services.bacula-sd"); default = { }; - description = mdDoc '' + description = '' TLS Options for the Storage Daemon. Important notice: The backup won't be encrypted. ''; @@ -575,7 +574,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = mdDoc '' + description = '' Whether to enable Bacula Director Daemon. ''; }; @@ -584,7 +583,7 @@ in { default = "${config.networking.hostName}-dir"; defaultText = literalExpression ''"''${config.networking.hostName}-dir"''; type = types.str; - description = mdDoc '' + description = '' The director name used by the system administrator. This directive is required. ''; @@ -593,7 +592,7 @@ in { port = mkOption { default = 9101; type = types.port; - description = mdDoc '' + description = '' Specify the port (a positive integer) on which the Director daemon will listen for Bacula Console connections. This same port number must be specified in the Director resource of the Console @@ -606,7 +605,7 @@ in { password = mkOption { # TODO: required? type = types.str; - description = mdDoc '' + description = '' Specifies the password that must be supplied for a Director. ''; }; @@ -614,7 +613,7 @@ in { extraMessagesConfig = mkOption { default = ""; type = types.lines; - description = mdDoc '' + description = '' Extra configuration to be passed in Messages directive. ''; example = '' @@ -625,7 +624,7 @@ in { extraDirectorConfig = mkOption { default = ""; type = types.lines; - description = mdDoc '' + description = '' Extra configuration to be passed in Director directive. ''; example = '' @@ -637,7 +636,7 @@ in { extraConfig = mkOption { default = ""; type = types.lines; - description = mdDoc '' + description = '' Extra configuration for Bacula Director Daemon. ''; example = '' @@ -648,7 +647,7 @@ in { tls = mkOption { type = types.submodule (tlsOptions "services.bacula-dir"); default = { }; - description = mdDoc '' + description = '' TLS Options for the Director. Important notice: The backup won't be encrypted. ''; diff --git a/nixos/modules/services/backup/borgbackup.nix b/nixos/modules/services/backup/borgbackup.nix index 7d5714499f3a..570f8931bd9e 100644 --- a/nixos/modules/services/backup/borgbackup.nix +++ b/nixos/modules/services/backup/borgbackup.nix @@ -233,7 +233,7 @@ in { options.services.borgbackup.package = mkPackageOption pkgs "borgbackup" { }; options.services.borgbackup.jobs = mkOption { - description = lib.mdDoc '' + description = '' Deduplicating backups using BorgBackup. Adding a job will cause a borg-job-NAME wrapper to be added to your system path, so that you can perform maintenance easily. @@ -279,7 +279,7 @@ in { paths = mkOption { type = with types; nullOr (coercedTo str lib.singleton (listOf str)); default = null; - description = lib.mdDoc '' + description = '' Path(s) to back up. Mutually exclusive with {option}`dumpCommand`. ''; @@ -289,7 +289,7 @@ in { dumpCommand = mkOption { type = with types; nullOr path; default = null; - description = lib.mdDoc '' + description = '' Backup the stdout of this program instead of filesystem paths. Mutually exclusive with {option}`paths`. ''; @@ -298,21 +298,21 @@ in { repo = mkOption { type = types.str; - description = lib.mdDoc "Remote or local repository to back up to."; + description = "Remote or local repository to back up to."; example = "user@machine:/path/to/repo"; }; removableDevice = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Whether the repo (which must be local) is a removable device."; + description = "Whether the repo (which must be local) is a removable device."; }; archiveBaseName = mkOption { type = types.nullOr (types.strMatching "[^/{}]+"); default = "${globalConfig.networking.hostName}-${name}"; defaultText = literalExpression ''"''${config.networking.hostName}-<name>"''; - description = lib.mdDoc '' + description = '' How to name the created archives. A timestamp, whose format is determined by {option}`dateFormat`, will be appended. The full name can be modified at runtime (`$archiveName`). @@ -323,7 +323,7 @@ in { dateFormat = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Arguments passed to {command}`date` to create a timestamp suffix for the archive name. ''; @@ -334,7 +334,7 @@ in { startAt = mkOption { type = with types; either str (listOf str); default = "daily"; - description = lib.mdDoc '' + description = '' When or how often the backup should run. Must be in the format described in {manpage}`systemd.time(7)`. @@ -349,7 +349,7 @@ in { default = false; type = types.bool; example = true; - description = lib.mdDoc '' + description = '' Set the `persistentTimer` option for the {manpage}`systemd.timer(5)` which triggers the backup immediately if the last trigger @@ -361,14 +361,14 @@ in { default = false; type = types.bool; example = true; - description = lib.mdDoc '' + description = '' Prevents the system from sleeping while backing up. ''; }; user = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The user {command}`borg` is run as. User or group need read permission for the specified {option}`paths`. @@ -378,7 +378,7 @@ in { group = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The group borg is run as. User or group needs read permission for the specified {option}`paths`. ''; @@ -392,7 +392,7 @@ in { "authenticated" "authenticated-blake2" "none" ]; - description = lib.mdDoc '' + description = '' Encryption mode to use. Setting a mode other than `"none"` requires you to specify a {option}`passCommand` @@ -403,7 +403,7 @@ in { encryption.passCommand = mkOption { type = with types; nullOr str; - description = lib.mdDoc '' + description = '' A command which prints the passphrase to stdout. Mutually exclusive with {option}`passphrase`. ''; @@ -413,7 +413,7 @@ in { encryption.passphrase = mkOption { type = with types; nullOr str; - description = lib.mdDoc '' + description = '' The passphrase the backups are encrypted with. Mutually exclusive with {option}`passCommand`. If you do not want the passphrase to be stored in the @@ -427,7 +427,7 @@ in { # compression mode must be given, # compression level is optional type = types.strMatching "none|(auto,)?(lz4|zstd|zlib|lzma)(,[[:digit:]]{1,2})?"; - description = lib.mdDoc '' + description = '' Compression method to use. Refer to {command}`borg help compression` for all available options. @@ -438,7 +438,7 @@ in { exclude = mkOption { type = with types; listOf str; - description = lib.mdDoc '' + description = '' Exclude paths matching any of the given patterns. See {command}`borg help patterns` for pattern syntax. ''; @@ -451,7 +451,7 @@ in { patterns = mkOption { type = with types; listOf str; - description = lib.mdDoc '' + description = '' Include/exclude paths matching the given patterns. The first matching patterns is used, so if an include pattern (prefix `+`) matches before an exclude pattern (prefix `-`), the file is @@ -466,7 +466,7 @@ in { readWritePaths = mkOption { type = with types; listOf path; - description = lib.mdDoc '' + description = '' By default, borg cannot write anywhere on the system but `$HOME/.config/borg` and `$HOME/.cache/borg`. If, for example, your preHook script needs to dump files @@ -480,7 +480,7 @@ in { privateTmp = mkOption { type = types.bool; - description = lib.mdDoc '' + description = '' Set the `PrivateTmp` option for the systemd-service. Set to false if you need sockets or other files from global /tmp. @@ -490,7 +490,7 @@ in { doInit = mkOption { type = types.bool; - description = lib.mdDoc '' + description = '' Run {command}`borg init` if the specified {option}`repo` does not exist. You should set this to `false` @@ -502,7 +502,7 @@ in { appendFailedSuffix = mkOption { type = types.bool; - description = lib.mdDoc '' + description = '' Append a `.failed` suffix to the archive name, which is only removed if {command}`borg create` has a zero exit status. @@ -515,7 +515,7 @@ in { # means there is no limit of yearly archives to keep # The regex is for use with e.g. --keep-within 1y type = with types; attrsOf (either int (strMatching "[[:digit:]]+[Hdwmy]")); - description = lib.mdDoc '' + description = '' Prune a repository by deleting all archives not matching any of the specified retention options. See {command}`borg help prune` for the available options. @@ -533,7 +533,7 @@ in { prune.prefix = mkOption { type = types.nullOr (types.str); - description = lib.mdDoc '' + description = '' Only consider archive names starting with this prefix for pruning. By default, only archives created by this job are considered. Use `""` or `null` to consider all archives. @@ -544,7 +544,7 @@ in { environment = mkOption { type = with types; attrsOf str; - description = lib.mdDoc '' + description = '' Environment variables passed to the backup script. You can for example specify which SSH key to use. ''; @@ -554,7 +554,7 @@ in { preHook = mkOption { type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to run before the backup. This can for example be used to mount file systems. ''; @@ -567,7 +567,7 @@ in { postInit = mkOption { type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to run after {command}`borg init`. ''; default = ""; @@ -575,7 +575,7 @@ in { postCreate = mkOption { type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to run after {command}`borg create`. The name of the created archive is stored in `$archiveName`. ''; @@ -584,7 +584,7 @@ in { postPrune = mkOption { type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to run after {command}`borg prune`. ''; default = ""; @@ -592,7 +592,7 @@ in { postHook = mkOption { type = types.lines; - description = lib.mdDoc '' + description = '' Shell commands to run just before exit. They are executed even if a previous command exits with a non-zero exit code. The latter is available as `$exitStatus`. @@ -602,7 +602,7 @@ in { extraArgs = mkOption { type = with types; coercedTo (listOf str) escapeShellArgs str; - description = lib.mdDoc '' + description = '' Additional arguments for all {command}`borg` calls the service has. Handle with care. ''; @@ -612,7 +612,7 @@ in { extraInitArgs = mkOption { type = with types; coercedTo (listOf str) escapeShellArgs str; - description = lib.mdDoc '' + description = '' Additional arguments for {command}`borg init`. Can also be set at runtime using `$extraInitArgs`. ''; @@ -622,7 +622,7 @@ in { extraCreateArgs = mkOption { type = with types; coercedTo (listOf str) escapeShellArgs str; - description = lib.mdDoc '' + description = '' Additional arguments for {command}`borg create`. Can also be set at runtime using `$extraCreateArgs`. ''; @@ -635,7 +635,7 @@ in { extraPruneArgs = mkOption { type = with types; coercedTo (listOf str) escapeShellArgs str; - description = lib.mdDoc '' + description = '' Additional arguments for {command}`borg prune`. Can also be set at runtime using `$extraPruneArgs`. ''; @@ -645,7 +645,7 @@ in { extraCompactArgs = mkOption { type = with types; coercedTo (listOf str) escapeShellArgs str; - description = lib.mdDoc '' + description = '' Additional arguments for {command}`borg compact`. Can also be set at runtime using `$extraCompactArgs`. ''; @@ -658,7 +658,7 @@ in { }; options.services.borgbackup.repos = mkOption { - description = lib.mdDoc '' + description = '' Serve BorgBackup repositories to given public SSH keys, restricting their access to the repository only. See also the chapter about BorgBackup in the NixOS manual. @@ -671,7 +671,7 @@ in { options = { path = mkOption { type = types.path; - description = lib.mdDoc '' + description = '' Where to store the backups. Note that the directory is created automatically, with correct permissions. ''; @@ -680,7 +680,7 @@ in { user = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The user {command}`borg serve` is run as. User or group needs write permission for the specified {option}`path`. @@ -690,7 +690,7 @@ in { group = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The group {command}`borg serve` is run as. User or group needs write permission for the specified {option}`path`. @@ -700,7 +700,7 @@ in { authorizedKeys = mkOption { type = with types; listOf str; - description = lib.mdDoc '' + description = '' Public SSH keys that are given full write access to this repository. You should use a different SSH key for each repository you write to, because the specified keys are restricted to running {command}`borg serve` @@ -711,7 +711,7 @@ in { authorizedKeysAppendOnly = mkOption |