diff options
Diffstat (limited to 'nixos/modules/services/network-filesystems')
23 files changed, 216 insertions, 216 deletions
diff --git a/nixos/modules/services/network-filesystems/cachefilesd.nix b/nixos/modules/services/network-filesystems/cachefilesd.nix index 229c9665419f..da5a79a062c7 100644 --- a/nixos/modules/services/network-filesystems/cachefilesd.nix +++ b/nixos/modules/services/network-filesystems/cachefilesd.nix @@ -20,20 +20,20 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable cachefilesd network filesystems caching daemon."; + description = lib.mdDoc "Whether to enable cachefilesd network filesystems caching daemon."; }; cacheDir = mkOption { type = types.str; default = "/var/cache/fscache"; - description = "Directory to contain filesystem cache."; + description = lib.mdDoc "Directory to contain filesystem cache."; }; extraConfig = mkOption { type = types.lines; default = ""; example = "brun 10%"; - description = "Additional configuration file entries. See cachefilesd.conf(5) for more information."; + description = lib.mdDoc "Additional configuration file entries. See cachefilesd.conf(5) for more information."; }; }; diff --git a/nixos/modules/services/network-filesystems/ceph.nix b/nixos/modules/services/network-filesystems/ceph.nix index 7a1444decafa..2437aba86e4f 100644 --- a/nixos/modules/services/network-filesystems/ceph.nix +++ b/nixos/modules/services/network-filesystems/ceph.nix @@ -80,7 +80,7 @@ in example = '' 433a2193-4f8a-47a0-95d2-209d7ca2cca5 ''; - description = '' + description = lib.mdDoc '' Filesystem ID, a generated uuid, its must be generated and set before attempting to start a cluster ''; @@ -89,7 +89,7 @@ in clusterName = mkOption { type = types.str; default = "ceph"; - description = '' + description = lib.mdDoc '' Name of cluster ''; }; @@ -98,7 +98,7 @@ in type = types.path; default = "${pkgs.ceph.lib}/lib/ceph/mgr"; defaultText = literalExpression ''"''${pkgs.ceph.lib}/lib/ceph/mgr"''; - description = '' + description = lib.mdDoc '' Path at which to find ceph-mgr modules. ''; }; @@ -109,7 +109,7 @@ in example = '' node0, node1, node2 ''; - description = '' + description = lib.mdDoc '' List of hosts that will be used as monitors at startup. ''; }; @@ -120,7 +120,7 @@ in example = '' 10.10.0.1, 10.10.0.2, 10.10.0.3 ''; - description = '' + description = lib.mdDoc '' List of hostname shortnames/IP addresses of the initial monitors. ''; }; @@ -128,7 +128,7 @@ in maxOpenFiles = mkOption { type = types.int; default = 131072; - description = '' + description = lib.mdDoc '' Max open files for each OSD daemon. ''; }; @@ -136,7 +136,7 @@ in authClusterRequired = mkOption { type = types.enum [ "cephx" "none" ]; default = "cephx"; - description = '' + description = lib.mdDoc '' Enables requiring daemons to authenticate with eachother in the cluster. ''; }; @@ -144,7 +144,7 @@ in authServiceRequired = mkOption { type = types.enum [ "cephx" "none" ]; default = "cephx"; - description = '' + description = lib.mdDoc '' Enables requiring clients to authenticate with the cluster to access services in the cluster (e.g. radosgw, mds or osd). ''; }; @@ -152,7 +152,7 @@ in authClientRequired = mkOption { type = types.enum [ "cephx" "none" ]; default = "cephx"; - description = '' + description = lib.mdDoc '' Enables requiring the cluster to authenticate itself to the client. ''; }; @@ -163,7 +163,7 @@ in example = '' 10.20.0.0/24, 192.168.1.0/24 ''; - description = '' + description = lib.mdDoc '' A comma-separated list of subnets that will be used as public networks in the cluster. ''; }; @@ -174,7 +174,7 @@ in example = '' 10.10.0.0/24, 192.168.0.0/24 ''; - description = '' + description = lib.mdDoc '' A comma-separated list of subnets that will be used as cluster networks in the cluster. ''; }; @@ -183,7 +183,7 @@ in type = with types; nullOr path; default = "${pkgs.mailcap}/etc/mime.types"; defaultText = literalExpression ''"''${pkgs.mailcap}/etc/mime.types"''; - description = '' + description = lib.mdDoc '' Path to mime types used by radosgw. ''; }; @@ -195,7 +195,7 @@ in example = { "ms bind ipv6" = "true"; }; - description = '' + description = lib.mdDoc '' Extra configuration to add to the global section. Use for setting values that are common for all daemons in the cluster. ''; }; @@ -206,7 +206,7 @@ in type = with types; listOf str; default = []; example = [ "name1" "name2" ]; - description = '' + description = lib.mdDoc '' A list of names for manager daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in mgr.name1 ''; @@ -214,7 +214,7 @@ in extraConfig = mkOption { type = with types; attrsOf str; default = {}; - description = '' + description = lib.mdDoc '' Extra configuration to add to the global section for manager daemons. ''; }; @@ -226,7 +226,7 @@ in type = with types; listOf str; default = []; example = [ "name1" "name2" ]; - description = '' + description = lib.mdDoc '' A list of monitor daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in mon.name1 ''; @@ -234,7 +234,7 @@ in extraConfig = mkOption { type = with types; attrsOf str; default = {}; - description = '' + description = lib.mdDoc '' Extra configuration to add to the monitor section. ''; }; @@ -246,7 +246,7 @@ in type = with types; listOf str; default = []; example = [ "name1" "name2" ]; - description = '' + description = lib.mdDoc '' A list of OSD daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in osd.name1 ''; @@ -262,7 +262,7 @@ in "osd pool default pgp num" = "200"; "osd crush chooseleaf type" = "1"; }; - description = '' + description = lib.mdDoc '' Extra configuration to add to the OSD section. ''; }; @@ -274,7 +274,7 @@ in type = with types; listOf str; default = []; example = [ "name1" "name2" ]; - description = '' + description = lib.mdDoc '' A list of metadata service daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in mds.name1 ''; @@ -282,7 +282,7 @@ in extraConfig = mkOption { type = with types; attrsOf str; default = {}; - description = '' + description = lib.mdDoc '' Extra configuration to add to the MDS section. ''; }; @@ -294,7 +294,7 @@ in type = with types; listOf str; default = []; example = [ "name1" "name2" ]; - description = '' + description = lib.mdDoc '' A list of rados gateway daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in client.name1, radosgw daemons aren't daemons to cluster in the sense that OSD, MGR or MON daemons are. They are simply @@ -315,7 +315,7 @@ in "client.radosgw.node0" = { "some config option" = "true"; }; }; ''; - description = '' + description = lib.mdDoc '' Extra configuration to add to the client section. Configuration for rados gateways would be added here, with their own sections, see example. ''; diff --git a/nixos/modules/services/network-filesystems/davfs2.nix b/nixos/modules/services/network-filesystems/davfs2.nix index 8cf314fe63a5..8024cfba08be 100644 --- a/nixos/modules/services/network-filesystems/davfs2.nix +++ b/nixos/modules/services/network-filesystems/davfs2.nix @@ -15,7 +15,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable davfs2. ''; }; @@ -23,7 +23,7 @@ in davUser = mkOption { type = types.str; default = "davfs2"; - description = '' + description = lib.mdDoc '' When invoked by root the mount.davfs daemon will run as this user. Value must be given as name, not as numerical id. ''; @@ -32,7 +32,7 @@ in davGroup = mkOption { type = types.str; default = "davfs2"; - description = '' + description = lib.mdDoc '' The group of the running mount.davfs daemon. Ordinary users must be member of this group in order to mount a davfs2 file system. Value must be given as name, not as numerical id. @@ -47,7 +47,7 @@ in proxy foo.bar:8080 use_locks 0 ''; - description = '' + description = lib.mdDoc '' Extra lines appended to the configuration of davfs2. '' ; }; diff --git a/nixos/modules/services/network-filesystems/diod.nix b/nixos/modules/services/network-filesystems/diod.nix index 063bae6ddb1d..541b4ffd6b46 100644 --- a/nixos/modules/services/network-filesystems/diod.nix +++ b/nixos/modules/services/network-filesystems/diod.nix @@ -26,13 +26,13 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to enable the diod 9P file server."; + description = lib.mdDoc "Whether to enable the diod 9P file server."; }; listen = mkOption { type = types.listOf types.str; default = [ "0.0.0.0:564" ]; - description = '' + description = lib.mdDoc '' [ "IP:PORT" [,"IP:PORT",...] ] List the interfaces and ports that diod should listen on. ''; @@ -41,7 +41,7 @@ in exports = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' List the file systems that clients will be allowed to mount. All paths should be fully qualified. The exports table can include two types of element: a string element (as above), @@ -57,7 +57,7 @@ in exportall = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Export all file systems listed in /proc/mounts. If new file systems are mounted after diod has started, they will become immediately mountable. If there is a duplicate entry for a file system in the exports list, any options listed in @@ -68,7 +68,7 @@ in exportopts = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Establish a default set of export options. These are overridden, not appended to, by opts attributes in an "exports" entry. ''; @@ -77,7 +77,7 @@ in nwthreads = mkOption { type = types.int; default = 16; - description = '' + description = lib.mdDoc '' Sets the (fixed) number of worker threads created to handle 9P requests for a unique aname. ''; @@ -86,7 +86,7 @@ in authRequired = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allow clients to connect without authentication, i.e. without a valid MUNGE credential. ''; }; @@ -94,7 +94,7 @@ in userdb = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' This option disables password/group lookups. It allows any uid to attach and assumes gid=uid, and supplementary groups contain only the primary gid. ''; @@ -103,7 +103,7 @@ in allsquash = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Remap all users to "nobody". The attaching user need not be present in the password file. ''; @@ -112,7 +112,7 @@ in squashuser = mkOption { type = types.str; default = "nobody"; - description = '' + description = lib.mdDoc '' Change the squash user. The squash user must be present in the password file. ''; }; @@ -120,7 +120,7 @@ in logdest = mkOption { type = types.str; default = "syslog:daemon:err"; - description = '' + description = lib.mdDoc '' Set the destination for logging. The value has the form of "syslog:facility:level" or "filename". ''; @@ -130,7 +130,7 @@ in statfsPassthru = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' This option configures statfs to return the host file system's type rather than V9FS_MAGIC. ''; @@ -139,7 +139,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = "Extra configuration options for diod.conf."; + description = lib.mdDoc "Extra configuration options for diod.conf."; }; }; }; diff --git a/nixos/modules/services/network-filesystems/drbd.nix b/nixos/modules/services/network-filesystems/drbd.nix index c730e0b34e90..e74ed391d48e 100644 --- a/nixos/modules/services/network-filesystems/drbd.nix +++ b/nixos/modules/services/network-filesystems/drbd.nix @@ -15,7 +15,7 @@ let cfg = config.services.drbd; in services.drbd.enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable support for DRBD, the Distributed Replicated Block Device. ''; @@ -24,8 +24,8 @@ let cfg = config.services.drbd; in services.drbd.config = mkOption { default = ""; type = types.lines; - description = '' - Contents of the <filename>drbd.conf</filename> configuration file. + description = lib.mdDoc '' + Contents of the {file}`drbd.conf` configuration file. ''; }; diff --git a/nixos/modules/services/network-filesystems/glusterfs.nix b/nixos/modules/services/network-filesystems/glusterfs.nix index aa5dd91d5537..99aa26feb6f1 100644 --- a/nixos/modules/services/network-filesystems/glusterfs.nix +++ b/nixos/modules/services/network-filesystems/glusterfs.nix @@ -37,13 +37,13 @@ in logLevel = mkOption { type = types.enum ["DEBUG" "INFO" "WARNING" "ERROR" "CRITICAL" "TRACE" "NONE"]; - description = "Log level used by the GlusterFS daemon"; + description = lib.mdDoc "Log level used by the GlusterFS daemon"; default = "INFO"; }; useRpcbind = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Enable use of rpcbind. This is required for Gluster's NFS functionality. You may want to turn it off to reduce the attack surface for DDoS reflection attacks. @@ -56,13 +56,13 @@ in enableGlustereventsd = mkOption { type = types.bool; - description = "Whether to enable the GlusterFS Events Daemon"; + description = lib.mdDoc "Whether to enable the GlusterFS Events Daemon"; default = true; }; killMode = mkOption { type = types.enum ["control-group" "process" "mixed" "none"]; - description = '' + description = lib.mdDoc '' The systemd KillMode to use for glusterd. glusterd spawns other daemons like gsyncd. @@ -79,7 +79,7 @@ in stopKillTimeout = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The systemd TimeoutStopSec to use. After this time after having been asked to shut down, glusterd @@ -94,17 +94,17 @@ in extraFlags = mkOption { type = types.listOf types.str; - description = "Extra flags passed to the GlusterFS daemon"; + description = lib.mdDoc "Extra flags passed to the GlusterFS daemon"; default = []; }; tlsSettings = mkOption { - description = '' + description = lib.mdDoc '' Make the server communicate via TLS. This means it will only connect to other gluster servers having certificates signed by the same CA. - Enabling this will create a file <filename>/var/lib/glusterd/secure-access</filename>. + Enabling this will create a file {file}`/var/lib/glusterd/secure-access`. Disabling will delete this file again. See also: https://gluster.readthedocs.io/en/latest/Administrator%20Guide/SSL/ @@ -114,17 +114,17 @@ in options = { tlsKeyPath = mkOption { type = types.str; - description = "Path to the private key used for TLS."; + description = lib.mdDoc "Path to the private key used for TLS."; }; tlsPem = mkOption { type = types.path; - description = "Path to the certificate used for TLS."; + description = lib.mdDoc "Path to the certificate used for TLS."; }; caCert = mkOption { type = types.path; - description = "Path certificate authority used to sign the cluster certificates."; + description = lib.mdDoc "Path certificate authority used to sign the cluster certificates."; }; }; }); diff --git a/nixos/modules/services/network-filesystems/ipfs.nix b/nixos/modules/services/network-filesystems/ipfs.nix index b7e6a787cfb1..af4b725bf21b 100644 --- a/nixos/modules/services/network-filesystems/ipfs.nix +++ b/nixos/modules/services/network-filesystems/ipfs.nix @@ -58,19 +58,19 @@ in type = types.package; default = pkgs.ipfs; defaultText = literalExpression "pkgs.ipfs"; - description = "Which IPFS package to use."; + description = lib.mdDoc "Which IPFS package to use."; }; user = mkOption { type = types.str; default = "ipfs"; - description = "User under which the IPFS daemon runs"; + description = lib.mdDoc "User under which the IPFS daemon runs"; }; group = mkOption { type = types.str; default = "ipfs"; - description = "Group under which the IPFS daemon runs"; + description = lib.mdDoc "Group under which the IPFS daemon runs"; }; dataDir = mkOption { @@ -84,49 +84,49 @@ in then "/var/lib/ipfs" else "/var/lib/ipfs/.ipfs" ''; - description = "The data dir for IPFS"; + description = lib.mdDoc "The data dir for IPFS"; }; defaultMode = mkOption { type = types.enum [ "online" "offline" "norouting" ]; default = "online"; - description = "systemd service that is enabled by default"; + description = lib.mdDoc "systemd service that is enabled by default"; }; autoMount = mkOption { type = types.bool; default = false; - description = "Whether IPFS should try to mount /ipfs and /ipns at startup."; + description = lib.mdDoc "Whether IPFS should try to mount /ipfs and /ipns at startup."; }; autoMigrate = mkOption { type = types.bool; default = true; - description = "Whether IPFS should try to run the fs-repo-migration at startup."; + description = lib.mdDoc "Whether IPFS should try to run the fs-repo-migration at startup."; }; ipfsMountDir = mkOption { type = types.str; default = "/ipfs"; - description = "Where to mount the IPFS namespace to"; + description = lib.mdDoc "Where to mount the IPFS namespace to"; }; ipnsMountDir = mkOption { type = types.str; default = "/ipns"; - description = "Where to mount the IPNS namespace to"; + description = lib.mdDoc "Where to mount the IPNS namespace to"; }; gatewayAddress = mkOption { type = types.str; default = "/ip4/127.0.0.1/tcp/8080"; - description = "Where the IPFS Gateway can be reached"; + description = lib.mdDoc "Where the IPFS Gateway can be reached"; }; apiAddress = mkOption { type = types.str; default = "/ip4/127.0.0.1/tcp/5001"; - description = "Where IPFS exposes its API to"; + description = lib.mdDoc "Where IPFS exposes its API to"; }; swarmAddress = mkOption { @@ -137,25 +137,25 @@ in "/ip4/0.0.0.0/udp/4001/quic" "/ip6/::/udp/4001/quic" ]; - description = "Where IPFS listens for incoming p2p connections"; + description = lib.mdDoc "Where IPFS listens for incoming p2p connections"; }; enableGC = mkOption { type = types.bool; default = false; - description = "Whether to enable automatic garbage collection"; + description = lib.mdDoc "Whether to enable automatic garbage collection"; }; emptyRepo = mkOption { type = types.bool; default = false; - description = "If set to true, the repo won't be initialized with help files"; + description = lib.mdDoc "If set to true, the repo won't be initialized with help files"; }; extraConfig = mkOption { type = types.attrs; - description = '' - Attrset of daemon configuration to set using <command>ipfs config</command>, every time the daemon starts. + description = lib.mdDoc '' + Attrset of daemon configuration to set using {command}`ipfs config`, every time the daemon starts. These are applied last, so may override configuration set by other options in this module. Keep in mind that this configuration is stateful; i.e., unsetting anything in here does not reset the value to the default! ''; @@ -174,13 +174,13 @@ in extraFlags = mkOption { type = types.listOf types.str; - description = "Extra flags passed to the IPFS daemon"; + description = lib.mdDoc "Extra flags passed to the IPFS daemon"; default = [ ]; }; localDiscovery = mkOption { type = types.bool; - description = ''Whether to enable local discovery for the ipfs daemon. + description = lib.mdDoc ''Whether to enable local discovery for the ipfs daemon. This will allow ipfs to scan ports on your local network. Some hosting services will ban you if you do this. ''; default = false; @@ -189,14 +189,14 @@ in serviceFdlimit = mkOption { type = types.nullOr types.int; default = null; - description = "The fdlimit for the IPFS systemd unit or <literal>null</literal> to have the daemon attempt to manage it"; + description = lib.mdDoc "The fdlimit for the IPFS systemd unit or `null` to have the daemon attempt to manage it"; example = 64 * 1024; }; startWhenNeeded = mkOption { type = types.bool; default = false; - description = "Whether to use socket activation to start IPFS when needed."; + description = lib.mdDoc "Whether to use socket activation to start IPFS when needed."; }; }; diff --git a/nixos/modules/services/network-filesystems/kbfs.nix b/nixos/modules/services/network-filesystems/kbfs.nix index a43ac656f667..33ff283d5e81 100644 --- a/nixos/modules/services/network-filesystems/kbfs.nix +++ b/nixos/modules/services/network-filesystems/kbfs.nix @@ -15,15 +15,15 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Whether to mount the Keybase filesystem."; + description = lib.mdDoc "Whether to mount the Keybase filesystem."; }; enableRedirector = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the Keybase root redirector service, allowing - any user to access KBFS files via <literal>/keybase</literal>, + any user to access KBFS files via `/keybase`, which will show different contents depending on the requester. ''; }; @@ -32,7 +32,7 @@ in { type = types.str; default = "%h/keybase"; example = "/keybase"; - description = "Mountpoint for the Keybase filesystem."; + description = lib.mdDoc "Mountpoint for the Keybase filesystem."; }; extraFlags = mkOption { @@ -42,7 +42,7 @@ in { "-label kbfs" "-mount-type normal" ]; - description = '' + description = lib.mdDoc '' Additional flags to pass to the Keybase filesystem on launch. ''; }; diff --git a/nixos/modules/services/network-filesystems/litestream/default.nix b/nixos/modules/services/network-filesystems/litestream/default.nix index 51eb920d778d..25744b919646 100644 --- a/nixos/modules/services/network-filesystems/litestream/default.nix +++ b/nixos/modules/services/network-filesystems/litestream/default.nix @@ -11,15 +11,15 @@ in enable = mkEnableOption "litestream"; package = mkOption { - description = "Package to use."; + description = lib.mdDoc "Package to use."; default = pkgs.litestream; defaultText = literalExpression "pkgs.litestream"; type = types.package; }; settings = mkOption { - description = '' - See the <link xlink:href="https://litestream.io/reference/config/">documentation</link>. + description = lib.mdDoc '' + See the [documentation](https://litestream.io/reference/config/). ''; type = settingsFormat.type; example = { diff --git a/nixos/modules/services/network-filesystems/moosefs.nix b/nixos/modules/services/network-filesystems/moosefs.nix index 88b2ada37e75..6ad4b37761a8 100644 --- a/nixos/modules/services/network-filesystems/moosefs.nix +++ b/nixos/modules/services/network-filesystems/moosefs.nix @@ -75,14 +75,14 @@ in { masterHost = mkOption { type = types.str; default = null; - description = "IP or DNS name of master host."; + description = lib.mdDoc "IP or DNS name of master host."; }; runAsUser = mkOption { type = types.bool; default = true; example = true; - description = "Run daemons as user moosefs instead of root."; + description = lib.mdDoc "Run daemons as user moosefs instead of root."; }; client.enable = mkEnableOption "Moosefs client."; @@ -90,11 +90,11 @@ in { master = { enable = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Enable Moosefs master daemon. - You need to run <literal>mfsmaster-init</literal> on a freshly installed master server to - initialize the <literal>DATA_PATH</literal> direcory. + You need to run `mfsmaster-init` on a freshly installed master server to + initialize the `DATA_PATH` direcory. ''; default = false; }; @@ -102,7 +102,7 @@ in { exports = mkOption { type = with types; listOf str; default = null; - description = "Paths to export (see mfsexports.cfg)."; + description = lib.mdDoc "Paths to export (see mfsexports.cfg)."; example = [ "* / rw,alldirs,admin,maproot=0:0" "* . rw" @@ -111,7 +111,7 @@ in { openFirewall = mkOption { type = types.bool; - description = "Whether to automatically open the necessary ports in the firewall."; + description = lib.mdDoc "Whether to automatically open the necessary ports in the firewall."; default = false; }; @@ -122,11 +122,11 @@ in { options.DATA_PATH = mkOption { type = types.str; default = "/var/lib/mfs"; - description = "Data storage directory."; + description = lib.mdDoc "Data storage directory."; }; }; - description = "Contents of config file (mfsmaster.cfg)."; + description = lib.mdDoc "Contents of config file (mfsmaster.cfg)."; }; }; @@ -140,11 +140,11 @@ in { options.DATA_PATH = mkOption { type = types.str; default = "/var/lib/mfs"; - description = "Data storage directory"; + description = lib.mdDoc "Data storage directory"; }; }; - description = "Contents of metalogger config file (mfsmetalogger.cfg)."; + description = lib.mdDoc "Contents of metalogger config file (mfsmetalogger.cfg)."; }; }; @@ -153,14 +153,14 @@ in { openFirewall = mkOption { type = types.bool; - description = "Whether to automatically open the necessary ports in the firewall."; + description = lib.mdDoc "Whether to automatically open the necessary ports in the firewall."; default = false; }; hdds = mkOption { type = with types; listOf str; default = null; - description = "Mount points to be used by chunkserver for storage (see mfshdd.cfg)."; + description = lib.mdDoc "Mount points to be used by chunkserver for storage (see mfshdd.cfg)."; example = [ "/mnt/hdd1" ]; }; @@ -171,11 +171,11 @@ in { options.DATA_PATH = mkOption { type = types.str; default = "/var/lib/mfs"; - description = "Directory for lock file."; + description = lib.mdDoc "Directory for lock file."; }; }; - description = "Contents of chunkserver config file (mfschunkserver.cfg)."; + description = lib.mdDoc "Contents of chunkserver config file (mfschunkserver.cfg)."; }; }; }; diff --git a/nixos/modules/services/network-filesystems/netatalk.nix b/nixos/modules/services/network-filesystems/netatalk.nix index 06a36eb30c29..e870056e1d11 100644 --- a/nixos/modules/services/network-filesystems/netatalk.nix +++ b/nixos/modules/services/network-filesystems/netatalk.nix @@ -15,7 +15,7 @@ in { port = mkOption { type = types.port; default = 548; - description = "TCP port to be used for AFP."; + description = lib.mdDoc "TCP port to be used for AFP."; }; settings = mkOption { diff --git a/nixos/modules/services/network-filesystems/nfsd.nix b/nixos/modules/services/network-filesystems/nfsd.nix index 1b62bfa82035..22c7c8790c2e 100644 --- a/nixos/modules/services/network-filesystems/nfsd.nix +++ b/nixos/modules/services/network-filesystems/nfsd.nix @@ -26,7 +26,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the kernel's NFS server. ''; }; @@ -34,7 +34,7 @@ in extraNfsdConfig = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration options for the [nfsd] section of /etc/nfs.conf. ''; }; @@ -63,7 +63,7 @@ in nproc = mkOption { type = types.int; default = 8; - description = '' + description = lib.mdDoc '' Number of NFS server threads. Defaults to the recommended value of 8. ''; }; @@ -71,14 +71,14 @@ in createMountPoints = mkOption { type = types.bool; default = false; - description = "Whether to create the mount points in the exports file at startup time."; + description = lib.mdDoc "Whether to create the mount points in the exports file at startup time."; }; mountdPort = mkOption { type = types.nullOr types.int; default = null; example = 4002; - description = '' + description = lib.mdDoc '' Use fixed port for rpc.mountd, useful if server is behind firewall. ''; }; @@ -87,9 +87,9 @@ in type = types.nullOr types.int; default = null; example = 4001; - description = '' + description = lib.mdDoc '' Use a fixed port for the NFS lock manager kernel module - (<literal>lockd/nlockmgr</literal>). This is useful if the + (`lockd/nlockmgr`). This is useful if the NFS server is behind a firewall. ''; }; @@ -98,8 +98,8 @@ in type = types.nullOr types.int; default = null; example = 4000; - description = '' - Use a fixed port for <command>rpc.statd</command>. This is + description = lib.mdDoc '' + Use a fixed port for {command}`rpc.statd`. This is useful if the NFS server is behind a firewall. ''; }; diff --git a/nixos/modules/services/network-filesystems/orangefs/client.nix b/nixos/modules/services/network-filesystems/orangefs/client.nix index 36ea5af2168d..26cc0e169aec 100644 --- a/nixos/modules/services/network-filesystems/orangefs/client.nix +++ b/nixos/modules/services/network-filesystems/orangefs/client.nix @@ -15,13 +15,13 @@ in { extraOptions = mkOption { type = with types; listOf str; default = []; - description = "Extra command line options for pvfs2-client."; + description = lib.mdDoc "Extra command line options for pvfs2-client."; }; fileSystems = mkOption { - description = '' + description = lib.mdDoc '' The orangefs file systems to be mounted. - This option is prefered over using <option>fileSystems</option> directly since + This option is prefered over using {option}`fileSystems` directly since the pvfs client service needs to be running for it to be mounted. ''; @@ -36,19 +36,19 @@ in { mountPoint = mkOption { type = types.str; default = "/orangefs"; - description = "Mount point."; + description = lib.mdDoc "Mount point."; }; options = mkOption { type = with types; listOf str; default = []; - description = "Mount options"; + description = lib.mdDoc "Mount options"; }; target = mkOption { type = types.str; example = "tcp://server:3334/orangefs"; - description = "Target URL"; + description = lib.mdDoc "Target URL"; }; }; })); diff --git a/nixos/modules/services/network-filesystems/orangefs/server.nix b/nixos/modules/services/network-filesystems/orangefs/server.nix index 621c2fe8f78d..3bc3325e1864 100644 --- a/nixos/modules/services/network-filesystems/orangefs/server.nix +++ b/nixos/modules/services/network-filesystems/orangefs/server.nix @@ -79,40 +79,40 @@ in { logType = mkOption { type = with types; enum [ "file" "syslog" ]; default = "syslog"; - description = "Destination for log messages."; + description = lib.mdDoc "Destination for log messages."; }; dataStorageSpace = mkOption { type = types.nullOr types.str; default = null; example = "/data/storage"; - description = "Directory for data storage."; + description = lib.mdDoc "Directory for data storage."; }; metadataStorageSpace = mkOption { type = types.nullOr types.str; default = null; example = "/data/meta"; - description = "Directory for meta data storage."; + description = lib.mdDoc "Directory for meta data storage."; }; BMIModules = mkOption { type = with types; listOf str; default = [ "bmi_tcp" ]; example = [ "bmi_tcp" "bmi_ib"]; - description = "List of BMI modules to load."; + description = lib.mdDoc "List of BMI modules to load."; }; extraDefaults = mkOption { type = types.lines; default = ""; - description = "Extra config for <literal><Defaults></literal> section."; + description = lib.mdDoc "Extra config for `<Defaults>` section."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Extra config for the global section."; + description = lib.mdDoc "Extra config for the global section."; }; servers = mkOption { @@ -122,12 +122,12 @@ in { node1 = "tcp://node1:3334"; node2 = "tcp://node2:3334"; }; - description = "URLs for storage server including port. The attribute names define the server alias."; + description = lib.mdDoc "URLs for storage server including port. The attribute names define the server alias."; }; fileSystems = mkOption { - description = '' - These options will create the <literal><FileSystem></literal> sections of config file. + description = lib.mdDoc '' + These options will create the `<FileSystem>` sections of config file. ''; default = { orangefs = {}; }; example = literalExpression '' @@ -146,37 +146,37 @@ in { id = mkOption { type = types.int; default = 1; - description = "File system ID (must be unique within configuration)."; + description = lib.mdDoc "File system ID (must be unique within configuration)."; }; rootHandle = mkOption { type = types.int; default = 3; - description = "File system root ID."; + description = lib.mdDoc "File system root ID."; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "Extra config for <literal><FileSystem></literal> section."; + description = lib.mdDoc "Extra config for `<FileSystem>` section."; }; troveSyncMeta = mkOption { type = types.bool; default = true; - description = "Sync meta data."; + description = lib.mdDoc "Sync meta data."; }; troveSyncData = mkOption { type = types.bool; default = false; - description = "Sync data."; + description = lib.mdDoc "Sync data."; }; extraStorageHints = mkOption { type = types.lines; default = ""; - description = "Extra config for <literal><StorageHints></literal> section."; + description = lib.mdDoc "Extra config for `<StorageHints>` section."; }; }; })); diff --git a/nixos/modules/services/network-filesystems/rsyncd.nix b/nixos/modules/services/network-filesystems/rsyncd.nix index e72f9b54cd6f..ab24ebfee273 100644 --- a/nixos/modules/services/network-filesystems/rsyncd.nix +++ b/nixos/modules/services/network-filesystems/rsyncd.nix @@ -15,7 +15,7 @@ in { port = mkOption { default = 873; type = types.port; - description = "TCP port the daemon will listen on."; + description = lib.mdDoc "TCP port the daemon will listen on."; }; settings = mkOption { @@ -50,7 +50,7 @@ in { default = false; type = types.bool; description = - "If enabled Rsync will be socket-activated rather than run persistently."; + lib.mdDoc "If enabled Rsync will be socket-activated rather than run persistently."; }; }; diff --git a/nixos/modules/services/network-filesystems/samba-wsdd.nix b/nixos/modules/services/network-filesystems/samba-wsdd.nix index 800ef448d376..38980593e768 100644 --- a/nixos/modules/services/network-filesystems/samba-wsdd.nix +++ b/nixos/modules/services/network-filesystems/samba-wsdd.nix @@ -23,46 +23,46 @@ in { type = types.nullOr types.str; default = null; example = "eth0"; - description = "Interface or address to use."; + description = lib.mdDoc "Interface or address to use."; }; hoplimit = mkOption { type = types.nullOr types.int; default = null; example = 2; - description = "Hop limit for multicast packets (default = 1)."; + description = lib.mdDoc "Hop limit for multicast packets (default = 1)."; }; workgroup = mkOption { type = types.nullOr types.str; default = null; example = "HOME"; - description = "Set workgroup name (default WORKGROUP)."; + description = lib.mdDoc "Set workgroup name (default WORKGROUP)."; }; hostname = mkOption { type = types.nullOr types.str; default = null; example = "FILESERVER"; - description = "Override (NetBIOS) hostname to be used (default hostname)."; + description = lib.mdDoc "Override (NetBIOS) hostname to be used (default hostname)."; }; domain = mkOption { type = types.nullOr types.str; default = null; - description = "Set domain name (disables workgroup)."; + description = lib.mdDoc "Set domain name (disables workgroup)."; }; discovery = mkOption { type = types.bool; default = false; - description = "Enable discovery operation mode."; + description = lib.mdDoc "Enable discovery operation mode."; }; listen = mkOption { type = types.str; default = "/run/wsdd/wsdd.sock"; - description = "Listen on path or localhost port in discovery mode."; + description = lib.mdDoc "Listen on path or localhost port in discovery mode."; }; extraOptions = mkOption { type = types.listOf types.str; default = [ "--shortlog" ]; example = [ "--verbose" "--no-http" "--ipv4only" "--no-host" ]; - description = "Additional wsdd options."; + description = lib.mdDoc "Additional wsdd options."; }; }; }; diff --git a/nixos/modules/services/network-filesystems/samba.nix b/nixos/modules/services/network-filesystems/samba.nix index 992f948e8cd5..7a07b043859b 100644 --- a/nixos/modules/services/network-filesystems/samba.nix +++ b/nixos/modules/services/network-filesystems/samba.nix @@ -96,7 +96,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to automatically open the necessary ports in the firewall. ''; }; @@ -104,7 +104,7 @@ in enableNmbd = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable Samba's nmbd, which replies to NetBIOS over IP name service requests. It also participates in the browsing protocols which make up the Windows "Network Neighborhood" view. @@ -114,7 +114,7 @@ in enableWinbindd = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable Samba's winbindd, which provides a number of services to the Name Service Switch capability found in most modern C libraries, to arbitrary applications via PAM and ntlm_auth and to Samba itself. @@ -126,7 +126,7 @@ in default = pkgs.samba; defaultText = literalExpression "pkgs.samba"; example = literalExpression "pkgs.samba4Full"; - description = '' + description = lib.mdDoc '' Defines which package should be used for the samba server. ''; }; @@ -134,7 +134,7 @@ in invalidUsers = mkOption { type = types.listOf types.str; default = [ "root" ]; - description = '' + description = lib.mdDoc '' List of users who are denied to login via Samba. ''; }; @@ -142,7 +142,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Additional global section and extra section lines go in here. ''; example = '' @@ -154,7 +154,7 @@ in configText = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' Verbatim contents of smb.conf. If null (default), use the autogenerated file from NixOS instead. ''; @@ -163,13 +163,13 @@ in securityType = mkOption { type = types.str; default = "user"; - description = "Samba security type"; + description = lib.mdDoc "Samba security type"; }; nsswins = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable the WINS NSS (Name Service Switch) plug-in. Enabling it allows applications to resolve WINS/NetBIOS names (a.k.a. Windows machine names) by transparently querying the winbindd daemon. @@ -178,9 +178,9 @@ in shares = mkOption { default = {}; - description = '' + description = lib.mdDoc '' A set describing shared resources. - See <command>man smb.conf</command> for options. + See {command}`man smb.conf` for options. ''; type = types.attrsOf (types.attrsOf types.unspecified); example = literalExpression '' diff --git a/nixos/modules/services/network-filesystems/tahoe.nix b/nixos/modules/services/network-filesystems/tahoe.nix index 5426463dffac..a816b5757f72 100644 --- a/nixos/modules/services/network-filesystems/tahoe.nix +++ b/nixos/modules/services/network-filesystems/tahoe.nix @@ -12,21 +12,21 @@ in options = { nickname = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The nickname of this Tahoe introducer. ''; }; tub.port = mkOption { default = 3458; type = types.int; - description = '' + description = lib.mdDoc '' The port on which the introducer will listen. ''; }; tub.location = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The external location that the introducer should listen on. If specified, the port should be included. @@ -36,13 +36,13 @@ in default = pkgs.tahoelafs; defaultText = literalExpression "pkgs.tahoelafs"; type = types.package; - description = '' + description = lib.mdDoc '' The package to use for the Tahoe LAFS daemon. ''; }; }; }); - description = '' + description = lib.mdDoc '' The Tahoe introducers. ''; }; @@ -52,14 +52,14 @@ in options = { nickname = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The nickname of this Tahoe node. ''; }; tub.port = mkOption { default = 3457; type = types.int; - description = '' + description = lib.mdDoc '' The port on which the tub will listen. This is the correct setting to tweak if you want Tahoe's storage @@ -69,7 +69,7 @@ in tub.location = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The external location that the node should listen on. This is the setting to tweak if there are multiple interfaces @@ -81,7 +81,7 @@ in web.port = mkOption { default = 3456; type = types.int; - description = '' + description = lib.mdDoc '' The port on which the Web server will listen. This is the correct setting to tweak if you want Tahoe's WUI to @@ -91,7 +91,7 @@ in client.introducer = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The furl for a Tahoe introducer node. Like all furls, keep this safe and don't share it. @@ -100,7 +100,7 @@ in client.helper = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The furl for a Tahoe helper node. Like all furls, keep this safe and don't share it. @@ -109,14 +109,14 @@ in client.shares.needed = mkOption { default = 3; type = types.int; - description = '' + description = lib.mdDoc '' The number of shares required to reconstitute a file. ''; }; client.shares.happy = mkOption { default = 7; type = types.int; - description = '' + description = lib.mdDoc '' The number of distinct storage nodes required to store a file. ''; @@ -124,7 +124,7 @@ in client.shares.total = mkOption { default = 10; type = types.int; - description = '' + description = lib.mdDoc '' The number of shares required to store a file. ''; }; @@ -132,7 +132,7 @@ in storage.reservedSpace = mkOption { default = "1G"; type = types.str; - description = '' + description = lib.mdDoc '' The amount of filesystem space to not use for storage. ''; }; @@ -141,7 +141,7 @@ in sftpd.port = mkOption { default = null; type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' The port on which the SFTP server will listen. This is the correct setting to tweak if you want Tahoe's SFTP @@ -151,28 +151,28 @@ in sftpd.hostPublicKeyFile = mkOption { default = null; type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' Path to the SSH host public key. ''; }; sftpd.hostPrivateKeyFile = mkOption { default = null; type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' Path to the SSH host private key. ''; }; sftpd.accounts.file = mkOption { default = null; type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' Path to the accounts file. ''; }; sftpd.accounts.url = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' URL of the accounts server. ''; }; @@ -180,13 +180,13 @@ in default = pkgs.tahoelafs; defaultText = literalExpression "pkgs.tahoelafs"; type = types.package; - description = '' + description = lib.mdDoc '' The package to use for the Tahoe LAFS daemon. ''; }; }; }); - description = '' + description = lib.mdDoc '' The Tahoe nodes. ''; }; diff --git a/nixos/modules/services/network-filesystems/u9fs.nix b/nixos/modules/services/network-filesystems/u9fs.nix index 77961b78cadb..d6968b2cb826 100644 --- a/nixos/modules/services/network-filesystems/u9fs.nix +++ b/nixos/modules/services/network-filesystems/u9fs.nix @@ -14,16 +14,16 @@ in enable = mkOption { type = types.bool; default = false; - description = "Whether to run the u9fs 9P server for Unix."; + description = lib.mdDoc "Whether to run the u9fs 9P server for Unix."; }; listenStreams = mkOption { type = types.listOf types.str; default = [ "564" ]; example = [ "192.168.16.1:564" ]; - description = '' + description = lib.mdDoc '' Sockets to listen for clients on. - See <command>man 5 systemd.socket</command> for socket syntax. + See {command}`man 5 systemd.socket` for socket syntax. ''; }; @@ -31,7 +31,7 @@ in type = types.str; default = "nobody"; description = - "User to run u9fs under."; + lib.mdDoc "User to run u9fs under."; }; extraArgs = mkOption { @@ -39,9 +39,9 @@ in default = ""; example = "-a none"; description = - '' + lib.mdDoc '' Extra arguments to pass on invocation, - see <command>man 4 u9fs</command> + see {command}`man 4 u9fs` ''; }; diff --git a/nixos/modules/services/network-filesystems/webdav-server-rs.nix b/nixos/modules/services/network-filesystems/webdav-server-rs.nix index 1c5c299cb673..bd07b8d4381b 100644 --- a/nixos/modules/services/network-filesystems/webdav-server-rs.nix +++ b/nixos/modules/services/network-filesystems/webdav-server-rs.nix @@ -19,22 +19,22 @@ in user = mkOption { type = types.str; default = "webdav"; - description = "User to run under when setuid is not enabled."; + description = lib.mdDoc "User to run under when setuid is not enabled."; }; group = mkOption { type = types.str; default = "webdav"; - description = "Group to run under when setuid is not enabled."; + description = lib.mdDoc "Group to run under when setuid is not enabled."; }; settings = mkOption { type = format.type; default = { }; - description = '' + description = lib.mdDoc '' Attrset that is converted and passed as config file. Available options can be found at - <link xlink:href="https://github.com/miquels/webdav-server-rs/blob/master/webdav-server.toml">here</link>. + [here](https://github.com/miquels/webdav-server-rs/blob/master/webdav-server.toml). ''; example = literalExpression '' { @@ -73,7 +73,7 @@ in type = types.path; default = format.generate "webdav-server.toml" settings; defaultText = "Config file generated from services.webdav-server-rs.settings"; - description = '' + description = lib.mdDoc '' Path to config file. If this option is set, it will override any configuration done in services.webdav-server-rs.settings. ''; diff --git a/nixos/modules/services/network-filesystems/webdav.nix b/nixos/modules/services/network-filesystems/webdav.nix index a810af40fd47..5628fd1e6c6f 100644 --- a/nixos/modules/services/network-filesystems/webdav.nix +++ b/nixos/modules/services/network-filesystems/webdav.nix @@ -13,27 +13,27 @@ in user = mkOption { type = types.str; default = "webdav"; - description = "User account under which WebDAV runs."; + description = lib.mdDoc "User account under which WebDAV runs."; }; group = mkOption { type = types.str; default = "webdav"; - description = "Group under which WebDAV runs."; + description = lib.mdDoc "Group under which WebDAV runs."; }; settings = mkOption { type = format.type; default = { }; - description = '' + description = lib.mdDoc '' Attrset that is converted and passed as config file. Available options can be found at - <link xlink:href="https://github.com/hacdias/webdav">here</link>. + [here](https://github.com/hacdias/webdav). This program supports reading username and password configuration from environment variables, so it's strongly recommended to store username and password in a separate - <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.exec.html#EnvironmentFile=">EnvironmentFile</link>. + [EnvironmentFile](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#EnvironmentFile=). This prevents adding secrets to the world-readable Nix store. ''; example = literalExpression '' @@ -57,7 +57,7 @@ in type = types.path; default = format.generate "webdav.yaml" cfg.settings; defaultText = "Config file generated from services.webdav.settings"; - description = '' + description = lib.mdDoc '' Path to config file. If this option is set, it will override any configuration done in options.services.webdav.settings. ''; diff --git a/nixos/modules/services/network-filesystems/xtreemfs.nix b/nixos/modules/services/network-filesystems/xtreemfs.nix index fc0723115787..7b476fc7ac93 100644 --- a/nixos/modules/services/network-filesystems/xtreemfs.nix +++ b/nixos/modules/services/network-filesystems/xtreemfs.nix @@ -94,7 +94,7 @@ in homeDir = mkOption { type = types.path; default = "/var/lib/xtreemfs"; - description = '' + description = lib.mdDoc '' XtreemFS home dir for the xtreemfs user. ''; }; @@ -103,7 +103,7 @@ in enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable XtreemFS DIR service. ''; }; @@ -120,7 +120,7 @@ in port = mkOption { default = 32638; type = types.port; - description = '' + description = lib.mdDoc '' The port to listen on for incoming connections (TCP). ''; }; @@ -128,7 +128,7 @@ in type = types.str; example = "127.0.0.1"; default = ""; - description = '' + description = lib.mdDoc '' If specified, it defines the interface to listen on. If not specified, the service will listen on all interfaces (any). ''; @@ -136,7 +136,7 @@ in httpPort = mkOption { default = 30638; type = types.port; - description = '' + description = lib.mdDoc '' Specifies the listen port for the HTTP service that returns the status page. ''; @@ -145,7 +145,7 @@ in type = types.enum [ "ASYNC" "SYNC_WRITE_METADATA" "SYNC_WRITE" "FDATASYNC" "FSYNC" ]; default = "FSYNC"; example = "FDATASYNC"; - description = '' + description = lib.mdDoc '' The sync mode influences how operations are committed to the disk log before the operation is acknowledged to the caller. @@ -173,7 +173,7 @@ in ssl.trusted_certs.pw = jks_passphrase ssl.trusted_certs.container = jks ''; - description = '' + description = lib.mdDoc '' Configuration of XtreemFS DIR service. WARNING: configuration is saved as plaintext inside nix store. For more options: http://www.xtreemfs.org/xtfs-guide-1.5.1/index.html @@ -215,7 +215,7 @@ in babudb.ssl.authenticationWithoutEncryption = false ''; - description = '' + description = lib.mdDoc '' Configuration of XtreemFS DIR replication plugin. WARNING: configuration is saved as plaintext inside nix store. For more options: http://www.xtreemfs.org/xtfs-guide-1.5.1/index.html @@ -228,7 +228,7 @@ in enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable XtreemFS MRC service. ''; }; @@ -245,7 +245,7 @@ in port = mkOption { default = 32636; type = types.port; - description = '' + description = lib.mdDoc '' The port to listen on for incoming connections (TCP). ''; }; @@ -253,7 +253,7 @@ in example = "127.0.0.1"; type = types.str; default = ""; - description = '' + description = lib.mdDoc '' If specified, it defines the interface to listen on. If not specified, the service will listen on all interfaces (any). ''; @@ -261,7 +261,7 @@ in httpPort = mkOption { default = 30636; type = types.port; - description = '' + description = lib.mdDoc '' Specifies the listen port for the HTTP service that returns the status page. ''; @@ -270,7 +270,7 @@ in default = "FSYNC"; type = types.enum [ "ASYNC" "SYNC_WRITE_METADATA" "SYNC_WRITE" "FDATASYNC" "FSYNC" ]; example = "FDATASYNC"; - description = '' + description = lib.mdDoc '' The sync mode influences how operations are committed to the disk log before the operation is acknowledged to the caller. @@ -316,7 +316,7 @@ in ssl.trusted_certs.pw = jks_passphrase ssl.trusted_certs.container = jks ''; - description = '' + description = lib.mdDoc '' Configuration of XtreemFS MRC service. WARNING: configuration is saved as plaintext inside nix store. For more options: http://www.xtreemfs.org/xtfs-guide-1.5.1/index.html @@ -358,7 +358,7 @@ in babudb.ssl.authenticationWithoutEncryption = false ''; - description = '' + description = lib.mdDoc '' Configuration of XtreemFS MRC replication plugin. WARNING: configuration is saved as plaintext inside nix store. For more options: http://www.xtreemfs.org/xtfs-guide-1.5.1/index.html @@ -371,7 +371,7 @@ in enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable XtreemFS OSD service. ''; }; @@ -388,7 +388,7 @@ in port = mkOption { default = 32640; type = types.port; - description = '' + description = lib.mdDoc '' The port to listen on for incoming connections (TCP and UDP). ''; }; @@ -396,7 +396,7 @@ in example = "127.0.0.1"; type = types.str; default = ""; - description = '' + description = lib.mdDoc '' If specified, it defines the interface to listen on. If not specified, the service will listen on all interfaces (any). ''; @@ -404,7 +404,7 @@ in httpPort = mkOption { default = 30640; type = types.port; - description = '' + description = lib.mdDoc '' Specifies the listen port for the HTTP service that returns the status page. ''; @@ -435,7 +435,7 @@ in ssl.trusted_certs.pw = jks_passphrase ssl.trusted_certs.container = jks ''; - description = '' + description = lib.mdDoc '' Configuration of XtreemFS OSD service. WARNING: configuration is saved as plaintext inside nix store. For more options: http://www.xtreemfs.org/xtfs-guide-1.5.1/index.html diff --git a/nixos/modules/services/network-filesystems/yandex-disk.nix b/nixos/modules/services/network-filesystems/yandex-disk.nix index a5b1f9d4ab63..94f806a61789 100644 --- a/nixos/modules/services/network-filesystems/yandex-disk.nix +++ b/nixos/modules/services/network-filesystems/yandex-disk.nix @@ -31,7 +31,7 @@ in username = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Your yandex.com login name. ''; }; @@ -39,7 +39,7 @@ in password = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Your yandex.com password. Warning: it will be world-readable in /nix/store. ''; }; @@ -47,7 +47,7 @@ in user = mkOption { default = null; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The user the yandex-disk daemon should run as. ''; }; @@ -55,14 +55,14 @@ in directory = mkOption { type = types.path; default = "/home/Yandex.Disk"; - description = "The directory to use for Yandex.Disk storage"; + description = lib.mdDoc "The directory to use for Yandex.Disk storage"; }; excludes = mkOption { default = ""; type = types.commas; example = "data,backup"; - description = '' + description = lib.mdDoc '' Comma-separated list of directories which are excluded from synchronization. ''; }; |