nixpkgs/configuration/options.nix

202 lines
4.2 KiB
Nix
Raw Normal View History

[
{
name = ["networking" "hostname"];
default = "nixos";
description = "The name of the machine.";
}
{
name = ["boot" "autoDetectRootDevice"];
default = false;
description = "
Whether to find the root device automatically by searching for a
device with the right label. If this option is off, then
<option>boot.rootDevice</option> must be set.
";
}
{
name = ["boot" "rootDevice"];
example = "/dev/hda1";
description = "
The device to be mounted on / at system startup.
";
}
{
name = ["boot" "readOnlyRoot"];
default = false;
description = "
Whether the root device should be mounted writable. This should
be set when booting from CD-ROM.
";
}
{
name = ["boot" "rootLabel"];
description = "
When auto-detecting the root device (see
<option>boot.autoDetectRootDevice</option>), this option
specifies the label of the root device. Right now, this is
merely a file name that should exist in the root directory of
the file system. It is used to find the boot CD-ROM.
";
}
{
name = ["boot" "grubDevice"];
default = "";
example = "/dev/hda";
description = "
The device on which the boot loader, Grub, will be installed.
If empty, Grub won't be installed and it's your responsibility
to make the system bootable.
";
}
{
name = ["boot" "kernelParams"];
default = [
"selinux=0"
"apm=on"
"acpi=on"
"vga=0x317"
"console=tty1"
"splash=verbose"
];
description = "
The kernel parameters. If you want to add additional
parameters, it's best to set
<option>boot.extraKernelParams</options>.
";
}
{
name = ["boot" "extraKernelParams"];
default = [
];
example = [
"debugtrace"
];
description = "
Additional user-defined kernel parameters.
";
}
{
name = ["networking" "useDHCP"];
default = true;
description = "
Whether to use DHCP to obtain an IP adress and other
configuration for all network interfaces that are not manually
configured.
";
}
{
name = ["networking" "interfaces"];
default = [];
example = [
{ interface = "eth0";
ipAddress = "131.211.84.78";
netmask = "255.255.255.128";
gateway = "131.211.84.1";
}
];
description = "
The configuration for each network interface. If
<option>networking.useDHCP</option> is true, then each interface
not listed here will be configured using DHCP.
";
}
{
name = ["filesystems" "mountPoints"];
example = [
{ device = "/dev/hda2";
mountPoint = "/";
}
];
description = "
The file systems to be mounted by NixOS. It must include an
entry for the root directory (<literal>mountPoint =
\"/\"</literal>). This is the file system on which NixOS is (to
be) installed..
";
}
{
name = ["services" "syslogd" "tty"];
default = 10;
description = "
The tty device on which syslogd will print important log
messages.
";
}
{
name = ["services" "mingetty" "ttys"];
default = [1 2 3 4 5 6];
description = "
The list of tty (virtual console) devices on which to start a
login prompt.
";
}
{
name = ["services" "mingetty" "waitOnMounts"];
default = false;
description = "
Whether the login prompts on the virtual consoles will be
started before or after all file systems have been mounted. By
default we don't wait, but if for example your /home is on a
separate partition, you may want to turn this on.
";
}
{
name = ["services" "sshd" "enable"];
default = false;
description = "
Whether to enable the Secure Shell daemon, which allows secure
remote logins.
";
}
{
name = ["services" "sshd" "forwardX11"];
default = false;
description = "
Whether to enable sshd to forward X11 connections.
";
}
{
name = ["services" "xserver" "enable"];
default = false;
description = "
Whether to enable the X server.
";
}
]