movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-10 11:45:45 +03:00
Code Issues Projects Releases Packages Wiki Activity

nixos/virtualization: invariant option docs MD conversions

Browse source
This commit is contained in:
pennae 2022-07-20 12:32:04 +02:00
parent b115622f4b
commit 5bf55a4ad5
9 changed files with 66 additions and 66 deletions
Download patch file Download diff file Expand all files Collapse all files

12
nixos/modules/virtualisation/docker-rootless.nix
View file

@ -18,18 +18,18 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
This option enables docker in a rootless mode, a daemon that manages
linux containers. To interact with the daemon, one needs to set
<command>DOCKER_HOST=unix://$XDG_RUNTIME_DIR/docker.sock</command>.
{command}`DOCKER_HOST=unix://$XDG_RUNTIME_DIR/docker.sock`.
'';
};
setSocketVariable = mkOption {
type = types.bool;
default = false;
description = ''
Point <command>DOCKER_HOST</command> to rootless Docker instance for
description = lib.mdDoc ''
Point {command}`DOCKER_HOST` to rootless Docker instance for
normal users by default.
'';
};
@ -41,7 +41,7 @@ in
ipv6 = true;
"fixed-cidr-v6" = "fd00::/80";
};
description = ''
description = lib.mdDoc ''
Configuration for docker daemon. The attributes are serialized to JSON used as daemon.conf.
See https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file
'';
@ -51,7 +51,7 @@ in
default = pkgs.docker;
defaultText = literalExpression "pkgs.docker";
type = types.package;
description = ''
description = lib.mdDoc ''
Docker package to be used in the module.
'';
};