NixOS Manual

Eelco Dolstra

List of Examples

1.1. Commands for installing NixOS on /dev/sda
1.2. NixOS configuration
4.1. Usual configuration file

Preface

This manual describes NixOS, a Linux distribution based on the purely functional package management system Nix.

NixOS is rather bleeding edge, and this manual is correspondingly sketchy and quite possibly out of date. It gives basic information on how to get NixOS up and running, but since NixOS is very much a work in progress, you are likely to encounter problems here and there. Extensive familiarity with Linux is recommended. If you encounter problems, please report them on the nix-dev@cs.uu.nl mailing list or on irc://irc.freenode.net/#nixos.

Chapter 1. Installation

Table of Contents

1.1. Building the installation CD
1.2. Installation
1.3. Changing the configuration
1.4. Keeping NixOS up to date

1.1. Building the installation CD

Instead of building an installation CD, you could just download one from http://nixos.org/nixos/. If you want (or need) to build it yourself:

Make sure that you have a very recent pre-release version of Nix installed (http://nixos.org/releases/nix/nix-unstable/). The NixOS Nix expressions frequently use bleeding-edge features. If you get any kind of expression evaluation error, try to upgrade your Nix.
Optional but strongly recommended (and currently required for building the x86_64 ISO): subscribe/pull from the Nixpkgs channel to speed up building, i.e.,
```
$ nix-channel --add http://nixos.org/releases/nixpkgs/channels/nixpkgs-unstable
$ nix-channel --update
```
Check out NixOS from https://svn.nixos.org/repos/nix/nixos/trunk as nixos.
If you don’t already have Nixpkgs checkout, Check out Nixpkgs from https://svn.nixos.org/repos/nix/nixos/trunk as nixpkgs.
In the directory nixos, make a symbolic link pkgs to the pkgs directory of the Nixpkgs tree, e.g.,
```
$ ln -s nixpkgs/pkgs nixos/
```
Build the ISO image:
```
$ nix-build configuration/rescue-cd.nix -A rescueCD
```
If everything goes well, you’ll end up with an ISO image in ./result/iso/nixos-version-platform.iso that you can burn onto a CD or attach to a virtual CD-ROM drive in your favourite virtual machine software.

1.2. Installation

Boot from the CD.
The CD contains a basic NixOS installation. (It also contain Memtest86+, useful if you want to test new hardware.) When it’s finished booting, it should have detected most of your hardware and brought up networking (check ifconfig). Networking is necessary for the installer, since it will download lots of stuff (such as source tarballs or Nixpkgs channel binaries). It’s best if you have a DHCP server on your network. Otherwise configure manually.
The NixOS manual is available on virtual console 7 (press Alt+F7 to access).
Login as root, empty password.
The NixOS installer doesn’t do any partitioning or formatting yet, so you need to that yourself. Use the following commands:
- For partitioning: fdisk.
- For initialising Ext2/Ext3 partitions: mke2fs. Ext3 is recommended; use the -j to create a journalled file system. It is also recommended that you assign a unique symbolic label to the file system using the option -L label. This will make the file system configuration independent from device changes.
- For creating swap partitions: mkswap. Again it’s recommended to assign a label to the swap partition: -L label.
- For creating LVM volumes, the LVM commands, e.g.,
```
$ pvcreate /dev/sda1 /dev/sdb1
$ vgcreate MyVolGroup /dev/sda1 /dev/sdb1
$ lvcreate --size 2G --name bigdisk MyVolGroup 
$ lvcreate --size 1G --name smalldisk MyVolGroup
```
  Possibly you’ll need to do initctl start lvm after this (TODO: check whether this is needed).
- For creating software RAID devices: mdadm.
Mount the target file system on /mnt.
The installation is declarative; you need to write a description of the configuration that you want to be built and activated. The configuration is specified in a Nix expression and must be stored on the target file system in /mnt/etc/nixos/configuration.nix. See /etc/nixos/nixos/doc/config-examples for example machine configurations. You can copy and edit one of those (e.g., copy /etc/nixos/nixos/doc/config-examples/basic.nix to /mnt/etc/nixos/configuration.nix). See Chapter 5, List of Options for a list of the available configuration options. The text editors nano and vim are available.
In particular you need to specify a root file system in fileSystems and the target device for the Grub boot loader in boot.grubDevice.
The command nixos-hardware-scan can generate an initial configuration file for you, i.e.,
```
$ mkdir -p /mnt/etc/nixos
$ nixos-hardware-scan > /mnt/etc/nixos/configuration.nix
```
It tries to figure out the modules necessary for mounting the root device, as well as various other hardware characteristics. However, it doesn’t try to figure out the fileSystems option yet.
More examples of NixOS configurations for some actual machines can be found at https://svn.nixos.org/repos/nix/configurations/trunk/.
Note
It is very important that you specify in the option boot.initrd.extraKernelModules all kernel modules that are necessary for mounting the root file system, otherwise the installed system will not be able to boot. (If this happens, boot from CD again, mount the target file system on /mnt, fix /mnt/etc/nixos/configuration.nix and rerun nixos-install.) nixos-hardware-scan should figure out the required modules in most cases.
If your machine has a limited amount of memory, you may want to activate swap devices now (swapon device). The installer (or rather, the build actions that it may spawn) may need quite a bit of RAM, depending on your configuration.
Optionally, you can run
```
$ nixos-checkout
```
to make the installer use the latest NixOS/Nixpkgs sources from the Subversion repository, rather than the sources on CD.
Do the installation:
```
$ nixos-install
```
Cross fingers.
If everything went well:
```
$ reboot
```
You should now be able to boot into the installed NixOS. The Grub boot menu shows a list of available configurations (initially just one). Every time you change the NixOS configuration (see Section 1.3, “Changing the configuration”), a new item appears in the menu. This allows you to go back easily to another configuration if something goes wrong.
You should log in and change the root password with passwd.
You’ll probably want to create some user accounts as well, which can be done with useradd:
```
$ useradd -c 'Eelco Dolstra' -m eelco
$ passwd eelco
```
You may also want to install some software. For instance,
```
$ nix-env -qa \*
```
shows what packages are available, and
```
$ nix-env -i w3m
```
install the w3m browser.

Example 1.1, “Commands for installing NixOS on /dev/sda” shows a typical sequence of commands for installing NixOS on an empty hard drive (here /dev/sda). Example 1.2, “NixOS configuration” shows a corresponding configuration Nix expression.

Example 1.1. Commands for installing NixOS on /dev/sda

$ fdisk /dev/sda (or whatever device you want to install on)
$ mke2fs -j -L nixos /dev/sda1 (idem)
$ mkswap -L swap /dev/sda2 (idem)
$ mount LABEL=nixos /mnt
$ mkdir -p /mnt/etc/nixos
$ nixos-hardware-scan > /mnt/etc/nixos/configuration.nix
$ nano /mnt/etc/nixos/configuration.nix
(in particular, set the fileSystems and swapDevices options)
$ nixos-install
$ reboot

Example 1.2. NixOS configuration

{
  boot = {
    initrd = {
      extraKernelModules = [ "ata_piix" ];
    };
    grubDevice = "/dev/sda";
  };

  fileSystems = [
    { mountPoint = "/";
      label = "nixos";
    }
  ];

  swapDevices = [
    { label = "swap"; }
  ];
  
  services = {
    sshd = {
      enable = true;
    };
  };
}

1.3. Changing the configuration

The file /etc/nixos/configuration.nix contains the current configuration of your machine. Whenever you’ve changed something to that file, or to the NixOS/Nixpkgs sources in /etc/nixos/nixos and /etc/nixos/nixpkgs, respectively, you should do

$ nixos-rebuild switch

to build the new configuration, make it the default configuration for booting, and try to effect the configuration in the running system (e.g., by restarting system services).

You can also do

$ nixos-rebuild test

to build the configuration and switch the running system to it, but without making it the boot default. So if (say) the configuration locks up your machine, you can just reboot to get back to a working configuration.

There is also

$ nixos-rebuild boot

to build the configuration and make it the boot default, but not switch to it now (so it will only take effect after the next reboot).

Finally, you can do

$ nixos-rebuild build

to build the configuration but nothing more. This is useful to see whether everything compiles cleanly.

1.4. Keeping NixOS up to date

The currently best way to keep your NixOS installation up to date is to track the NixOS Subversion repository. You should replace the static NixOS/Nixpkgs sources installed in /etc/nixos with a Subversion checkout. The program nixos-checkout does that for you (and it also installs Subversion into your current profile).

To build the latest and greatest, do

$ svn up /etc/nixos/nixos
$ svn up /etc/nixos/nixpkgs
$ nixos-rebuild switch

(Or instead of switch, use any of the alternatives shown in Section 1.3, “Changing the configuration”.)

Chapter 2. Configuration in home directory

Table of Contents

2.1. Compiz Fusion
2.2. Pidgin-LaTeX

2.1. Compiz Fusion

Compiz Fusion is just a set of plugins fr Compiz. Your best interest is to have them found both by Compiz and by Compiz Configuration Settings (also in Compiz Fusion distribution). By default they look in Compiz installation path and in home directory. You do not need to track /nix/store manually - everything is already in /var/run/current-system/sw/share.

$HOME/.compiz/plugins should contain plugins you want to load. All the installed plugins are available in /var/run/current-system/sw/share/compiz-plugins/compiz/, so you can use symlinks to this directory.
$HOME/.compiz/metadata should contain metadata (definition of configuration options) for plugins you want to load. All the installed metadata is available in /var/run/current-system/sw/share/compiz/, so you can use symlinks to this directory.
Probably a way to load GConf configuration backend by default should be found, but if you run Compiz with GConf configuration (default for X server job for now), you have to link /var/run/current-system/sw/share/compizconfig/backends/ into $HOME/.compizconfig/backends directory.

To summarize the above, these are the commands you have to execute ln -s /var/run/current-system/sw/share/compiz/ $HOME/.compiz/metadata ln -s /var/run/current-system/sw/share/compiz-plugins/compiz/ $HOME/.compiz/plugins ln -s /var/run/current-system/sw/share/compizconfig/backends/ $HOME/.compizconfig/backends Now you can launch ccsm and configure everything. You should select GConf as a backend in the preferences menu of ccsm

2.2. Pidgin-LaTeX

To have pidgin-latex plugin working after installation, you need the following:

Symlink /var/run/current-system/sw/share/pidgin-latex/pidgin-latex.so to $HOME/.purple/plugins/pidgin-latex.so
Enable smileys. If you do not want to, you can create $HOME/.purple/smileys/empty/theme with the following contents:
```
	Name=Empty
	Description=No predefined smileys
	Author=Nobody
	
```
Enabling this theme will enable smileys, but define none.
Enable the plugin.

Chapter 3. Troubleshooting

Table of Contents

3.1. Debugging the boot process
3.2. Safe mode
3.3. Maintenance mode

3.1. Debugging the boot process

To get a Stage 1 shell (i.e., a shell in the initial ramdisk), add debug1 to the kernel command line. The shell gets started before anything useful has been done. That is, no modules have been loaded and no file systems have been mounted, except for /proc and /sys.

To get a Stage 2 shell (i.e., a shell in the actual root file system), add debug2 to the kernel command line. This shell is started right after stage 1 calls the stage 2 init script, so the root file system is there but no services have been started.

3.2. Safe mode

If the hardware autodetection (in upstart-jobs/hardware-scan) causes problems, add safemode to the kernel command line. This will disable auto-loading of modules for your PCI devices. However, you will probably need to explicitly add modules to boot.extraKernelModules to get network support etc.

3.3. Maintenance mode

You can go to maintenance mode by doing

$ shutdown now

This will eventually give you a single-user root shell. To get out of maintenance mode, do

$ initctl emit startup

Chapter 4. Development

Table of Contents

4.1. Extending NixOS
4.2. Building specific parts of NixOS
4.3. Building your own NixOS CD
4.4. Testing the installer
4.5. Testing the initrd

This chapter has some random notes on hacking on NixOS.

4.1. Extending NixOS

A unique syntax is used to express all system, hardware, computer and service configurations. This syntax helps for reading and writing new configuration files. It is coming with some extra strategies defined in NixPkgs which are used to merge and evaluate all configuration files.

A configuration file is the same as your own computer configuration.

Example 4.1. Usual configuration file

{config, modulesPath, pkgs, ...}: 

let
  inherit (pkgs.lib) mkOption mkIf mkThenElse types; 

  cfg = config.services.locate; 
  locatedb = "/var/cache/locatedb";
  logfile = "/var/log/updatedb";
  cmd = "root  updatedb --localuser=nobody --output=${locatedb} > ${logfile}";
in

{
  imports = [ 
    (modulesPath + /services/scheduling/cron.nix)
  ];

  options = { 
    services.locate = {
      enable = mkOption {
        default = false;
        example = true;
        type = types.bool;
        description = ''
          If enabled, NixOS will periodically update the database of
          files used by the locate command.
        '';
      };

      period = mkOption {
        default = "15 02 * * *";
        type = types.uniq type.string;
        description = ''
          This option defines (in the format used by cron) when the
          locate database is updated.
          The default is to update at 02:15 (at night) every day.
        '';
      };
    };
  };

  config = mkIf cfg.enable { 
    services.cron = {
      systemCronJobs = mkThenElse { 
        thenPart = "${cfg.period}  root ${cmd}";
        elsePart = "";
      };
    };
  };
}

Example 4.1, “Usual configuration file” shows the configuration file for the locate service which uses cron to update the database at some dates which can be defined by the user. This nix expression is coming from upstart-jobs/cron/locate.nix. It shows a simple example of a service that can be either distributed on many computer that are using the same configuration or to shared with the community. This file is divided in two with the interface and the implementation. Both the interface and the implementation declare a configuration set.

	This line declares the arguments of the configuration file. You can omit this line if there is no reference to `pkgs` and `config` inside the configuration file. The argument `pkgs` refers to NixPkgs and allow you to access all attributes contained inside it. In this example `pkgs` is used to retrieve common functions to ease the writing of configuration files like `mkOption`, `mkIf` and `mkThenElse`. The argument `config` corresponds to the whole NixOS configuration. This is a set which is build by merging all configuration files imported to set up the system. Thus all options declared are contained inside this variable. In this example `config` is used to retrieve the status of the `enable` flag. The important point of this argument is that it contains either the result of the merge of different settings or the default value, therefore you cannot assume that `config.services.locate.enable` is always false because it may have been defined in another configuration file.
	This line is used to import a functions that are useful for writing this configuration file.
	The variable `options` is a configuration set which is only used to declare options with the function `mkOption` imported from `pkgs/lib/default.nix`. Options may contained any attribute but only the following have a special meaning: `default`, `example`, `description`, `merge` and `apply`. The `merge` attribute is used to merge all values defined in all configuration files and this function return a value which has the same type as the default value. If the merge function is not defined, then a default function (`pkgs.lib.mergeDefaultOption`) is used to merge values. The `merge` attribute is a function which expect two arguments: the location of the option and the list of values which have to be merged. The `apply` attribute is a function used to process the option. Thus the value return by `config.option` would be the result of the `apply` function called with either the `default` value or the result of the `merge` function.
	This line is a common trick used to reduce the amount of writing. In this case `cfg` is just a sugar over `config.services.locate`
	This line is used to declare a special IF statement. If you had put a usual IF statement here, with the same condition, then you will get an infinite loop. The reason is that your condition ask for the value of the option `config.services.locate.enable` but in order to get this value you have to evaluate all configuration sets including the configuration set contained inside your file. To remove this extra complexity, `mkIf` has been introduced to get rid of possible infinite loop and to factor your writing.
	The attribute `imports` contains a list of other module location. These modules should provide option declarations for the current module in order to be evaluated safely. When a dependence on a NixOS module has to be made, then you should use the argument `modulesPath` to prefix the location of your NixOS repository.
	The attribute `config`, which should not be confused with the argument of the same name, contains a set of option definitions defined by this module. When there is neither `imports` nor `options`, then this attribute set can be return without any enclosing. This feature allow you to write your `configuration.nix` as a module which does not contains any option declarations. As `mkIf` does not need any then part or else part, then you can specify one on each option definition with the function `mkThenElse`. To avoid a lot of `mkThenElse` with empty else part, a sugar has been added to infer the corresponding empty-value of your option when the function `mkThenElse` is not used. If your then part and else part are identical, then you should use the function `mkAlways` to ignore the condition. If you need to add another condition, then you can add `mkIf` to on the appropriate location. Thus the then part will only be used if all conditions declared with `mkIf` are satisfied.

4.2. Building specific parts of NixOS

$ nix-build /etc/nixos/nixos -A attr

where attr is an attribute in /etc/nixos/nixos/default.nix. Attributes of interest include:

config: The computer configuration generated from the NIXOS_CONFIG environment variable (default is /etc/nixos/configuration.nix) with the NixOS default set of modules.
system: The derivation which build your computer system. It is built by the command nixos-rebuild build
vm: The derivation which build your computer system inside a virtual machine. It is built by the command nixos-rebuild build-vm

Most parts of NixOS can be build through the config attribute set. This attribute set allows you to have a view of the merged option definitions and all its derivations. Important derivations are store inside the option system.build and can be listed with the command nix-instantiate --xml --eval-only /etc/nixos/nixos -A config.system.build

4.3. Building your own NixOS CD

Building a NixOS CD is as easy as configuring your own computer. The idea is to use another module which will replace your configuration.nix to configure the system that would be install on the CD.

Default CD/DVD configurations are available inside nixos/modules/installer/cd-dvd. To build them you have to set NIXOS_CONFIG before running nix-build to build the ISO.

$ export NIXOS_CONFIG=/etc/nixos/nixos/modules/installer/cd-dvd/installation-cd-minimal.nix
$ nix-build /etc/nixos/nixos -A config.system.build.isoImage

Before burning your CD/DVD, you can check the content of the image by mounting anywhere like suggested by the following command:

$ mount -o loop -t iso9660 ./result/iso/cd.iso /mnt/iso

4.4. Testing the installer

Building, burning, and booting from an installation CD is rather tedious, so here is a quick way to see if the installer works properly:

$ export NIXOS_CONFIG=/etc/nixos/nixos/modules/installer/cd-dvd/installation-cd-minimal.nix
$ nix-build /etc/nixos/nixos -A config.system.build.nixosInstall
$ dd if=/dev/zero of=diskimage seek=2G count=0 bs=1
$ yes | mke2fs -j diskimage
$ mount -o loop diskimage /mnt
$ ./result/bin/nixos-install

4.5. Testing the `initrd`

A quick way to test whether the kernel and the initial ramdisk boot correctly is to use QEMU’s -kernel and -initrd options:

$ nix-build /etc/nixos/nixos -A config.system.build.initialRamdisk -o initrd
$ nix-build /etc/nixos/nixos -A config.system.build.kernel -o kernel
$ qemu-system-x86_64 -kernel ./kernel/vmlinuz -initrd ./initrd/initrd -hda /dev/null

Chapter 5. List of Options

assertions

This option allows modules to express conditions that must hold for the evaluation of the system configuration to succeed, along with associated error messages for the user.

Default: [ ]

Example: [ { assertion = false; msg = "you can't enable this for that reason"; } ]

Declared by: [ "/trace/nixos/modules/misc/assertions.nix" ]

Defined by: [ "/trace/nixos/modules/tasks/tty-backgrounds.nix" "/trace/nixos/modules/services/x11/xserver.nix" "/trace/nixos/modules/services/x11/xfs.nix" "/trace/nixos/modules/services/networking/openfire.nix" ]

boot.bootMount

If the system partition may be wiped on reinstall, it is better to have /boot on a small partition. To do it, we need to explain to GRUB where the kernels live. Specify the partition here (in GRUB notation.

Default: ""

Example: "(hd0,0)"

Declared by: [ "/trace/nixos/modules/installer/grub/grub.nix" ]

Defined by: [ ]

boot.configurationLimit

Maximum of configurations in boot menu. GRUB has problems when there are too many entries.

Default: 100

Example: 120

Declared by: [ "/trace/nixos/modules/installer/grub/grub.nix" ]

Defined by: [ ]

boot.configurationName

Grub entry name instead of default.

Default: ""

Example: "Stable 2.6.21"

Declared by: [ "/trace/nixos/modules/installer/grub/grub.nix" ]

Defined by: [ ]

boot.copyKernels

Whether the Grub menu builder should copy kernels and initial ramdisks to /boot. This is necessary when /nix is on a different file system than /boot.

Default: false

Declared by: [ "/trace/nixos/modules/installer/grub/grub.nix" ]

Defined by: [ ]

boot.extraGrubEntries

Any additional entries you want added to the Grub boot menu.

Default: ""

Example: "\n title Windows\n chainloader (hd0,1)+1\n "

Declared by: [ "/trace/nixos/modules/installer/grub/grub.nix" ]

Defined by: [ ]

boot.extraGrubEntriesBeforeNixos

Wheter extraGrubEntries are put before the Nixos-default option

Default: false

Declared by: [ "/trace/nixos/modules/installer/grub/grub.nix" ]

Defined by: [ ]

boot.extraKernelParams

Additional user-defined kernel parameters.

Default: [ ]

Example: [ "debugtrace" ]

Declared by: [ "/trace/nixos/modules/system/boot/kernel.nix" ]

Defined by: [ ]

boot.extraModulePackages

A list of additional packages supplying kernel modules.

Default: [ ]

Declared by: [ "/trace/nixos/modules/system/boot/kernel.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

boot.extraTTYs

Tty (virtual console) devices, in addition to the consoles on which mingetty and syslogd run, that must be initialised. Only useful if you have some program that you want to run on some fixed console. For example, the NixOS installation CD opens the manual in a web browser on console 7, so it sets boot.extraTTYs to [7].

Default: [ ]

Example: [ 8 9 ]

Declared by: [ "/trace/nixos/modules/tasks/kbd.nix" ]

Defined by: [ "/trace/nixos/modules/services/misc/rogue.nix" "/trace/nixos/modules/services/misc/nixos-manual.nix" ]

boot.grubDevice

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.

Default: ""

Example: "/dev/hda"

Declared by: [ "/trace/nixos/modules/installer/grub/grub.nix" ]

Defined by: [ ]

boot.grubSplashImage

Background image used for Grub. It must be a 640x480, 14-colour image in XPM format, optionally compressed with gzip or bzip2. Set to null to run Grub in text mode.

Default: (build of 36909-soft-tux.xpm.gz)

Example:

Declared by: [ "/trace/nixos/modules/installer/grub/grub.nix" ]

Defined by: [ ]

boot.hardwareScan

Whether to try to load kernel modules for all detected hardware. Usually this does a good job of providing you with the modules you need, but sometimes it can crash the system or cause other nasty effects. If the hardware scan is turned on, it can be disabled at boot time by adding the safemode parameter to the kernel command line.

Default: true

Declared by: [ "/trace/nixos/modules/services/hardware/udev.nix" ]

Defined by: [ ]

boot.initrd.allowMissing

Allow some initrd components to be missing. Useful for custom kernel that are changed too often to track needed kernelModules.

Default: false

Declared by: [ "/trace/nixos/modules/system/boot/stage-1.nix" ]

Defined by: [ ]

boot.initrd.checkJournalingFS

Whether to run fsck on journaling filesystems such as ext3.

Default: true

Declared by: [ "/trace/nixos/modules/system/boot/stage-1.nix" ]

Defined by: [ ]

boot.initrd.enableSplashScreen

Whether to show a nice splash screen while booting.

Default: true

Declared by: [ "/trace/nixos/modules/system/boot/stage-1.nix" ]

Defined by: [ ]

boot.initrd.extraKernelModules

Additional kernel modules for the initial ramdisk. These are loaded before the modules listed in boot.initrd.kernelModules, so they take precedence.

Default: [ ]

Declared by: [ "/trace/nixos/modules/system/boot/kernel.nix" ]

Defined by: [ ]

boot.initrd.extraUtilsCommands

Shell commands to be executed in the builder of the extra-utils derivation. This can be used to provide additional utilities in the initial ramdisk.

Default: ""

Declared by: [ "/trace/nixos/modules/system/boot/stage-1.nix" ]

Defined by: [ ]

boot.initrd.kernelModules

The set of kernel modules in the initial ramdisk used during the boot process. This set must include all modules necessary for mounting the root device. That is, it should include modules for the physical device (e.g., SCSI drivers) and for the file system (e.g., ext3). The set specified here is automatically closed under the module dependency relation, i.e., all dependencies of the modules list here are included automatically. If you want to add additional modules, it's best to set boot.initrd.extraKernelModules.

Default: [ "ahci" "sata_nv" "sata_via" "sata_sis" "sata_uli" "ata_piix" "pata_marvell" "sd_mod" "sr_mod" "ide_cd" "ide_disk" "ide_generic" "ext3" "ehci_hcd" "ohci_hcd" "usbhid" "dm_mod" ]

Declared by: [ "/trace/nixos/modules/system/boot/kernel.nix" ]

Defined by: [ ]

boot.initrd.lvm

Whether to include lvm in the initial ramdisk. You should use this option if your ROOT device is on lvm volume.

Default: true

Declared by: [ "/trace/nixos/modules/system/boot/stage-1.nix" ]

Defined by: [ ]

boot.initrd.postDeviceCommands

Shell commands to be executed immediately after stage 1 of the boot has loaded kernel modules and created device nodes in /dev.

Default: ""

Declared by: [ "/trace/nixos/modules/system/boot/stage-1.nix" ]

Defined by: [ ]

boot.initrd.postMountCommands

Shell commands to be executed immediately after the stage 1 filesystems have been mounted.

Default: ""

Declared by: [ "/trace/nixos/modules/system/boot/stage-1.nix" ]

Defined by: [ ]

boot.isLiveCD

If set to true, the root device will be mounted read-only and a ramdisk will be mounted on top of it using unionfs to provide a writable root. This is used for the NixOS Live-CD/DVD.

Default: false

Declared by: [ "/trace/nixos/modules/system/boot/stage-1.nix" ]

Defined by: [ ]

boot.kernelModules

The set of kernel modules to be loaded in the second stage of the boot process. That is, these modules are not included in the initial ramdisk, so they'd better not be required for mounting the root file system. Add them to boot.initrd.extraKernelModules if they are.

Default: [ ]

Declared by: [ "/trace/nixos/modules/system/boot/kernel.nix" ]

Defined by: [ "/trace/nixos/modules/hardware/pcmcia.nix" ]

boot.kernelPackages

This option allows you to override the Linux kernel used by NixOS. Since things like external kernel module packages are tied to the kernel you're using, it also overrides those. This option is a function that takes Nixpkgs as an argument (as a convenience), and returns an attribute set containing at the very least an attribute kernel. Additional attributes may be needed depending on your configuration. For instance, if you use the NVIDIA X driver, then it also needs to contain an attribute nvidia_x11.

Default: { atheros = (build of atheros-0.9.4); aufs = (build of aufs-20090414-2.6.28.10); aufs2 = (build of aufs2-a5883982f82ce927b3cbd8fc9c8d05865fc43bd9-2.6.28.10); aufs2Utils = ; exmap = (build of exmap-0.10); ext3cowtools = (build of ext3cow-tools); iwlwifi = (build of iwlwifi-1.2.25-2.6.28.10); iwlwifi4965ucode = (build of iwlwifi-4965-ucode-228.57.2.21); kernel = (build of ); kqemu = (build of kqemu-1.4.0pre1); ndiswrapper = (build of ndiswrapper-1.53-stable); nvidia_x11 = (build of nvidia-x11-185.18.36-2.6.28.10); ov511 = (build of ov511-2.30); recurseForDerivations = true; snix = (build of snix-0.12rev10946); splashutils = (build of splashutils-1.5.4.3); sysprof = (build of sysprof-1.0.10); virtualbox = (build of virtualbox-3.0.6-2.6.28.10); wis_go7007 = (build of wis-go7007-0.9.8-2.6.28.10); }

Example: { atheros = (build of atheros-0.9.4); aufs = (build of aufs-20090414-2.6.25.20); aufs2 = (build of aufs2-a5883982f82ce927b3cbd8fc9c8d05865fc43bd9-2.6.25.20); aufs2Utils = ; exmap = (build of exmap-0.10); ext3cowtools = (build of ext3cow-tools); iwlwifi = (build of iwlwifi-1.2.25-2.6.25.20); iwlwifi4965ucode = (build of iwlwifi-4965-ucode-228.57.1.21); kernel = (build of ); kqemu = (build of kqemu-1.4.0pre1); ndiswrapper = (build of ndiswrapper-1.53-stable); nvidia_x11 = (build of nvidia-x11-185.18.36-2.6.25.20); ov511 = (build of ov511-2.30); recurseForDerivations = true; snix = (build of snix-0.12rev10946); splashutils = (build of ); sysprof = (build of sysprof-1.0.10); virtualbox = (build of virtualbox-3.0.6-2.6.25.20); wis_go7007 = (build of wis-go7007-0.9.8-2.6.25.20); }

Declared by: [ "/trace/nixos/modules/system/boot/kernel.nix" ]

Defined by: [ ]

boot.kernelParams

The kernel parameters. If you want to add additional parameters, it's best to set boot.extraKernelParams.

Default: [ "apm=on" "acpi=on" "vga=0x317" "console=tty1" "splash=verbose" ]

Declared by: [ "/trace/nixos/modules/system/boot/kernel.nix" ]

Defined by: [ ]

boot.postBootCommands

Shell commands to be executed just before Upstart is started.

Default: ""

Example: "rm -f /var/log/messages"

Declared by: [ "/trace/nixos/modules/system/boot/stage-2.nix" ]

Defined by: [ ]

boot.resumeDevice

Device for manual resume attempt during boot. Looks like major:minor. ls -l /dev/SWAP_PARTION shows them.

Default: ""

Example: "0:0"

Declared by: [ "/trace/nixos/modules/system/boot/stage-1.nix" ]

Defined by: [ ]

environment.checkConfigurationOptions

Whether to check the validity of the entire configuration.

Default: true

Example: false

Declared by: [ "/trace/nixos/modules/misc/check-config.nix" ]

Defined by: [ ]

environment.etc

List of files that have to be linked in /etc.

Default: [ ]

Example: [ { mode = "0440"; source = "/nix/store/.../etc/dir/file.conf.example"; target = "dir/file.conf"; } ]

Declared by: [ "/trace/nixos/modules/system/etc/etc.nix" ]

Defined by: [ "/trace/nixos/modules/tasks/tty-backgrounds.nix" "/trace/nixos/modules/system/upstart/upstart.nix" "/trace/nixos/modules/services/x11/xserver.nix" "/trace/nixos/modules/services/x11/desktop-managers/kde4.nix" "/trace/nixos/modules/services/x11/desktop-managers/kde.nix" "/trace/nixos/modules/services/ttys/mingetty.nix" "/trace/nixos/modules/services/system/dbus.nix" "/trace/nixos/modules/services/scheduling/fcron.nix" "/trace/nixos/modules/services/scheduling/cron.nix" "/trace/nixos/modules/services/printing/cupsd.nix" "/trace/nixos/modules/services/networking/dhclient.nix" "/trace/nixos/modules/services/network-filesystems/samba.nix" "/trace/nixos/modules/services/network-filesystems/nfs-kernel.nix" "/trace/nixos/modules/services/monitoring/nagios/default.nix" "/trace/nixos/modules/services/misc/nix-daemon.nix" "/trace/nixos/modules/services/misc/autofs.nix" "/trace/nixos/modules/services/mail/postfix.nix" "/trace/nixos/modules/security/sudo.nix" "/trace/nixos/modules/security/pam.nix" "/trace/nixos/modules/security/console-kit.nix" "/trace/nixos/modules/programs/ssmtp.nix" "/trace/nixos/modules/programs/ssh.nix" "/trace/nixos/modules/programs/pwdutils/pwdutils.nix" "/trace/nixos/modules/programs/bash/bash.nix" "/trace/nixos/modules/config/unix-odbc-drivers.nix" "/trace/nixos/modules/config/nsswitch.nix" "/trace/nixos/modules/config/networking.nix" "/trace/nixos/modules/config/ldap.nix" "/trace/nixos/modules/config/fonts.nix" ]

environment.extraPackages

This option allows you to add additional packages to the system path.

Default: [ ]

Example: [ (build of firefox-3.5.3) (build of thunderbird-2.0.0.22) ]

Declared by: [ "/trace/nixos/modules/config/system-path.nix" ]

Defined by: [ "/trace/nixos/modules/services/scheduling/fcron.nix" "/trace/nixos/modules/services/scheduling/cron.nix" "/trace/nixos/modules/services/networking/avahi-daemon.nix" "/trace/nixos/modules/services/monitoring/nagios/default.nix" "/trace/nixos/modules/services/audio/pulseaudio.nix" "/trace/nixos/modules/programs/ssmtp.nix" "/trace/nixos/modules/installer/tools/nixos-checkout.nix" ]

environment.kdePackages

Additional KDE packages to be used when you use KDE as a desktop manager. By default, you only get the KDE base packages.

Default: [ ]

Example: [ (build of kdegames-4.3.1) ]

Declared by: [ "/trace/nixos/modules/services/x11/desktop-managers/kde-environment.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/desktop-managers/kde4.nix" "/trace/nixos/modules/services/x11/desktop-managers/kde.nix" ]

environment.nix

This option specifies the Nix package instance to use throughout the system.

Default: (build of nix-0.13pre16857)

Example:

Declared by: [ "/trace/nixos/modules/services/misc/nix-daemon.nix" ]

Defined by: [ ]

environment.pathsToLink

Lists directories to be symlinked in `/var/run/current-system/sw'.

Default: [ "/bin" "/sbin" "/lib" "/share/man" "/share/info" "/man" "/info" ]

Example: [ "/" ]

Declared by: [ "/trace/nixos/modules/config/system-path.nix" ]

Defined by: [ ]

environment.shellInit

Script used to initialized user shell environments.

Default: ""

Example: "export PATH=/godi/bin/:$PATH"

Declared by: [ "/trace/nixos/modules/programs/bash/bash.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/desktop-managers/kde-environment.nix" "/trace/nixos/modules/services/misc/nix-daemon.nix" "/trace/nixos/modules/programs/info.nix" "/trace/nixos/modules/config/timezone.nix" "/trace/nixos/modules/config/nsswitch.nix" "/trace/nixos/modules/config/i18n.nix" "/trace/nixos/modules/config/fonts.nix" ]

environment.systemPackages

The set of packages that appear in /var/run/current-system/sw. These packages are automatically available to all users, and are automatically updated every time you rebuild the system configuration. (The latter is the main difference with installing them in the default profile, /nix/var/nix/profiles/default.

Default: none

Declared by: [ "/trace/nixos/modules/config/system-path.nix" ]

Defined by: [ "/trace/nixos/modules/tasks/kbd.nix" "/trace/nixos/modules/tasks/filesystems.nix" "/trace/nixos/modules/services/x11/xserver.nix" "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" "/trace/nixos/modules/services/system/dbus.nix" "/trace/nixos/modules/services/scheduling/atd.nix" "/trace/nixos/modules/services/printing/cupsd.nix" "/trace/nixos/modules/services/networking/wpa_supplicant.nix" "/trace/nixos/modules/services/networking/ifplugd.nix" "/trace/nixos/modules/services/networking/firewall.nix" "/trace/nixos/modules/services/networking/dhclient.nix" "/trace/nixos/modules/services/networking/bitlbee.nix" "/trace/nixos/modules/services/misc/nixos-manual.nix" "/trace/nixos/modules/services/misc/disnix.nix" "/trace/nixos/modules/services/hardware/hal.nix" "/trace/nixos/modules/services/databases/postgresql.nix" "/trace/nixos/modules/services/databases/mysql.nix" "/trace/nixos/modules/services/audio/alsa.nix" "/trace/nixos/modules/security/sudo.nix" "/trace/nixos/modules/security/policy-kit.nix" "/trace/nixos/modules/security/pam.nix" "/trace/nixos/modules/security/console-kit.nix" "/trace/nixos/modules/programs/info.nix" "/trace/nixos/modules/misc/assertions.nix" "/trace/nixos/modules/installer/tools/tools.nix" "/trace/nixos/modules/hardware/pcmcia.nix" "/trace/nixos/modules/config/system-path.nix" "/trace/nixos/modules/config/nsswitch.nix" "/trace/nixos/modules/config/i18n.nix" "/trace/nixos/modules/config/fonts.nix" ]

environment.unixODBCDrivers

specifies unix odbc drivers to be registered at /etc/odbcinst.ini. Maybe you also want to add pkgs.unixODBC to the system path to get a command line client t connnect to odbc databases.

Default: [ ]

Example: "map (x : x.ini) (with pkgs.unixODBCDrivers; [ mysql psql psqlng ] )"

Declared by: [ "/trace/nixos/modules/config/unix-odbc-drivers.nix" ]

Defined by: [ ]

environment.x11Packages

List of packages added to the system when the X server is activated (services.xserver.enable).

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/xserver.nix" "/trace/nixos/modules/services/x11/window-managers/wmii.nix" "/trace/nixos/modules/services/x11/window-managers/twm.nix" "/trace/nixos/modules/services/x11/window-managers/metacity.nix" "/trace/nixos/modules/services/x11/window-managers/kwm.nix" "/trace/nixos/modules/services/x11/window-managers/compiz.nix" "/trace/nixos/modules/services/x11/desktop-managers/xterm.nix" "/trace/nixos/modules/services/x11/desktop-managers/kde4.nix" "/trace/nixos/modules/services/x11/desktop-managers/kde.nix" "/trace/nixos/modules/services/x11/desktop-managers/kde-environment.nix" "/trace/nixos/modules/services/x11/desktop-managers/gnome.nix" "/trace/nixos/modules/services/x11/desktop-managers/default.nix" ]

fileSystems

The file systems to be mounted. It must include an entry for the root directory (mountPoint = "/"). Each entry in the list is an attribute set with the following fields: mountPoint, device, fsType (a file system type recognised by mount; defaults to "auto"), and options (the mount options passed to mount using the -o flag; defaults to "defaults"). Instead of specifying device, you can also specify a volume label (label) for file systems that support it, such as ext2/ext3 (see mke2fs -L). autocreate forces mountPoint to be created with mkdir -p .

Default: none

Example: [ { device = "/dev/hda1"; mountPoint = "/"; } { device = "/dev/hda2"; fsType = "ext3"; mountPoint = "/data"; options = "data=journal"; } { label = "bigdisk"; mountPoint = "/bigdisk"; } ]

Declared by: [ "/trace/nixos/modules/tasks/filesystems.nix" "/trace/nixos/modules/system/boot/stage-1.nix" ]

Defined by: [ ]

fileSystems.*.autocreate

Automatically create the mount point defined in fileSystems.*.mountPoint.

Default: false

Declared by: [ "<unknow location>" ]

Defined by: [ ]

fileSystems.*.device

Location of the device.

Default:

Example: "/dev/sda"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

fileSystems.*.fsType

Type of the file system.

Default: "auto"

Example: "ext3"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

fileSystems.*.label

Label of the device (if any).

Default:

Example: "root-partition"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

fileSystems.*.mountPoint

Location of the mounted the file system.

Default: none

Example: "/mnt/usb"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

fileSystems.*.neededForBoot

Mount this file system to boot on NixOS.

Default: false

Declared by: [ "<unknow location>" ]

Defined by: [ ]

fileSystems.*.options

Option used to mount the file system.

Default: "defaults,relatime"

Example: "data=journal"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

fonts.enableCoreFonts

Whether to include Microsoft's proprietary Core Fonts. These fonts are redistributable, but only verbatim, among other restrictions. See http://corefonts.sourceforge.net/eula.htm for details.

Default: false

Declared by: [ "/trace/nixos/modules/config/fonts.nix" ]

Defined by: [ ]

fonts.enableFontConfig

If enabled, a Fontconfig configuration file will be built pointing to a set of default fonts. If you don't care about running X11 applications or any other program that uses Fontconfig, you can turn this option off and prevent a dependency on all those fonts.

Default: true

Declared by: [ "/trace/nixos/modules/config/fonts.nix" ]

Defined by: [ ]

fonts.enableFontDir

Whether to create a directory with links to all fonts in share - so user can configure vncserver script one time (I mean per-user vncserver, so global service is not a good solution).

Default: false

Declared by: [ "/trace/nixos/modules/config/fonts.nix" ]

Defined by: [ ]

fonts.enableGhostscriptFonts

Whether to add the fonts provided by Ghostscript (such as various URW fonts and the ``Base-14'' Postscript fonts) to the list of system fonts, making them available to X11 applications.

Default: false

Declared by: [ "/trace/nixos/modules/config/fonts.nix" ]

Defined by: [ ]

fonts.extraFonts

List of additional fonts.

Default: [ ]

Declared by: [ "/trace/nixos/modules/config/fonts.nix" ]

Defined by: [ ]

fonts.fonts

List of primary font paths.

Default: [ "~/.fonts" "~/.nix-profile/lib/X11/fonts" "~/.nix-profile/share/fonts" "/nix/var/nix/profiles/default/lib/X11/fonts" "/nix/var/nix/profiles/default/share/fonts" ]

Declared by: [ "/trace/nixos/modules/config/fonts.nix" ]

Defined by: [ ]

hardware.firmware

List of directories containing firmware files. Such files will be loaded automatically if the kernel asks for them (i.e., when it has detected specific hardware that requires firmware to function).

Default: [ ]

Example: [ "/root/my-firmware" ]

Declared by: [ "/trace/nixos/modules/services/hardware/udev.nix" ]

Defined by: [ "/trace/nixos/modules/system/boot/kernel.nix" "/trace/nixos/modules/hardware/network/intel-3945abg.nix" "/trace/nixos/modules/hardware/network/intel-2200bg.nix" ]

hardware.pcmcia.config

Path to the configuration file which map the memory, irq and ports used by the PCMCIA hardware.

Default:

Declared by: [ "/trace/nixos/modules/hardware/pcmcia.nix" ]

Defined by: [ ]

hardware.pcmcia.enable

Enable this option to support PCMCIA card.

Default: false

Declared by: [ "/trace/nixos/modules/hardware/pcmcia.nix" ]

Defined by: [ ]

hardware.pcmcia.firmware

List of firmware used to handle specific PCMCIA card.

Default: [ ]

Declared by: [ "/trace/nixos/modules/hardware/pcmcia.nix" ]

Defined by: [ ]

i18n.consoleFont

The font used for the virtual consoles. Leave empty to use whatever the setfont program considers the default font.

Default: "lat9w-16"

Example: "LatArCyrHeb-16"

Declared by: [ "/trace/nixos/modules/config/i18n.nix" ]

Defined by: [ ]

i18n.consoleKeyMap

The keyboard mapping table for the virtual consoles.

Default: "us"

Example: "fr"

Declared by: [ "/trace/nixos/modules/config/i18n.nix" ]

Defined by: [ ]

i18n.defaultLocale

The default locale. It determines the language for program messages, the format for dates and times, sort order, and so on. It also determines the character set, such as UTF-8.

Default: "en_US.UTF-8"

Example: "nl_NL.UTF-8"

Declared by: [ "/trace/nixos/modules/config/i18n.nix" ]

Defined by: [ ]

i18n.supportedLocales

List of locales that the system should support. The value "all" means that all locales supported by Glibc will be installed. A full list of supported locales can be found at http://sourceware.org/cgi-bin/cvsweb.cgi/libc/localedata/SUPPORTED?cvsroot=glibc.

Default: [ "all" ]

Example: [ "en_US.UTF-8/UTF-8" "nl_NL.UTF-8/UTF-8" "nl_NL/ISO-8859-1" ]

Declared by: [ "/trace/nixos/modules/config/i18n.nix" ]

Defined by: [ ]

ids.gids

The group IDs used in NixOS.

Default: none

Declared by: [ "/trace/nixos/modules/misc/ids.nix" ]

Defined by: [ "/trace/nixos/modules/misc/ids.nix" ]

ids.uids

The user IDs used in NixOS.

Default: none

Declared by: [ "/trace/nixos/modules/misc/ids.nix" ]

Defined by: [ "/trace/nixos/modules/misc/ids.nix" ]

installer.manifests

URLs of manifests to be downloaded when you run nixos-rebuild to speed up builds.

Default: [ "http://nixos.org/releases/nixpkgs/channels/nixpkgs-unstable/MANIFEST" ]

Example: [ "http://nixos.org/releases/nixpkgs/channels/nixpkgs-unstable/MANIFEST" "http://nixos.org/releases/nixpkgs/channels/nixpkgs-stable/MANIFEST" ]

Declared by: [ "/trace/nixos/modules/installer/tools/tools.nix" ]

Defined by: [ ]

installer.nixpkgsURL

URL of the Nixpkgs distribution to use when building the installation CD.

Default: ""

Example: "http://nixos.org/releases/nix/nixpkgs-0.11pre7577"

Declared by: [ "/trace/nixos/modules/installer/tools/tools.nix" ]

Defined by: [ ]

installer.repoTypes

Defines, for each supported version control system (e.g. git), the dependencies for the mechanism, as well as a test used to determine whether a directory is a checkout created by that version control system.

Default: { git = { env = [ (build of ) (build of ) (build of ) ] ; valid = "[ -d .git ]"; } ; svn = { env = [ (build of ) (build of subversion-1.6.4) ] ; valid = "[ -d .svn ]"; } ; }

Declared by: [ "/trace/nixos/modules/installer/tools/nixos-checkout.nix" ]

Defined by: [ ]

installer.repos.nixos

The NixOS repository from which the system will be built. nixos-checkout will update all working copies of the given repositories, nixos-rebuild will use the first item which has the attribute default = true falling back to the first item. The type defines the repository tool added to the path. It also defines a "valid" repository. If the target directory already exists and it's not valid it will be moved to the backup location dir-date. For svn the default target and repositories are /etc/nixos/nixos and https://svn.nixos.org/repos/nix/nixos/trunk. For git repositories update is called after initialization when the repo is initialized. The initialize code is run from working directory dirname target and should create the directory dir. For the executables used see repoTypes.

Default: [ { type = "svn"; } ]

Example: [ { target = "/etc/nixos/nixos-stdenv-updates"; type = "svn"; url = "https://svn.nixos.org/repos/nix/nixos/branches/stdenv-updates"; } { initialize = "git clone git://mawercer.de/nixos $target"; target = "/etc/nixos/nixos-git"; type = "git"; update = "git pull origin"; } ]

Declared by: [ "/trace/nixos/modules/installer/tools/nixos-checkout.nix" ]

Defined by: [ ]

installer.repos.nixpkgs

same as repos.nixos

Default: [ { type = "svn"; } ]

Declared by: [ "/trace/nixos/modules/installer/tools/nixos-checkout.nix" ]

Defined by: [ ]

jobs

This option defines the system jobs started and managed by the Upstart daemon.

Default: [ ]

Declared by: [ "/trace/nixos/modules/system/upstart/upstart.nix" ]

Defined by: [ "/trace/nixos/modules/tasks/tty-backgrounds.nix" "/trace/nixos/modules/tasks/swap.nix" "/trace/nixos/modules/tasks/network-interfaces.nix" "/trace/nixos/modules/tasks/kbd.nix" "/trace/nixos/modules/services/x11/xserver.nix" "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" "/trace/nixos/modules/services/ttys/mingetty.nix" "/trace/nixos/modules/services/system/nscd.nix" "/trace/nixos/modules/services/system/dbus.nix" "/trace/nixos/modules/services/scheduling/atd.nix" "/trace/nixos/modules/services/networking/xinetd.nix" "/trace/nixos/modules/services/networking/wpa_supplicant.nix" "/trace/nixos/modules/services/networking/ssh/sshd.nix" "/trace/nixos/modules/services/networking/ntpd.nix" "/trace/nixos/modules/services/networking/ifplugd.nix" "/trace/nixos/modules/services/networking/firewall.nix" "/trace/nixos/modules/services/networking/dhclient.nix" "/trace/nixos/modules/services/misc/nix-daemon.nix" "/trace/nixos/modules/services/hardware/udev.nix" "/trace/nixos/modules/services/hardware/hal.nix" "/trace/nixos/modules/services/databases/postgresql.nix" "/trace/nixos/modules/services/databases/mysql.nix" "/trace/nixos/modules/services/audio/alsa.nix" ]

jobs.*.buildHook

Command run while building the Upstart job. Can be used to perform simple regression tests (e.g., the Apache Upstart job uses it to check the syntax of the generated httpd.conf.

Default: "true"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

jobs.*.description

A short description of this job.

Default: "(no description given)"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

jobs.*.environment

Environment variables passed to the job's processes.

Default: { }

Example: { LANG = "nl_NL.UTF-8"; PATH = "/foo/bar/bin"; }

Declared by: [ "<unknow location>" ]

Defined by: [ ]

jobs.*.exec

Command to start the job's main process. If empty, the job has no main process, but can still have pre/post-start and pre/post-stop scripts, and is considered "running" until it is stopped.

Default: ""

Declared by: [ "<unknow location>" ]

Defined by: [ ]

jobs.*.extraConfig

Additional Upstart stanzas not otherwise supported.

Default: ""

Example: "limit nofile 4096 4096"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

jobs.*.job

Contents of the Upstart job.

Default: ""

Example: "description \"nc\"\nstart on started network-interfaces\nrespawn\nenv PATH=/var/run/current-system/sw/bin\nexec sh -c \"echo 'hello world' | /nix/store/pmay9h0796q77lskc1r2cgm0d4aiqa80-netcat-gnu-0.7.1/bin/nc -l -p 9000\"\n"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

jobs.*.name

Name of the Upstart job.

Default: none

Example: "sshd"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

jobs.*.postStop

Shell commands executed after the job has stopped (i.e. after the job's main process has terminated).

Default: ""

Declared by: [ "<unknow location>" ]

Defined by: [ ]

jobs.*.preStart

Shell commands executed before the job is started (i.e. before the job's main process is started).

Default: ""

Declared by: [ "<unknow location>" ]

Defined by: [ ]

jobs.*.respawn

Whether to restart the job automatically if its process ends unexpectedly.

Default: true

Declared by: [ "<unknow location>" ]

Defined by: [ ]

jobs.*.script

Shell commands executed as the job's main process. Can be specified instead of the exec attribute.

Default: ""

Declared by: [ "<unknow location>" ]

Defined by: [ ]

jobs.*.startOn

The Upstart event that triggers this job to be started. If empty, the job will not start automatically.

Default: ""

Declared by: [ "<unknow location>" ]

Defined by: [ ]

jobs.*.stopOn

The Upstart event that triggers this job to be stopped.

Default: "shutdown"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

jobs.*.task

Whether this job is a task rather than a service. Tasks are executed only once, while services are restarted when they exit.

Default: false

Declared by: [ "<unknow location>" ]

Defined by: [ ]

kde.extraPackages

** Obsolete ** Additional KDE packages to be used when you use KDE as a desktop manager. By default, you only get the KDE base packages.

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/x11/desktop-managers/kde-environment.nix" ]

Defined by: [ ]

nesting.children

Additional configurations to build.

Default: [ ]

Declared by: [ "/trace/nixos/modules/system/activation/top-level.nix" ]

Defined by: [ ]

networking.defaultGateway

The default gateway. It can be left empty if it is auto-detected through DHCP.

Default: ""

Example: "131.211.84.1"

Declared by: [ "/trace/nixos/modules/tasks/network-interfaces.nix" ]

Defined by: [ ]

networking.defaultMailServer.directDelivery

Use the trivial Mail Transfer Agent (MTA) ssmtp package to allow programs to send e-mail. If you don't want to run a ``real'' MTA like sendmail or postfix on your machine, set this option to true, and set the option networking.defaultMailServer.hostName to the host name of your preferred mail server.

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/programs/ssmtp.nix" ]

Defined by: [ ]

networking.defaultMailServer.domain

The domain from which mail will appear to be sent.

Default: ""

Example: "example.org"

Declared by: [ "/trace/nixos/modules/programs/ssmtp.nix" ]

Defined by: [ ]

networking.defaultMailServer.hostName

The host name of the default mail server to use to deliver e-mail.

Default: none

Example: "mail.example.org"

Declared by: [ "/trace/nixos/modules/programs/ssmtp.nix" ]

Defined by: [ ]

networking.defaultMailServer.useSTARTTLS

Whether the STARTTLS should be used to connect to the default mail server. (This is needed for TLS-capable mail servers running on the default SMTP port 25.)

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/programs/ssmtp.nix" ]

Defined by: [ ]

networking.defaultMailServer.useTLS

Whether TLS should be used to connect to the default mail server.

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/programs/ssmtp.nix" ]

Defined by: [ ]

networking.domain

The domain. It can be left empty if it is auto-detected through DHCP.

Default: ""

Example: "home"

Declared by: [ "/trace/nixos/modules/tasks/network-interfaces.nix" ]

Defined by: [ ]

networking.enableIntel2200BGFirmware

Turn on this option if you want firmware for the Intel PRO/Wireless 2200BG to be loaded automatically. This is required if you want to use this device. Intel requires you to accept the license for this firmware, see http://ipw2200.sourceforge.net/firmware.php?fid=7.

Default: false

Declared by: [ "/trace/nixos/modules/hardware/network/intel-2200bg.nix" ]

Defined by: [ ]

networking.enableIntel3945ABGFirmware

This option enables automatic loading of the firmware for the Intel PRO/Wireless 3945ABG.

Default: false

Declared by: [ "/trace/nixos/modules/hardware/network/intel-3945abg.nix" ]

Defined by: [ ]

networking.enableWLAN

Whether to start wpa_supplicant to scan for and associate with wireless networks. Note: NixOS currently does not generate wpa_supplicant's configuration file, /etc/wpa_supplicant.conf. You should edit this file yourself to define wireless networks, WPA keys and so on (see wpa_supplicant.conf(5)).

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/wpa_supplicant.nix" ]

Defined by: [ ]

networking.extraHosts

Additional entries to be appended to /etc/hosts.

Default: ""

Example: "192.168.0.1 lanlocalhost"

Declared by: [ "/trace/nixos/modules/config/networking.nix" ]

Defined by: [ ]

networking.firewall.allowedTCPPorts

List of TCP ports on which incoming connections are accepted.

Default: [ ]

Example: [ 22 80 ]

Declared by: [ "/trace/nixos/modules/services/networking/firewall.nix" ]

Defined by: [ "/trace/nixos/modules/services/networking/ssh/sshd.nix" ]

networking.firewall.enable

Whether to enable the firewall.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/firewall.nix" ]

Defined by: [ ]

networking.hostName

The name of the machine. Leave it empty if you want to obtain it from a DHCP server (if using DHCP).

Default: "nixos"

Declared by: [ "/trace/nixos/modules/tasks/network-interfaces.nix" ]

Defined by: [ ]

networking.interfaceMonitor.beep

If true, beep when an Ethernet cable is plugged in or unplugged.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/ifplugd.nix" ]

Defined by: [ ]

networking.interfaceMonitor.enable

If true, monitor Ethernet interfaces for cables being plugged in or unplugged. When this occurs, the dhclient service is restarted to automatically obtain a new IP address. This is useful for roaming users (laptops).

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/ifplugd.nix" ]

Defined by: [ ]

networking.interfaces

The configuration for each network interface. If networking.useDHCP is true, then every interface not listed here will be configured using DHCP.

Default: [ ]

Example: [ { ipAddress = "131.211.84.78"; name = "eth0"; subnetMask = "255.255.255.128"; } ]

Declared by: [ "/trace/nixos/modules/tasks/network-interfaces.nix" ]

Defined by: [ ]

networking.interfaces.*.ipAddress

IP address of the interface. Leave empty to configure the interface using DHCP.

Default: ""

Example: "10.0.0.1"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

networking.interfaces.*.name

Name of the interface.

Default: none

Example: "eth0"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

networking.interfaces.*.subnetMask

Subnet mask of the interface. Leave empty to use the default subnet mask.

Default: ""

Example: "255.255.255.0"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

networking.localCommands

Shell commands to be executed at the end of the network-interfaces Upstart job. Note that if you are using DHCP to obtain the network configuration, interfaces may not be fully configured yet.

Default: ""

Example: "text=anything; echo You can put $text here."

Declared by: [ "/trace/nixos/modules/tasks/network-interfaces.nix" ]

Defined by: [ ]

networking.nameservers

The list of nameservers. It can be left empty if it is auto-detected through DHCP.

Default: [ ]

Example: [ "130.161.158.4" "130.161.33.17" ]

Declared by: [ "/trace/nixos/modules/tasks/network-interfaces.nix" ]

Defined by: [ ]

networking.nativeIPv6

Whether to use IPv6 even though gw6c is not used. For example, for Postfix.

Default: false

Declared by: [ "/trace/nixos/modules/tasks/network-interfaces.nix" ]

Defined by: [ ]

networking.useDHCP

Whether to use DHCP to obtain an IP adress and other configuration for all network interfaces that are not manually configured.

Default: true

Declared by: [ "/trace/nixos/modules/services/networking/dhclient.nix" ]

Defined by: [ ]

nix.buildMachines

This option lists the machines to be used if distributed builds are enabled (see nix.distributedBuilds). Nix will perform derivations on those machines via SSh by copying the inputs to the Nix store on the remote machine, starting the build, then copying the output back to the local Nix store. Each element of the list should be an attribute set containing the machine's host name (hostname), the user name to be used for the SSH connection (sshUser), the Nix system type (system, e.g., "i686-linux"), the maximum number of jobs to be run in parallel on that machine (maxJobs), and the path to the SSH private key to be used to connect (sshKey). The SSH private key should not have a passphrase, and the corresponding public key should be added to ~sshUser/authorized_keys on the remote machine.

Default: none

Example: [ { hostName = "voila.labs.cs.uu.nl"; maxJobs = 1; sshKey = "/root/.ssh/id_buildfarm"; sshUser = "nix"; system = "powerpc-darwin"; } { hostName = "linux64.example.org"; maxJobs = 2; sshKey = "/root/.ssh/id_buildfarm"; sshUser = "buildfarm"; system = "x86_64-linux"; } ]

Declared by: [ "/trace/nixos/modules/services/misc/nix-daemon.nix" ]

Defined by: [ ]

nix.daemonNiceLevel

Nix daemon process priority. This priority propagates to build processes. 0 is the default Unix process priority, 20 is the lowest.

Default: 2

Declared by: [ "/trace/nixos/modules/services/misc/nix-daemon.nix" ]

Defined by: [ ]

nix.distributedBuilds

Whether to distribute builds to the machines listed in nix.buildMachines.

Default: false

Declared by: [ "/trace/nixos/modules/services/misc/nix-daemon.nix" ]

Defined by: [ ]

nix.envVars

Define the environment variables used by nix to

Default: ""

Declared by: [ "/trace/nixos/modules/services/misc/nix-daemon.nix" ]

Defined by: [ ]

nix.extraOptions

This option allows to append lines to nix.conf.

Default: ""

Example: "\n gc-keep-outputs = true\n gc-keep-derivations = true\n "

Declared by: [ "/trace/nixos/modules/services/misc/nix-daemon.nix" ]

Defined by: [ ]

nix.maxJobs

This option defines the maximum number of jobs that Nix will try to build in parallel. The default is 1. You should generally set it to the number of CPUs in your system (e.g., 2 on a Athlon 64 X2).

Default: 1

Example: 2

Declared by: [ "/trace/nixos/modules/services/misc/nix-daemon.nix" ]

Defined by: [ ]

nix.proxy

This option specifies the proxy to use for fetchurl. The real effect is just exporting http_proxy, https_proxy and ftp_proxy with that value.

Default: ""

Example: "http://127.0.0.1:3128"

Declared by: [ "/trace/nixos/modules/services/misc/nix-daemon.nix" ]

Defined by: [ ]

nix.useChroot

If set, Nix will perform builds in a chroot-environment that it will set up automatically for each build. This prevents impurities in builds by disallowing access to dependencies outside of the Nix store.

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/services/misc/nix-daemon.nix" ]

Defined by: [ ]

nixpkgs.config

The configuration of the Nix Packages collection.

Default: { }

Example: { firefox = { enableGeckoMediaPlayer = true; } ; }

Declared by: [ "/trace/nixos/modules/misc/nixpkgs.nix" ]

Defined by: [ ]

passthru

This attribute set will be exported as a system attribute. You can put whatever you want here.

Default: none

Declared by: [ "/trace/nixos/modules/misc/passthru.nix" ]

Defined by: [ ]

powerManagement.enable

Whether to enable power management (ACPI daemon)

Default: false

Declared by: [ "/trace/nixos/modules/services/hardware/acpid.nix" ]

Defined by: [ ]

requiredTTYs

FIXME: find another place for this option. FIXME: find a good description.

Default: [ ]

Declared by: [ "/trace/nixos/modules/tasks/kbd.nix" ]

Defined by: [ "/trace/nixos/modules/tasks/kbd.nix" ]

security.extraSetuidPrograms

This option lists additional programs that must be made setuid root.

Default: [ ]

Example: [ "fusermount" ]

Declared by: [ "/trace/nixos/modules/security/setuid-wrappers.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/desktop-managers/kde.nix" "/trace/nixos/modules/security/sudo.nix" ]

security.pam.services

This option defines the PAM services. A service typically corresponds to a program that uses PAM, e.g. login or passwd. Each element of this list is an attribute set describing a service. The attribute name specifies the name of the service. The attribute rootOK specifies whether the root user is allowed to use this service without authentication. The attribute ownDevices specifies whether ConsoleKit's PAM connector module should be used to give the user ownership of devices such as audio and CD-ROM drives. The attribute forwardXAuth specifies whether X authentication keys should be passed from the calling user to the target user (e.g. for su).

Default: [ ]

Example: [ { name = "chsh"; rootOK = true; } ]

Declared by: [ "/trace/nixos/modules/security/pam.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/display-managers/slim.nix" "/trace/nixos/modules/services/x11/display-managers/kdm.nix" "/trace/nixos/modules/services/scheduling/atd.nix" "/trace/nixos/modules/services/mail/dovecot.nix" "/trace/nixos/modules/security/sudo.nix" "/trace/nixos/modules/security/policy-kit.nix" "/trace/nixos/modules/security/pam.nix" ]

security.seccureKeys.private

Private key. Make it string argument, so it is not copied into store.

Default: "/var/elliptic-keys/private"

Declared by: [ "/trace/nixos/modules/services/networking/gw6c.nix" ]

Defined by: [ ]

security.seccureKeys.public

Public key. Make it path argument, so it is copied into store and hashed. The key is used to encrypt Gateway 6 configuration in store, as it contains a password for external service. Unfortunately, derivation file should be protected by other means. For example, nix-http-export.cgi will happily export any non-derivation path, but not a derivation.

Default:

Declared by: [ "/trace/nixos/modules/services/networking/gw6c.nix" ]

Defined by: [ ]

security.setuidOwners

This option allows the ownership and permissions on the setuid wrappers for specific programs to be overriden from the default (setuid root, but not setgid root).

Default: [ ]

Example: [ { group = "postdrop"; owner = "nobody"; program = "sendmail"; setgid = true; setuid = false; } ]

Declared by: [ "/trace/nixos/modules/security/setuid-wrappers.nix" ]

Defined by: [ "/trace/nixos/modules/services/system/dbus.nix" "/trace/nixos/modules/services/scheduling/atd.nix" ]

security.setuidPrograms

Only the programs from system path listed here will be made setuid root (through a wrapper program).

Default: [ ]

Declared by: [ "/trace/nixos/modules/security/setuid-wrappers.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/desktop-managers/kde4.nix" "/trace/nixos/modules/security/setuid-wrappers.nix" "/trace/nixos/modules/security/policy-kit.nix" ]

security.sudo.configFile

This string contains the contents of the sudoers file.

Default: "# WARNING: do not edit this file directly or with \"visudo\". Instead,\n# edit the source file in /etc/nixos/nixos/etc/sudoers.\n\n# \"root\" is allowed to do anything.\nroot ALL=(ALL) SETENV: ALL\n\n# Users in the \"wheel\" group can do anything.\n%wheel ALL=(ALL) SETENV: ALL\n"

Declared by: [ "/trace/nixos/modules/security/sudo.nix" ]

Defined by: [ ]

security.sudo.enable

Whether to enable the sudo command, which allows non-root users to execute commands as root.

Default: true

Declared by: [ "/trace/nixos/modules/security/sudo.nix" ]

Defined by: [ ]

security.wrapperDir

This option defines the path to the setuid wrappers. It should generally not be overriden.

Default: "/var/setuid-wrappers"

Declared by: [ "/trace/nixos/modules/security/setuid-wrappers.nix" ]

Defined by: [ ]

services.atd.allowEveryone

Whether to make /var/spool/at{jobs,spool} writeable by everyone (and sticky). This is normally not needed since the `at' commands are setuid/setgid `atd'.

Default: false

Declared by: [ "/trace/nixos/modules/services/scheduling/atd.nix" ]

Defined by: [ ]

services.atd.enable

Whether to enable the `at' daemon, a command scheduler.

Default: true

Declared by: [ "/trace/nixos/modules/services/scheduling/atd.nix" ]

Defined by: [ ]

services.autofs.autoMaster

file contents of /etc/auto.master. See man auto.master see man auto.master and man 5 autofs

Default: none

Example: "autoMaster = let\n mapConf = pkgs.writeText \"auto\" ''\n kernel -ro,soft,intr ftp.kernel.org:/pub/linux\n boot -fstype=ext2 :/dev/hda1\n windoze -fstype=smbfs ://windoze/c\n removable -fstype=ext2 :/dev/hdd\n cd -fstype=iso9660,ro :/dev/hdc\n floppy -fstype=auto :/dev/fd0\n server -rw,hard,intr / -ro myserver.me.org:/ \\\n /usr myserver.me.org:/usr \\\n /home myserver.me.org:/home\n '';\nin ''\n /auto file:${mapConf}\n''\n"

Declared by: [ "/trace/nixos/modules/services/misc/autofs.nix" ]

Defined by: [ ]

services.autofs.debug

pass -d to automount and write log to /var/log/autofs

Default: false

Declared by: [ "/trace/nixos/modules/services/misc/autofs.nix" ]

Defined by: [ ]

services.autofs.enable

automatically mount and unmount filesystems

Default: false

Declared by: [ "/trace/nixos/modules/services/misc/autofs.nix" ]

Defined by: [ ]

services.autofs.timeout

Set the global minimum timeout, in seconds, until directories are unmounted

Default: 600

Declared by: [ "/trace/nixos/modules/services/misc/autofs.nix" ]

Defined by: [ ]

services.avahi.browseDomains

List of non-local DNS domains to be browsed.

Default: [ "0pointer.de" "zeroconf.org" ]

Declared by: [ "/trace/nixos/modules/services/networking/avahi-daemon.nix" ]

Defined by: [ ]

services.avahi.enable

Whether to run the Avahi daemon, which allows Avahi clients to use Avahi's service discovery facilities and also allows the local machine to advertise its presence and services (through the mDNS responder implemented by `avahi-daemon').

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/avahi-daemon.nix" ]

Defined by: [ ]

services.avahi.hostName

Host name advertised on the LAN.

Default: "nixos"

Declared by: [ "/trace/nixos/modules/services/networking/avahi-daemon.nix" ]

Defined by: [ ]

services.avahi.ipv4

Whether to use IPv4

Default: true

Declared by: [ "/trace/nixos/modules/services/networking/avahi-daemon.nix" ]

Defined by: [ ]

services.avahi.ipv6

Whether to use IPv6

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/avahi-daemon.nix" ]

Defined by: [ ]

services.avahi.nssmdns

Whether to enable the mDNS NSS (Name Service Switch) plug-in. Enabling it allows applications to resolve names in the `.local' domain by transparently querying the Avahi daemon. Warning: Currently, enabling this option breaks DNS lookups after a `nixos-rebuild'. This is because `/etc/nsswitch.conf' is updated to use `nss-mdns' but `libnss_mdns' is not in applications' `LD_LIBRARY_PATH'. The next time `/etc/profile' is sourced, it will set up an appropriate `LD_LIBRARY_PATH', though.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/avahi-daemon.nix" ]

Defined by: [ ]

services.avahi.publishing

Whether to allow publishing.

Default: true

Declared by: [ "/trace/nixos/modules/services/networking/avahi-daemon.nix" ]

Defined by: [ ]

services.avahi.wideArea

Whether to enable wide-area service discovery.

Default: true

Declared by: [ "/trace/nixos/modules/services/networking/avahi-daemon.nix" ]

Defined by: [ ]

services.bind.blockedNetworks

What networks are just blocked.

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/networking/bind.nix" ]

Defined by: [ ]

services.bind.cacheNetworks

What networks are allowed to use us as a resolver.

Default: [ "127.0.0.0/24" ]

Declared by: [ "/trace/nixos/modules/services/networking/bind.nix" ]

Defined by: [ ]

services.bind.enable

Whether to enable BIND domain name server.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/bind.nix" ]

Defined by: [ ]

services.bind.zones

List of zones we claim authority over. master=false means slave server; slaves means addresses who may request zone transfer.

Default: [ ]

Example: [ { file = "/var/dns/example.com"; master = false; masters = [ "192.168.0.1" ] ; name = "example.com"; slaves = [ ] ; } ]

Declared by: [ "/trace/nixos/modules/services/networking/bind.nix" ]

Defined by: [ ]

services.bitlbee.enable

Whether to run the BitlBee IRC to other chat network gateway. Running it allows you to access the MSN, Jabber, Yahoo! and ICQ chat networks via an IRC client.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/bitlbee.nix" ]

Defined by: [ ]

services.bitlbee.interface

The interface the BitlBee deamon will be listening to. If `127.0.0.1', only clients on the local host can connect to it; if `0.0.0.0', clients can access it from any network interface.

Default: "127.0.0.1"

Declared by: [ "/trace/nixos/modules/services/networking/bitlbee.nix" ]

Defined by: [ ]

services.bitlbee.portNumber

Number of the port BitlBee will be listening to.

Default: 6667

Declared by: [ "/trace/nixos/modules/services/networking/bitlbee.nix" ]

Defined by: [ ]

services.cron.mailto

The job output will be mailed to this email address.

Default: ""

Declared by: [ "/trace/nixos/modules/services/scheduling/cron.nix" ]

Defined by: [ ]

services.cron.systemCronJobs

A list of Cron jobs to be appended to the system-wide crontab. See the manual page for crontab for the expected format. If you want to get the results mailed you must setuid sendmail. See security.setuidOwners If neither /var/cron/cron.deny nor /var/cron/cron.allow exist only root will is allowed to have its own crontab file. The /var/cron/cron.deny file is created automatically for you. So every user can use a crontab.

Default: [ ]

Example: [ "* * * * * test ls -l / > /tmp/cronout 2>&1" "* * * * * eelco echo Hello World > /home/eelco/cronout" ]

Declared by: [ "/trace/nixos/modules/services/scheduling/cron.nix" ]

Defined by: [ "/trace/nixos/modules/misc/locate.nix" ]

services.dbus.enable

Whether to start the D-Bus message bus daemon, which is required by many other system services and applications.

Default: true

Declared by: [ "/trace/nixos/modules/services/system/dbus.nix" ]

Defined by: [ "/trace/nixos/modules/services/networking/avahi-daemon.nix" "/trace/nixos/modules/services/misc/disnix.nix" "/trace/nixos/modules/services/hardware/hal.nix" ]

services.dbus.packages

Packages whose D-Bus configuration files should be included in the configuration of the D-Bus system-wide message bus. Specifically, every file in pkg/etc/dbus-1/system.d is included.

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/system/dbus.nix" ]

Defined by: [ "/trace/nixos/modules/services/networking/avahi-daemon.nix" "/trace/nixos/modules/services/misc/disnix.nix" "/trace/nixos/modules/services/hardware/hal.nix" "/trace/nixos/modules/security/policy-kit.nix" "/trace/nixos/modules/security/console-kit.nix" ]

services.dhcpd.configFile

The path of the DHCP server configuration file. If no file is specified, a file is generated using the other options.

Default:

Declared by: [ "/trace/nixos/modules/services/networking/dhcpd.nix" ]

Defined by: [ ]

services.dhcpd.enable

Whether to enable the DHCP server.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/dhcpd.nix" ]

Defined by: [ ]

services.dhcpd.extraConfig

Extra text to be appended to the DHCP server configuration file. Currently, you almost certainly need to specify something here, such as the options specifying the subnet mask, DNS servers, etc.

Default: ""

Example: "\n option subnet-mask 255.255.255.0;\n option broadcast-address 192.168.1.255;\n option routers 192.168.1.5;\n option domain-name-servers 130.161.158.4, 130.161.33.17, 130.161.180.1;\n option domain-name \"example.org\";\n subnet 192.168.1.0 netmask 255.255.255.0 {\n range 192.168.1.100 192.168.1.200;\n }\n "

Declared by: [ "/trace/nixos/modules/services/networking/dhcpd.nix" ]

Defined by: [ ]

services.dhcpd.interfaces

The interfaces on which the DHCP server should listen.

Default: [ "eth0" ]

Declared by: [ "/trace/nixos/modules/services/networking/dhcpd.nix" ]

Defined by: [ ]

services.dhcpd.machines

A list mapping ethernet addresses to IP addresses for the DHCP server.

Default: [ ]

Example: [ { ethernetAddress = "00:16:76:9a:32:1d"; hostName = "foo"; ipAddress = "192.168.1.10"; } { ethernetAddress = "00:19:d1:1d:c4:9a"; hostName = "bar"; ipAddress = "192.168.1.11"; } ]

Declared by: [ "/trace/nixos/modules/services/networking/dhcpd.nix" ]

Defined by: [ ]

services.disnix.enable

Whether to enable Disnix

Default: false

Declared by: [ "/trace/nixos/modules/services/misc/disnix.nix" ]

Defined by: [ ]

services.dovecot.enable

Whether to enable the Dovecot POP3/IMAP server.

Default: false

Declared by: [ "/trace/nixos/modules/services/mail/dovecot.nix" ]

Defined by: [ ]

services.dovecot.group

Dovecot group name.

Default: "dovecot"

Declared by: [ "/trace/nixos/modules/services/mail/dovecot.nix" ]

Defined by: [ ]

services.dovecot.sslCACert

CA certificate used by the server certificate.

Default: ""

Declared by: [ "/trace/nixos/modules/services/mail/dovecot.nix" ]

Defined by: [ ]

services.dovecot.sslServerCert

Server certificate

Default: ""

Declared by: [ "/trace/nixos/modules/services/mail/dovecot.nix" ]

Defined by: [ ]

services.dovecot.sslServerKey

Server key.

Default: ""

Declared by: [ "/trace/nixos/modules/services/mail/dovecot.nix" ]

Defined by: [ ]

services.dovecot.user

Dovecot user name.

Default: "dovecot"

Declared by: [ "/trace/nixos/modules/services/mail/dovecot.nix" ]

Defined by: [ ]

services.ejabberd.confDir

Location of the config directory of ejabberd

Default: "/var/ejabberd"

Declared by: [ "/trace/nixos/modules/services/networking/ejabberd.nix" ]

Defined by: [ ]

services.ejabberd.enable

Whether to enable ejabberd server

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/ejabberd.nix" ]

Defined by: [ ]

services.ejabberd.logsDir

Location of the logfile directory of ejabberd

Default: "/var/log/ejabberd"

Declared by: [ "/trace/nixos/modules/services/networking/ejabberd.nix" ]

Defined by: [ ]

services.ejabberd.spoolDir

Location of the spooldir of ejabberd

Default: "/var/lib/ejabberd"

Declared by: [ "/trace/nixos/modules/services/networking/ejabberd.nix" ]

Defined by: [ ]

services.ejabberd.virtualHosts

Virtualhosts that ejabberd should host. Hostnames are surrounded with doublequotes and separated by commas

Default: "\"localhost\""

Declared by: [ "/trace/nixos/modules/services/networking/ejabberd.nix" ]

Defined by: [ ]

services.extraJobs

Obsolete - don't use.

Default: [ ]

Declared by: [ "/trace/nixos/modules/system/upstart/upstart.nix" ]

Defined by: [ "/trace/nixos/modules/tasks/swraid.nix" "/trace/nixos/modules/tasks/lvm.nix" "/trace/nixos/modules/tasks/filesystems.nix" "/trace/nixos/modules/system/upstart-events/maintenance-shell.nix" "/trace/nixos/modules/system/upstart-events/halt.nix" "/trace/nixos/modules/system/upstart-events/ctrl-alt-delete.nix" "/trace/nixos/modules/services/x11/xfs.nix" "/trace/nixos/modules/services/web-servers/tomcat.nix" "/trace/nixos/modules/services/web-servers/jboss.nix" "/trace/nixos/modules/services/ttys/gpm.nix" "/trace/nixos/modules/services/scheduling/fcron.nix" "/trace/nixos/modules/services/scheduling/cron.nix" "/trace/nixos/modules/services/printing/cupsd.nix" "/trace/nixos/modules/services/networking/vsftpd.nix" "/trace/nixos/modules/services/networking/ssh/lshd.nix" "/trace/nixos/modules/services/networking/portmap.nix" "/trace/nixos/modules/services/networking/openvpn.nix" "/trace/nixos/modules/services/networking/openfire.nix" "/trace/nixos/modules/services/networking/ircd-hybrid.nix" "/trace/nixos/modules/services/networking/gw6c.nix" "/trace/nixos/modules/services/networking/gnunet.nix" "/trace/nixos/modules/services/networking/ejabberd.nix" "/trace/nixos/modules/services/networking/dhcpd.nix" "/trace/nixos/modules/services/networking/bitlbee.nix" "/trace/nixos/modules/services/networking/bind.nix" "/trace/nixos/modules/services/networking/avahi-daemon.nix" "/trace/nixos/modules/services/network-filesystems/samba.nix" "/trace/nixos/modules/services/network-filesystems/nfs-kernel.nix" "/trace/nixos/modules/services/monitoring/zabbix-server.nix" "/trace/nixos/modules/services/monitoring/zabbix-agent.nix" "/trace/nixos/modules/services/monitoring/nagios/default.nix" "/trace/nixos/modules/services/misc/synergy.nix" "/trace/nixos/modules/services/misc/rogue.nix" "/trace/nixos/modules/services/misc/nixos-manual.nix" "/trace/nixos/modules/services/misc/gpsd.nix" "/trace/nixos/modules/services/misc/disnix.nix" "/trace/nixos/modules/services/misc/autofs.nix" "/trace/nixos/modules/services/mail/postfix.nix" "/trace/nixos/modules/services/mail/dovecot.nix" "/trace/nixos/modules/services/logging/syslogd.nix" "/trace/nixos/modules/services/logging/klogd.nix" "/trace/nixos/modules/services/hardware/acpid.nix" "/trace/nixos/modules/services/audio/pulseaudio.nix" ]

services.fcron.allow

Users allowed to use fcrontab and fcrondyn (one name per line, special name "all" acts for everyone) nix adds username "root" for you.

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/scheduling/fcron.nix" ]

Defined by: [ ]

services.fcron.deny

same as allow but deny

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/scheduling/fcron.nix" ]

Defined by: [ ]

services.fcron.enable

Whether to enable the `fcron' daemon. From its docs: "fcron does both the job of Vixie Cron and anacron, but does even more and better". It can trigger actions even if the event has passed due to shutdown for example. TODO: add supoprt for fcron.allow and fcron.deny Of course on cron daemon is enough.. So if fcron works fine there should be a system option systemCron="fcron or cron" There are (or have been) some security issues. I haven't yet checked wether they have been resolved. For now you should trust the users registering crontab files. I think gentoo has them listed.

Default: false

Declared by: [ "/trace/nixos/modules/services/scheduling/fcron.nix" ]

Defined by: [ ]

services.fcron.maxSerialJobs

maximum number of serial jobs which can run simultaneously (-m)

Default: 1

Declared by: [ "/trace/nixos/modules/services/scheduling/fcron.nix" ]

Defined by: [ ]

services.fcron.queuelen

number of jobs the serial queue and the lavg queue can contain - empty to net set this number (-q)

Default: ""

Declared by: [ "/trace/nixos/modules/services/scheduling/fcron.nix" ]

Defined by: [ ]

services.fcron.systab

The "system" crontab contents..

Default: ""

Declared by: [ "/trace/nixos/modules/services/scheduling/fcron.nix" ]

Defined by: [ ]

services.gnunet.applications

List of GNUnet applications supported by the daemon. Note that `fs', which means "file sharing", is probably the one you want.

Default: [ "advertising" "getoption" "fs" "stats" "traffic" ]

Example: [ "chat" "fs" ]

Declared by: [ "/trace/nixos/modules/services/networking/gnunet.nix" ]

Defined by: [ ]

services.gnunet.debug

When true, run in debug mode; gnunetd will not daemonize and error messages will be written to stderr instead of a logfile.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/gnunet.nix" ]

Defined by: [ ]

services.gnunet.enable

Whether to run the GNUnet daemon. GNUnet is GNU's anonymous peer-to-peer communication and file sharing framework.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/gnunet.nix" ]

Defined by: [ ]

services.gnunet.extraOptions

Additional options that will be copied verbatim in `gnunetd.conf'. See `gnunetd.conf(5)' for details.

Default: ""

Example: "[NETWORK]\nINTERFACE = eth3\n"

Declared by: [ "/trace/nixos/modules/services/networking/gnunet.nix" ]

Defined by: [ ]

services.gnunet.fileSharing.activeMigration

Whether to allow active migration of content originating from other nodes.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/gnunet.nix" ]

Defined by: [ ]

services.gnunet.fileSharing.quota

Maximum file system usage (in MiB) for file sharing.

Default: 1024

Declared by: [ "/trace/nixos/modules/services/networking/gnunet.nix" ]

Defined by: [ ]

services.gnunet.home

Directory where the GNUnet daemon will store its data.

Default: "/var/lib/gnunet"

Declared by: [ "/trace/nixos/modules/services/networking/gnunet.nix" ]

Defined by: [ ]

services.gnunet.hostLists

URLs of host lists.

Default: [ "http://gnunet.org/hostlist.php" "http://gnunet.mine.nu:8081/hostlist" "http://vserver1236.vserver-on.de/hostlist-074" ]

Declared by: [ "/trace/nixos/modules/services/networking/gnunet.nix" ]

Defined by: [ ]

services.gnunet.load.hardNetUpBandwidth

Hard bandwidth limit (in bits per second) when uploading data.

Default: 0

Declared by: [ "/trace/nixos/modules/services/networking/gnunet.nix" ]

Defined by: [ ]

services.gnunet.load.interfaces

List of network interfaces to use.

Default: [ "eth0" ]

Example: [ "wlan0" "eth1" ]

Declared by: [ "/trace/nixos/modules/services/networking/gnunet.nix" ]

Defined by: [ ]

services.gnunet.load.maxCPULoad

Maximum CPU load (percentage) authorized for the GNUnet daemon.

Default: 100

Declared by: [ "/trace/nixos/modules/services/networking/gnunet.nix" ]

Defined by: [ ]

services.gnunet.load.maxNetDownBandwidth

Maximum bandwidth usage (in bits per second) for GNUnet when downloading data.

Default: 50000

Declared by: [ "/trace/nixos/modules/services/networking/gnunet.nix" ]

Defined by: [ ]

services.gnunet.load.maxNetUpBandwidth

Maximum bandwidth usage (in bits per second) for GNUnet when downloading data.

Default: 50000

Declared by: [ "/trace/nixos/modules/services/networking/gnunet.nix" ]

Defined by: [ ]

services.gnunet.logLevel

Log level of the deamon (see `gnunetd(1)' for details).

Default: "ERROR"

Example: "INFO"

Declared by: [ "/trace/nixos/modules/services/networking/gnunet.nix" ]

Defined by: [ ]

services.gnunet.transports

List of transport methods used by the server.

Default: [ "udp" "tcp" "http" "nat" ]

Example: [ "smtp" "http" ]

Declared by: [ "/trace/nixos/modules/services/networking/gnunet.nix" ]

Defined by: [ ]

services.gpm.enable

Whether to enable general purpose mouse daemon.

Default: false

Declared by: [ "/trace/nixos/modules/services/ttys/gpm.nix" ]

Defined by: [ ]

services.gpm.protocol

Mouse protocol to use.

Default: "ps/2"

Declared by: [ "/trace/nixos/modules/services/ttys/gpm.nix" ]

Defined by: [ ]

services.gpsd.debugLevel

The debugging level.

Default: 0

Declared by: [ "/trace/nixos/modules/services/misc/gpsd.nix" ]

Defined by: [ ]

services.gpsd.device

A device may be a local serial device for GPS input, or a URL of the form: [{dgpsip|ntrip}://][user:passwd@]host[:port][/stream] in which case it specifies an input source for DGPS or ntrip data.

Default: "/dev/ttyUSB0"

Declared by: [ "/trace/nixos/modules/services/misc/gpsd.nix" ]

Defined by: [ ]

services.gpsd.enable

Whether to enable `gpsd', a GPS service daemon.

Default: false

Declared by: [ "/trace/nixos/modules/services/misc/gpsd.nix" ]

Defined by: [ ]

services.gpsd.port

The port where to listen for TCP connections.

Default: 2947

Declared by: [ "/trace/nixos/modules/services/misc/gpsd.nix" ]

Defined by: [ ]

services.gpsd.readonly

Whether to enable the broken-device-safety, otherwise known as read-only mode. Some popular bluetooth and USB receivers lock up or become totally inaccessible when probed or reconfigured. This switch prevents gpsd from writing to a receiver. This means that gpsd cannot configure the receiver for optimal performance, but it also means that gpsd cannot break the receiver. A better solution would be for Bluetooth to not be so fragile. A platform independent method to identify serial-over-Bluetooth devices would also be nice.

Default: true

Declared by: [ "/trace/nixos/modules/services/misc/gpsd.nix" ]

Defined by: [ ]

services.gw6c.autorun

Switch to false to create upstart-job and configuration, but not run it automatically

Default: true

Declared by: [ "/trace/nixos/modules/services/networking/gw6c.nix" ]

Defined by: [ ]

services.gw6c.enable

Whether to enable Gateway6 client (IPv6 tunnel).

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/gw6c.nix" ]

Defined by: [ ]

services.gw6c.everPing

Gateway6 manual ping period.

Default: "1000000"

Example: "2"

Declared by: [ "/trace/nixos/modules/services/networking/gw6c.nix" ]

Defined by: [ ]

services.gw6c.keepAlive

Gateway6 keep-alive period.

Default: "30"

Example: "2"

Declared by: [ "/trace/nixos/modules/services/networking/gw6c.nix" ]

Defined by: [ ]

services.gw6c.password

Your Gateway6 password, if any.

Default: ""

Declared by: [ "/trace/nixos/modules/services/networking/gw6c.nix" ]

Defined by: [ ]

services.gw6c.server

Used Gateway6 server.

Default: "anon.freenet6.net"

Example: "broker.freenet6.net"

Declared by: [ "/trace/nixos/modules/services/networking/gw6c.nix" ]

Defined by: [ ]

services.gw6c.username

Your Gateway6 login name, if any.

Default: ""

Declared by: [ "/trace/nixos/modules/services/networking/gw6c.nix" ]

Defined by: [ ]

services.gw6c.waitPingableBroker

Whether to wait until tunnel broker returns ICMP echo.

Default: true

Example: false

Declared by: [ "/trace/nixos/modules/services/networking/gw6c.nix" ]

Defined by: [ ]

services.hal.enable

Whether to start the HAL daemon.

Default: true

Declared by: [ "/trace/nixos/modules/services/hardware/hal.nix" ]

Defined by: [ ]

services.hal.packages

Packages containing additional HAL configuration data.

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/hardware/hal.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/xserver.nix" "/trace/nixos/modules/services/hardware/hal.nix" ]

services.httpd.adminAddr

E-mail address of the server administrator.

Default: none

Example: "admin@example.org"

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.documentRoot

The path of Apache's document root directory. If left undefined, an empty directory in the Nix store will be used as root.

Default:

Example: "/data/webserver/docs"

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.enable

Whether to enable the Apache httpd server.

Default: false

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.enableSSL

Whether to enable SSL (https) support.

Default: false

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.enableUserDir

Whether to enable serving ~/public_html as /~username.

Default: false

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.extraConfig

These lines go to httpd.conf verbatim. They will go after directories and directory aliases defined by default.

Default: ""

Example: "<Directory /home>\n Options FollowSymlinks\n AllowOverride All\n</Directory>\n"

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ "/trace/nixos/modules/services/monitoring/nagios/default.nix" ]

services.httpd.extraModules

Specifies additional Apache modules. These can be specified as a string in the case of modules distributed with Apache, or as an attribute set specifying the name and path of the module.

Default: [ ]

Example: [ "proxy_connect" { name = "php5_module"; path = "/nix/store/x7hawyqpmq09l2a8ssm5dsnzc4ss6sbr-php_configurable-5.2.9/modules/libphp5.so"; } ]

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.extraSubservices

Extra subservices to enable in the webserver.

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.globalRedirect

If set, all requests for this host are redirected permanently to the given URL.

Default: ""

Example: "http://newserver.example.org/"

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.group

Group under which httpd runs. The account is created automatically if it doesn't exist.

Default: "wwwrun"

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.hostName

Canonical hostname for the server.

Default: "localhost"

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.logDir

Directory for Apache's log files. It is created automatically.

Default: "/var/log/httpd"

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.logPerVirtualHost

If enabled, each virtual host gets its own access_log and error_log, namely suffixed by the hostName of the virtual host.

Default: false

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.mod_php

Whether to enable the PHP module.

Default: false

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.port

Port for the server. 0 means use the default port: 80 for http and 443 for https (i.e. when enableSSL is set).

Default: 0

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.servedDirs

This option provides a simple way to serve static directories.

Default: [ ]

Example: [ { dir = "/home/eelco/Dev/nix-homepage"; urlPath = "/nix"; } ]

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.servedFiles

This option provides a simple way to serve individual, static files.

Default: [ ]

Example: [ { dir = "/home/eelco/some-file.png"; urlPath = "/foo/bar.png"; } ]

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.serverAliases

Additional names of virtual hosts served by this virtual host configuration.

Default: [ ]

Example: [ "www.example.org" "www.example.org:8080" "example.org" ]

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.sslServerCert

Path to server SSL certificate.

Default: ""

Example: "/var/host.cert"

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.sslServerKey

Path to server SSL certificate key.

Default: ""

Example: "/var/host.key"

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.stateDir

Directory for Apache's transient runtime state (such as PID files). It is created automatically. Note that the default, /var/run/httpd, is deleted at boot time.

Default: "/var/run/httpd"

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.subservices.subversion.autoVersioning

Whether you want the Subversion subservice to support auto-versioning, which enables Subversion repositories to be mounted as read/writable file systems on operating systems that support WebDAV.

Default: false

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.subservices.subversion.dataDir

Place to put SVN repository.

Default: "/no/such/path/exists"

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.subservices.subversion.enable

Whether to enable the Subversion subservice in the webserver.

Default: false

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.subservices.subversion.notificationSender

The email address used in the Sender field of commit notification messages sent by the Subversion subservice.

Default: "svn-server@example.org"

Example: "svn-server@example.org"

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.subservices.subversion.organization.logo

Logo the organization hosting the Subversion service.

Default:

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.subservices.subversion.organization.name

Name of the organization hosting the Subversion service.

Default:

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.subservices.subversion.organization.url

URL of the website of the organization hosting the Subversion service.

Default:

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.subservices.subversion.userCreationDomain

The domain from which user creation is allowed. A client can only create a new user account if its IP address resolves to this domain.

Default: "example.org"

Example: "example.org"

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.user

User account under which httpd runs. The account is created automatically if it doesn't exist.

Default: "wwwrun"

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.httpd.virtualHosts

Specification of the virtual hosts served by Apache. Each element should be an attribute set specifying the configuration of the virtual host. The available options are the non-global options permissible for the main host.

Default: [ ]

Example: [ { documentRoot = "/data/webroot-foo"; hostName = "foo"; } { documentRoot = "/data/webroot-bar"; hostName = "bar"; } ]

Declared by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" ]

Defined by: [ ]

services.ircdHybrid.adminEmail

IRCD server administrator e-mail.

Default: "<bit-bucket@example.com>"

Example: "<name@domain.tld>"

Declared by: [ "/trace/nixos/modules/services/networking/ircd-hybrid.nix" ]

Defined by: [ ]

services.ircdHybrid.certificate

IRCD server SSL certificate. There are some limitations - read manual.

Default:

Example:

Declared by: [ "/trace/nixos/modules/services/networking/ircd-hybrid.nix" ]

Defined by: [ ]

services.ircdHybrid.description

IRCD server description.

Default: "Hybrid-7 IRC server."

Declared by: [ "/trace/nixos/modules/services/networking/ircd-hybrid.nix" ]

Defined by: [ ]

services.ircdHybrid.enable

Enable IRCD.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/ircd-hybrid.nix" ]

Defined by: [ ]

services.ircdHybrid.extraIPs

Extra IP's to bind.

Default: [ ]

Example: [ "127.0.0.1" ]

Declared by: [ "/trace/nixos/modules/services/networking/ircd-hybrid.nix" ]

Defined by: [ ]

services.ircdHybrid.extraPort

Extra port to avoid filtering.

Default: "7117"

Declared by: [ "/trace/nixos/modules/services/networking/ircd-hybrid.nix" ]

Defined by: [ ]

services.ircdHybrid.rsaKey

IRCD server RSA key.

Default:

Example:

Declared by: [ "/trace/nixos/modules/services/networking/ircd-hybrid.nix" ]

Defined by: [ ]

services.ircdHybrid.serverName

IRCD server name.

Default: "hades.arpa"

Declared by: [ "/trace/nixos/modules/services/networking/ircd-hybrid.nix" ]

Defined by: [ ]

services.ircdHybrid.sid

IRCD server unique ID in a net of servers.

Default: "0NL"

Declared by: [ "/trace/nixos/modules/services/networking/ircd-hybrid.nix" ]

Defined by: [ ]

services.jboss.deployDir

Location of the deployment files

Default: "/nix/var/nix/profiles/default/server/default/deploy/"

Declared by: [ "/trace/nixos/modules/services/web-servers/jboss.nix" ]

Defined by: [ ]

services.jboss.enable

Whether to enable jboss

Default: false

Declared by: [ "/trace/nixos/modules/services/web-servers/jboss.nix" ]

Defined by: [ ]

services.jboss.libUrl

Location where the shared library JARs are stored

Default: "file:///nix/var/nix/profiles/default/server/default/lib"

Declared by: [ "/trace/nixos/modules/services/web-servers/jboss.nix" ]

Defined by: [ ]

services.jboss.logDir

Location of the logfile directory of JBoss

Default: "/var/log/jboss"

Declared by: [ "/trace/nixos/modules/services/web-servers/jboss.nix" ]

Defined by: [ ]

services.jboss.serverDir

Location of the server instance files

Default: "/var/jboss/server"

Declared by: [ "/trace/nixos/modules/services/web-servers/jboss.nix" ]

Defined by: [ ]

services.jboss.tempDir

Location where JBoss stores its temp files

Default: "/tmp"

Declared by: [ "/trace/nixos/modules/services/web-servers/jboss.nix" ]

Defined by: [ ]

services.jboss.useJK

Whether to use to connector to the Apache HTTP server

Default: false

Declared by: [ "/trace/nixos/modules/services/web-servers/jboss.nix" ]

Defined by: [ ]

services.jboss.user

User account under which jboss runs.

Default: "nobody"

Declared by: [ "/trace/nixos/modules/services/web-servers/jboss.nix" ]

Defined by: [ ]

services.locate.enable

If enabled, NixOS will periodically update the database of files used by the locate command.

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/misc/locate.nix" ]

Defined by: [ ]

services.locate.period

This option defines (in the format used by cron) when the locate database is updated. The default is to update at 02:15 (at night) every day.

Default: "15 02 * * *"

Declared by: [ "/trace/nixos/modules/misc/locate.nix" ]

Defined by: [ ]

services.lshd.enable

Whether to enable the GNU lshd SSH2 daemon, which allows secure remote login.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/ssh/lshd.nix" ]

Defined by: [ ]

services.lshd.hostKey

Path to the server's private key. Note that this key must have been created, e.g., using "lsh-keygen --server | lsh-writekey --server", so that you can run lshd.

Default: "/etc/lsh/host-key"

Declared by: [ "/trace/nixos/modules/services/networking/ssh/lshd.nix" ]

Defined by: [ ]

services.lshd.interfaces

List of network interfaces where listening for connections. When providing the empty list, `[]', lshd listens on all network interfaces.

Default: [ ]

Example: [ "localhost" "1.2.3.4:443" ]

Declared by: [ "/trace/nixos/modules/services/networking/ssh/lshd.nix" ]

Defined by: [ ]

services.lshd.loginShell

If non-null, override the default login shell with the specified value.

Default:

Example: "/nix/store/xyz-bash-10.0/bin/bash10"

Declared by: [ "/trace/nixos/modules/services/networking/ssh/lshd.nix" ]

Defined by: [ ]

services.lshd.passwordAuthentication

Whether to enable password authentication.

Default: true

Declared by: [ "/trace/nixos/modules/services/networking/ssh/lshd.nix" ]

Defined by: [ ]

services.lshd.portNumber

The port on which to listen for connections.

Default: 22

Declared by: [ "/trace/nixos/modules/services/networking/ssh/lshd.nix" ]

Defined by: [ ]

services.lshd.publicKeyAuthentication

Whether to enable public key authentication.

Default: true

Declared by: [ "/trace/nixos/modules/services/networking/ssh/lshd.nix" ]

Defined by: [ ]

services.lshd.rootLogin

Whether to enable remote root login.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/ssh/lshd.nix" ]

Defined by: [ ]

services.lshd.srpKeyExchange

Whether to enable SRP key exchange and user authentication.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/ssh/lshd.nix" ]

Defined by: [ ]

services.lshd.subsystems

List of subsystem-path pairs, where the head of the pair denotes the subsystem name, and the tail denotes the path to an executable implementing it.

Default: [ [ "sftp" "/nix/store/r9czp3s8ix51lg1rb6dfbqd3f9clqckl-lsh-2.0.4/sbin/sftp-server" ] ]

Declared by: [ "/trace/nixos/modules/services/networking/ssh/lshd.nix" ]

Defined by: [ ]

services.lshd.syslog

Whether to enable syslog output.

Default: true

Declared by: [ "/trace/nixos/modules/services/networking/ssh/lshd.nix" ]

Defined by: [ ]

services.lshd.tcpForwarding

Whether to enable TCP/IP forwarding.

Default: true

Declared by: [ "/trace/nixos/modules/services/networking/ssh/lshd.nix" ]

Defined by: [ ]

services.lshd.x11Forwarding

Whether to enable X11 forwarding.

Default: true

Declared by: [ "/trace/nixos/modules/services/networking/ssh/lshd.nix" ]

Defined by: [ ]

services.mingetty.greetingLine

Welcome line printed by mingetty.

Default: "<<< Welcome to NixOS (\\m) - Kernel \\r (\\l) >>>"

Declared by: [ "/trace/nixos/modules/services/ttys/mingetty.nix" ]

Defined by: [ ]

services.mingetty.helpLine

Help line printed by mingetty below the welcome line. Used by the installation CD to give some hints on how to proceed.

Default: ""

Declared by: [ "/trace/nixos/modules/services/ttys/mingetty.nix" ]

Defined by: [ "/trace/nixos/modules/services/misc/rogue.nix" "/trace/nixos/modules/services/misc/nixos-manual.nix" ]

services.mingetty.ttys

The list of tty (virtual console) devices on which to start a login prompt.

Default: [ 1 2 3 4 5 6 ]

Declared by: [ "/trace/nixos/modules/services/ttys/mingetty.nix" ]

Defined by: [ ]

services.mingetty.waitOnMounts

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.

Default: false

Declared by: [ "/trace/nixos/modules/services/ttys/mingetty.nix" ]

Defined by: [ ]

services.mysql.dataDir

Location where MySQL stores its table files

Default: "/var/mysql"

Declared by: [ "/trace/nixos/modules/services/databases/mysql.nix" ]

Defined by: [ ]

services.mysql.enable

Whether to enable the MySQL server.

Default: false

Declared by: [ "/trace/nixos/modules/services/databases/mysql.nix" ]

Defined by: [ ]

services.mysql.logError

Location of the MySQL error logfile

Default: "/var/log/mysql_err.log"

Declared by: [ "/trace/nixos/modules/services/databases/mysql.nix" ]

Defined by: [ ]

services.mysql.pidDir

Location of the file which stores the PID of the MySQL server

Default: "/var/run/mysql"

Declared by: [ "/trace/nixos/modules/services/databases/mysql.nix" ]

Defined by: [ ]

services.mysql.port

Port of MySQL

Default: "3306"

Declared by: [ "/trace/nixos/modules/services/databases/mysql.nix" ]

Defined by: [ ]

services.mysql.user

User account under which MySQL runs

Default: "mysql"

Declared by: [ "/trace/nixos/modules/services/databases/mysql.nix" ]

Defined by: [ ]

services.nagios.enable

Whether to use Nagios to monitor your system or network.

Default: false

Declared by: [ "/trace/nixos/modules/services/monitoring/nagios/default.nix" ]

Defined by: [ ]

services.nagios.enableWebInterface

Whether to enable the Nagios web interface. You should also enable Apache (services.httpd.enable).

Default: false

Declared by: [ "/trace/nixos/modules/services/monitoring/nagios/default.nix" ]

Defined by: [ ]

services.nagios.objectDefs

A list of Nagios object configuration files that must define the hosts, host groups, services and contacts for the network that you want Nagios to monitor.

Default: none

Declared by: [ "/trace/nixos/modules/services/monitoring/nagios/default.nix" ]

Defined by: [ ]

services.nagios.plugins

Packages to be added to the Nagios PATH. Typically used to add plugins, but can be anything.

Default: [ (build of nagios-plugins-1.4.10) (build of ssmtp-2.61-12) ]

Declared by: [ "/trace/nixos/modules/services/monitoring/nagios/default.nix" ]

Defined by: [ ]

services.nagios.urlPath

The URL path under which the Nagios web interface appears. That is, you can access the Nagios web interface through http://server/urlPath.

Default: "/nagios"

Declared by: [ "/trace/nixos/modules/services/monitoring/nagios/default.nix" ]

Defined by: [ ]

services.nfsKernel.createMountPoints

Whether to create the mount points in the exports file at startup time.

Default: false

Declared by: [ "/trace/nixos/modules/services/network-filesystems/nfs-kernel.nix" ]

Defined by: [ ]

services.nfsKernel.enable

wether to use the kernel nfs functionality to export filesystems. You should be aware about existing security issues. requires portmap!

Default: false

Declared by: [ "/trace/nixos/modules/services/network-filesystems/nfs-kernel.nix" ]

Defined by: [ ]

services.nfsKernel.exports

the file listing the directories to be exported. install nfsUtils and run man exports to learn about its format. The exports setting can either be a file path or the file contents.

Default: "/etc/exports"

Declared by: [ "/trace/nixos/modules/services/network-filesystems/nfs-kernel.nix" ]

Defined by: [ ]

services.nfsKernel.hostName

specify a particular hostname (or address) that NFS requests will be accepted on. Default: all. See man rpc.nfsd (-H option)

Default:

Declared by: [ "/trace/nixos/modules/services/network-filesystems/nfs-kernel.nix" ]

Defined by: [ ]

services.nfsKernel.nproc

specify the number of NFS server threads. (-> man rpc.nfsd). Defaults to recommended value 8

Default: 8

Declared by: [ "/trace/nixos/modules/services/network-filesystems/nfs-kernel.nix" ]

Defined by: [ ]

services.nixosManual.browser

Browser used to show the manual.

Default: "/nix/store/6j0cfb022dcj532x2g8k4dl8b7amryhn-w3m-0.5.2/bin/w3m"

Declared by: [ "/trace/nixos/modules/services/misc/nixos-manual.nix" ]

Defined by: [ ]

services.nixosManual.enable

Whether to build the NixOS manual pages.

Default: true

Declared by: [ "/trace/nixos/modules/services/misc/nixos-manual.nix" ]

Defined by: [ ]

services.nixosManual.showManual

Whether to show the NixOS manual on one of the virtual consoles.

Default: false

Declared by: [ "/trace/nixos/modules/services/misc/nixos-manual.nix" ]

Defined by: [ ]

services.nixosManual.ttyNumber

Virtual console on which to show the manual.

Default: "8"

Declared by: [ "/trace/nixos/modules/services/misc/nixos-manual.nix" ]

Defined by: [ ]

services.ntp.enable

Whether to synchronise your machine's time using the NTP protocol.

Default: true

Declared by: [ "/trace/nixos/modules/services/networking/ntpd.nix" ]

Defined by: [ ]

services.ntp.servers

The set of NTP servers from which to synchronise.

Default: [ "0.pool.ntp.org" "1.pool.ntp.org" "2.pool.ntp.org" ]

Declared by: [ "/trace/nixos/modules/services/networking/ntpd.nix" ]

Defined by: [ ]

services.openfire.enable

Whether to enable OpenFire XMPP server.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/openfire.nix" ]

Defined by: [ ]

services.openfire.usePostgreSQL

Whether you use PostgreSQL service for your storage back-end.

Default: true

Declared by: [ "/trace/nixos/modules/services/networking/openfire.nix" ]

Defined by: [ ]

services.openvpn.enable

Whether to enable the Secure Shell daemon, which allows secure remote logins.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/openvpn.nix" ]

Defined by: [ ]

services.openvpn.servers

openvpn instances to be run. Each will be put into an extra job named openvpn-{id} The up and down properties will be added config line up=/nix/store/xxx-up-script automatically for you. If you define at least one of up/down "script-security 2" will be prepended to your config. Don't forget to check that the all package sizes can be sent. if scp hangs or such you should set --fragment XXX --mssfix YYY.

Default: [ ]

Example: [ { config = "# Most simple configuration: http://openvpn.net/index.php/documentation/miscellaneous/static-key-mini-howto.html.\n# server : \ndev tun\nifconfig 10.8.0.1 10.8.0.2\nsecret static.key\n"; down = "ip route add ..!"; id = "server-simplest"; up = "ip route add ..!"; } { config = "#client:\n#remote myremote.mydomain\n#dev tun\n#ifconfig 10.8.0.2 10.8.0.1\n#secret static.key\n"; id = "client-simplest"; } { config = "multiple clienst\nsee example file found in http://openvpn.net/index.php/documentation/howto.html\n"; id = "server-scalable"; } { config = "dito "; id = "client-scalabe"; } ]

Declared by: [ "/trace/nixos/modules/services/networking/openvpn.nix" ]

Defined by: [ ]

services.portmap.chroot

If non-empty, a path to change root to.

Default: "/var/empty"

Declared by: [ "/trace/nixos/modules/services/networking/portmap.nix" ]

Defined by: [ ]

services.portmap.enable

Whether to enable `portmap', an ONC RPC directory service notably used by NFS and NIS, and which can be queried using the rpcinfo(1) command.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/portmap.nix" ]

Defined by: [ ]

services.portmap.verbose

Whether to enable verbose output.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/portmap.nix" ]

Defined by: [ ]

services.postfix.destination

Full (!) list of domains we deliver locally. Leave blank for acceptable Postfix default.

Default:

Example: [ "localhost" ]

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.domain

Domain to use. Leave blank to use hostname minus first component.

Default: ""

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.enable

Whether to run the Postfix mail server.

Default: false

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.extraAliases

Additional entries to put verbatim into aliases file.

Default: ""

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.group

How to call postfix group (must be used only for postfix).

Default: "postfix"

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.hostname

Hostname to use. Leave blank to use just the hostname of machine. It should be FQDN.

Default: ""

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.lookupMX

Whether relay specified is just domain whose MX must be used.

Default: false

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.networks

Net masks for trusted - allowed to relay mail to third parties - hosts. Leave empty to use mynetworks_style configuration or use default (localhost-only).

Default:

Example: [ "192.168.0.1/24" ]

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.networksStyle

Name of standard way of trusted network specification to use, leave blank if you specify it explicitly or if you want to use default (localhost-only).

Default: ""

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.origin

Origin to use in outgoing e-mail. Leave blank to use hostname.

Default: ""

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.postmasterAlias

Who should receive postmaster e-mail.

Default: "root"

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.recipientDelimiter

Delimiter for address extension: so mail to user+test can be handled by ~user/.forward+test

Default: ""

Example: "+"

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.relayDomains

List of domains we agree to relay to. Default is the same as destination.

Default:

Example: [ "localdomain" ]

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.relayHost

Mail relay for outbound mail.

Default: ""

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.rootAlias

Who should receive root e-mail. Blank for no redirection.

Default: ""

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.setgidGroup

How to call postfix setgid group (for postdrop). Should be uniquely used group.

Default: "postdrop"

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.sslCACert

SSL certificate of CA.

Default: ""

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.sslCert

SSL certificate to use.

Default: ""

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.sslKey

SSL key to use.

Default: ""

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postfix.user

How to call postfix user (must be used only for postfix).

Default: "postfix"

Declared by: [ "/trace/nixos/modules/services/mail/postfix.nix" ]

Defined by: [ ]

services.postgresql.allowedHosts

Hosts (except localhost), who you allow to connect.

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/databases/postgresql.nix" ]

Defined by: [ ]

services.postgresql.authMethod

How to authorize users. Note: ident needs absolute trust to all allowed client hosts.

Default: " ident sameuser "

Declared by: [ "/trace/nixos/modules/services/databases/postgresql.nix" ]

Defined by: [ ]

services.postgresql.authentication

Hosts (except localhost), who you allow to connect.

Default: "# Generated file; do not edit!\nlocal all all ident sameuser\nhost all all 127.0.0.1/32 md5\nhost all all ::1/128 md5\n"

Declared by: [ "/trace/nixos/modules/services/databases/postgresql.nix" ]

Defined by: [ ]

services.postgresql.dataDir

Data directory for PostgreSQL.

Default: "/var/db/postgresql"

Declared by: [ "/trace/nixos/modules/services/databases/postgresql.nix" ]

Defined by: [ ]

services.postgresql.enable

Whether to run PostgreSQL.

Default: false

Declared by: [ "/trace/nixos/modules/services/databases/postgresql.nix" ]

Defined by: [ ]

services.postgresql.enableTCPIP

Whether to run PostgreSQL with -i flag to enable TCP/IP connections.

Default: false

Declared by: [ "/trace/nixos/modules/services/databases/postgresql.nix" ]

Defined by: [ ]

services.postgresql.logDir

Log directory for PostgreSQL.

Default: "/var/log/postgresql"

Declared by: [ "/trace/nixos/modules/services/databases/postgresql.nix" ]

Defined by: [ ]

services.postgresql.port

Port for PostgreSQL.

Default: "5432"

Declared by: [ "/trace/nixos/modules/services/databases/postgresql.nix" ]

Defined by: [ ]

services.postgresql.subServices

Subservices list. As it is already implememnted, here is an interface...

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/databases/postgresql.nix" ]

Defined by: [ ]

services.printing.bindirCmds

add commands adding additional symlinks to the bindir such as bjnp

Default: ""

Declared by: [ "/trace/nixos/modules/services/printing/cupsd.nix" ]

Defined by: [ ]

services.printing.enable

Whether to enable printing support through the CUPS daemon.

Default: false

Declared by: [ "/trace/nixos/modules/services/printing/cupsd.nix" ]

Defined by: [ ]

services.pulseaudio.enable

Whether to enable the PulseAudio system-wide audio server. Note that the documentation recommends running PulseAudio daemons per-user rather than system-wide on desktop machines.

Default: false

Declared by: [ "/trace/nixos/modules/services/audio/pulseaudio.nix" ]

Defined by: [ ]

services.pulseaudio.logLevel

A string denoting the log level: one of error, warn, notice, info, or debug.

Default: "notice"

Example: "debug"

Declared by: [ "/trace/nixos/modules/services/audio/pulseaudio.nix" ]

Defined by: [ ]

services.rogue.enable

Whether to enable the Rogue game on one of the virtual consoles.

Default: false

Declared by: [ "/trace/nixos/modules/services/misc/rogue.nix" ]

Defined by: [ ]

services.rogue.ttyNumber

Virtual console on which to run Rogue.

Default: "9"

Declared by: [ "/trace/nixos/modules/services/misc/rogue.nix" ]

Defined by: [ ]

services.samba.configFile

internal use to pass filepath to samba pam module

Default: none

Declared by: [ "/trace/nixos/modules/services/network-filesystems/samba.nix" ]

Defined by: [ ]

services.samba.enable

Whether to enable the samba server. (to communicate with, and provide windows shares) use start / stop samba-control to start/stop all daemons. smbd and nmbd are not shutdown correctly yet. so just pkill them and restart those jobs.

Default: false

Declared by: [ "/trace/nixos/modules/services/network-filesystems/samba.nix" ]

Defined by: [ ]

services.samba.extraConfig

additional global section and extra section lines go in here.

Default: "# [global] continuing global section here, section is started by nix to set pids etc\n\n smb passwd file = /etc/samba/passwd\n\n # is this useful ?\n domain master = auto\n\n encrypt passwords = Yes\n client plaintext auth = No\n\n # yes: if you use this you probably also want to enable syncPasswordsByPam\n # no: You can still use the pam password database. However\n # passwords will be sent plain text on network (discouraged)\n\n workgroup = Users\n server string = %h\n comment = Samba\n log file = /var/log/samba/log.%m\n log level = 10\n max log size = 50000\n security = user\n \n client lanman auth = Yes\n dns proxy = no\n invalid users = root\n passdb backend = tdbsam\n passwd program = /usr/bin/passwd %u\n\n### end [ global ] section\n\n \n# Un-comment the following (and tweak the other settings below to suit)\n# to enable the default home directory shares. This will share each\n# user's home directory as \\\\server\\username\n;[homes]\n; comment = Home Directories\n; browseable = no\n; writable = no\n\n# File creation mask is set to 0700 for security reasons. If you want to\n# create files with group=rw permissions, set next parameter to 0775.\n; create mask = 0700\n\n# this directory and user is created automatically for you by nixos\n;[default]\n; path = /home/smbd\n; read only = no\n; guest ok = yes\n \n# this directory and user is created automatically for you by nixos\n;[default]\n; path = /home/smbd\n; read only = no\n; guest ok = yes\n\n# additional share example\n;[raidbackup]\n; path = /home/raidbackup/files\n; read only = no\n; guest ok = no\n; available = yes\n; browseable = yes\n; public = yes\n; valid users = raidbackup\n; comment = Raid backup Files\n"

Declared by: [ "/trace/nixos/modules/services/network-filesystems/samba.nix" ]

Defined by: [ ]

services.samba.syncPasswordsByPam

enabling this will add a line directly after pam_unix.so. Whenever a password is changed the samba password will be updated as well. However you still yave to add the samba password once using smbpasswd -a user If you don't want to maintain an extra pwd database you still can send plain text passwords which is not secure.

Default: false

Declared by: [ "/trace/nixos/modules/services/network-filesystems/samba.nix" ]

Defined by: [ ]

services.sshd.allowSFTP

Whether to enable the SFTP subsystem in the SSH daemon. This enables the use of commands such as sftp and sshfs.

Default: true

Declared by: [ "/trace/nixos/modules/services/networking/ssh/sshd.nix" ]

Defined by: [ ]

services.sshd.enable

Whether to enable the Secure Shell daemon, which allows secure remote logins.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/ssh/sshd.nix" ]

Defined by: [ ]

services.sshd.forwardX11

Whether to allow X11 connections to be forwarded.

Default: true

Declared by: [ "/trace/nixos/modules/services/networking/ssh/sshd.nix" ]

Defined by: [ ]

services.sshd.gatewayPorts

Specifies whether remote hosts are allowed to connect to ports forwarded for the client. See sshd_config(5).

Default: "no"

Declared by: [ "/trace/nixos/modules/services/networking/ssh/sshd.nix" ]

Defined by: [ ]

services.sshd.permitRootLogin

Whether the root user can login using ssh. Valid values are yes, without-password, forced-commands-only or no.

Default: "yes"

Declared by: [ "/trace/nixos/modules/services/networking/ssh/sshd.nix" ]

Defined by: [ ]

services.synergy.client.enable

Whether to enable the synergy client (receive keyboard and mouse events from a synergy server)

Default: false

Declared by: [ "/trace/nixos/modules/services/misc/synergy.nix" ]

Defined by: [ ]

services.synergy.client.screenName

use screen-name instead the hostname to identify ourselfs to the server.

Default: ""

Declared by: [ "/trace/nixos/modules/services/misc/synergy.nix" ]

Defined by: [ ]

services.synergy.server.address

listen for clients on the given address

Default: ""

Declared by: [ "/trace/nixos/modules/services/misc/synergy.nix" ]

Defined by: [ ]

services.synergy.server.configFile

The synergy server configuration file. open upstart-jobs/synergy.nix to see an example

Default: "/etc/synergy-server.conf"

Declared by: [ "/trace/nixos/modules/services/misc/synergy.nix" ]

Defined by: [ ]

services.synergy.server.enable

Whether to enable the synergy server (send keyboard and mouse events)

Default: false

Declared by: [ "/trace/nixos/modules/services/misc/synergy.nix" ]

Defined by: [ ]

services.synergy.server.screenName

use screen-name instead the hostname to identify this screen in the configuration.

Default: ""

Declared by: [ "/trace/nixos/modules/services/misc/synergy.nix" ]

Defined by: [ ]

services.syslogd.tty

The tty device on which syslogd will print important log messages.

Default: 10

Declared by: [ "/trace/nixos/modules/services/logging/syslogd.nix" ]

Defined by: [ ]

services.tftpd.enable

Whether to enable the anonymous FTP user.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/tftpd.nix" ]

Defined by: [ ]

services.tftpd.path

Where the tftp server files are stored

Default: "/home/tftp"

Declared by: [ "/trace/nixos/modules/services/networking/tftpd.nix" ]

Defined by: [ ]

services.tomcat.axis2.enable

Whether to enable an Apache Axis2 container

Default: false

Declared by: [ "/trace/nixos/modules/services/web-servers/tomcat.nix" ]

Defined by: [ ]

services.tomcat.axis2.services

List containing AAR files or directories with AAR files which are web services to be deployed on Axis2

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/web-servers/tomcat.nix" ]

Defined by: [ ]

services.tomcat.baseDir

Location where Tomcat stores configuration files, webapplications and logfiles

Default: "/var/tomcat"

Declared by: [ "/trace/nixos/modules/services/web-servers/tomcat.nix" ]

Defined by: [ ]

services.tomcat.catalinaOpts

Parameters to pass to the Java Virtual Machine which spawns the Catalina servlet container

Default: ""

Declared by: [ "/trace/nixos/modules/services/web-servers/tomcat.nix" ]

Defined by: [ ]

services.tomcat.commonLibs

List containing JAR files or directories with JAR files which are libraries shared by the web applications and the servlet container

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/web-servers/tomcat.nix" ]

Defined by: [ ]

services.tomcat.enable

Whether to enable Apache Tomcat

Default: false

Declared by: [ "/trace/nixos/modules/services/web-servers/tomcat.nix" ]

Defined by: [ ]

services.tomcat.group

Group account under which Apache Tomcat runs.

Default: "tomcat"

Declared by: [ "/trace/nixos/modules/services/web-servers/tomcat.nix" ]

Defined by: [ ]

services.tomcat.javaOpts

Parameters to pass to the Java Virtual Machine which spawns Apache Tomcat

Default: ""

Declared by: [ "/trace/nixos/modules/services/web-servers/tomcat.nix" ]

Defined by: [ ]

services.tomcat.sharedLibs

List containing JAR files or directories with JAR files which are libraries shared by the web applications

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/web-servers/tomcat.nix" ]

Defined by: [ ]

services.tomcat.user

User account under which Apache Tomcat runs.

Default: "tomcat"

Declared by: [ "/trace/nixos/modules/services/web-servers/tomcat.nix" ]

Defined by: [ ]

services.tomcat.virtualHosts

List consisting of a virtual host name and a list of web applications to deploy on each virtual host

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/web-servers/tomcat.nix" ]

Defined by: [ ]

services.tomcat.webapps

List containing WAR files or directories with WAR files which are web applications to be deployed on Tomcat

Default: [ (build of apache-tomcat-6.0.20) ]

Declared by: [ "/trace/nixos/modules/services/web-servers/tomcat.nix" ]

Defined by: [ ]

services.ttyBackgrounds.defaultSpecificThemes

This option sets specific themes for virtual consoles. If you just want to set themes for additional consoles, use services.ttyBackgrounds.specificThemes.

Default: [ { theme = (build of Theme-GNU.tar.bz2); tty = 10; } ]

Declared by: [ "/trace/nixos/modules/tasks/tty-backgrounds.nix" ]

Defined by: [ ]

services.ttyBackgrounds.defaultTheme

The default theme for the virtual consoles. Themes can be found at http://www.bootsplash.de/.

Default: (build of Theme-BabyTux.tar.bz2)

Declared by: [ "/trace/nixos/modules/tasks/tty-backgrounds.nix" ]

Defined by: [ ]

services.ttyBackgrounds.enable

Whether to enable graphical backgrounds for the virtual consoles.

Default: true

Declared by: [ "/trace/nixos/modules/tasks/tty-backgrounds.nix" ]

Defined by: [ ]

services.ttyBackgrounds.specificThemes

This option allows you to set specific themes for virtual consoles.

Default: [ ]

Declared by: [ "/trace/nixos/modules/tasks/tty-backgrounds.nix" ]

Defined by: [ "/trace/nixos/modules/services/misc/rogue.nix" "/trace/nixos/modules/services/misc/nixos-manual.nix" ]

services.udev.extraRules

Additional udev rules. They'll be written into file 10-local.rules. Thus they are read before all other rules.

Default: ""

Example: "KERNEL==\"eth*\", ATTR{address}==\"00:1D:60:B9:6D:4F\", NAME=\"my_fast_network_card\"\n"

Declared by: [ "/trace/nixos/modules/services/hardware/udev.nix" ]

Defined by: [ "/trace/nixos/modules/services/hardware/udev.nix" ]

services.udev.packages

List of packages containing udev rules. All files found in pkg/etc/udev/rules.d and pkg/lib/udev/rules.d will be included.

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/hardware/udev.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/hardware/wacom.nix" "/trace/nixos/modules/services/hardware/udev.nix" "/trace/nixos/modules/services/hardware/hal.nix" "/trace/nixos/modules/hardware/pcmcia.nix" ]

services.vsftpd.anonymousMkdirEnable

Whether mkdir is permitted to anonymous users.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/vsftpd.nix" ]

Defined by: [ ]

services.vsftpd.anonymousUploadEnable

Whether any uploads are permitted to anonymous users.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/vsftpd.nix" ]

Defined by: [ ]

services.vsftpd.anonymousUser

Whether to enable the anonymous FTP user.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/vsftpd.nix" ]

Defined by: [ ]

services.vsftpd.chrootlocalUser

Whether u can like out of ur home dir.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/vsftpd.nix" ]

Defined by: [ ]

services.vsftpd.enable

Whether to enable the vsftpd FTP server.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/vsftpd.nix" ]

Defined by: [ ]

services.vsftpd.localUsers

Whether to enable FTP for the local users.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/vsftpd.nix" ]

Defined by: [ ]

services.vsftpd.userlistDeny

Whether users are excluded.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/vsftpd.nix" ]

Defined by: [ ]

services.vsftpd.userlistEnable

Whether users are included.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/vsftpd.nix" ]

Defined by: [ ]

services.vsftpd.writeEnable

Whether any write activity is permitted to users.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/vsftpd.nix" ]

Defined by: [ ]

services.xfs.enable

Whether to enable the X Font Server.

Default: false

Declared by: [ "/trace/nixos/modules/services/x11/xfs.nix" ]

Defined by: [ ]

services.xinetd.enable

Whether to enable the xinetd super-server daemon.

Default: false

Declared by: [ "/trace/nixos/modules/services/networking/xinetd.nix" ]

Defined by: [ "/trace/nixos/modules/services/networking/tftpd.nix" ]

services.xinetd.services

A list of services provided by xinetd.

Default: [ ]

Declared by: [ "/trace/nixos/modules/services/networking/xinetd.nix" ]

Defined by: [ "/trace/nixos/modules/services/networking/tftpd.nix" ]

services.xinetd.services.*.name

Name of the service.

Default: none

Example: "login"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

services.xinetd.services.*.port

Port number of the service.

Default: 0

Example: 123

Declared by: [ "<unknow location>" ]

Defined by: [ ]

services.xinetd.services.*.protocol

Protocol of the service. Usually tcp or udp.

Default: "tcp"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

services.xinetd.services.*.server

Path of the program that implements the service.

Default: none

Example: "/foo/bin/ftpd"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

services.xinetd.services.*.serverArgs

Command-line arguments for the server program.

Default: ""

Declared by: [ "<unknow location>" ]

Defined by: [ ]

services.xinetd.services.*.unlisted

Whether this server is listed in /etc/services. If so, the port number can be omitted.

Default: false

Declared by: [ "<unknow location>" ]

Defined by: [ ]

services.xinetd.services.*.user

User account for the service

Default: "nobody"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

services.xserver.autorun

Whether to start the X server automatically.

Default: true

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.config

The contents of the configuration file of the X server (xorg.conf).

Default: none

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/xserver.nix" "/trace/nixos/modules/services/x11/hardware/wacom.nix" "/trace/nixos/modules/services/x11/hardware/synaptics.nix" ]

services.xserver.defaultDepth

Default colour depth.

Default: 24

Example: 8

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.desktopManager.default

Default desktop manager loaded if none have been chosen.

Default: "xterm"

Example: "none"

Declared by: [ "/trace/nixos/modules/services/x11/desktop-managers/default.nix" ]

Defined by: [ ]

services.xserver.desktopManager.gnome.enable

Enable a gnome terminal as a desktop manager.

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/services/x11/desktop-managers/gnome.nix" ]

Defined by: [ ]

services.xserver.desktopManager.kde.enable

Enable the kde desktop manager.

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/services/x11/desktop-managers/kde.nix" ]

Defined by: [ ]

services.xserver.desktopManager.kde4.enable

Enable the KDE 4 desktop environment.

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/services/x11/desktop-managers/kde4.nix" ]

Defined by: [ ]

services.xserver.desktopManager.session

Internal option used to add some common line to desktop manager scripts before forwarding the value to the displayManager.

Default: [ ]

Example: [ { bgSupport = true; name = "kde"; start = "..."; } ]

Declared by: [ "/trace/nixos/modules/services/x11/desktop-managers/default.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/desktop-managers/xterm.nix" "/trace/nixos/modules/services/x11/desktop-managers/none.nix" "/trace/nixos/modules/services/x11/desktop-managers/kde4.nix" "/trace/nixos/modules/services/x11/desktop-managers/kde.nix" "/trace/nixos/modules/services/x11/desktop-managers/gnome.nix" ]

services.xserver.desktopManager.xterm.enable

Enable a xterm terminal as a desktop manager.

Default: true

Example: false

Declared by: [ "/trace/nixos/modules/services/x11/desktop-managers/xterm.nix" ]

Defined by: [ ]

services.xserver.deviceSection

Contents of the first Device section of the X server configuration file.

Default: ""

Example: "VideoRAM 131072"

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

services.xserver.display

Display number for the X server.

Default: 0

Example: 1

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.displayManager.job

This option defines how to start the display manager.

Default: { }

Declared by: [ "/trace/nixos/modules/services/x11/display-managers/default.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/display-managers/slim.nix" "/trace/nixos/modules/services/x11/display-managers/kdm.nix" ]

services.xserver.displayManager.job.environment

Additional environment variables needed by the display manager.

Default: { }

Example: { SLIM_CFGFILE = ; }

Declared by: [ "<unknow location>" ]

Defined by: [ ]

services.xserver.displayManager.job.execCmd

Command to start the display manager.

Default: none

Example: "/nix/store/r5lqy8g29jsnmivwnc81b31g0m6cjgmd-slim-1.3.1/bin/slim"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

services.xserver.displayManager.job.logsXsession

Whether the display manager redirects the output of the session script to ~/.xsession-errors.

Default: false

Declared by: [ "<unknow location>" ]

Defined by: [ ]

services.xserver.displayManager.job.preStart

Script executed before the display manager is started.

Default: ""

Example: "rm -f /var/log/my-display-manager.log"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

services.xserver.displayManager.kdm.enable

Whether to enable the KDE display manager.

Default: false

Declared by: [ "/trace/nixos/modules/services/x11/display-managers/kdm.nix" ]

Defined by: [ ]

services.xserver.displayManager.kdm.extraConfig

Options appended to kdmrc, the configuration file of KDM.

Default: ""

Declared by: [ "/trace/nixos/modules/services/x11/display-managers/kdm.nix" ]

Defined by: [ ]

services.xserver.displayManager.session

List of sessions supported with the command used to start each session. Each session script can set the waitPID shell variable to make this script wait until the end of the user session. Each script is used to define either a windows manager or a desktop manager. These can be differentiated by setting the attribute manage either to "window" or "desktop". The list of desktop manager and window manager should appear inside the display manager with the desktop manager name followed by the window manager name.

Default: [ ]

Example: [ { manage = "desktop"; name = "xterm"; start = "\n /nix/store/gi9rlchn1q2hfrs84m7yxkd1izlyidg5-xterm-231/bin/xterm -ls &\n waitPID=$!\n "; } ]

Declared by: [ "/trace/nixos/modules/services/x11/display-managers/default.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/window-managers/default.nix" "/trace/nixos/modules/services/x11/desktop-managers/default.nix" ]

services.xserver.displayManager.slim.defaultUser

The default user to load. If you put a username here you get it automatically loaded into the username field, and the focus is placed on the password.

Default: ""

Example: "login"

Declared by: [ "/trace/nixos/modules/services/x11/display-managers/slim.nix" ]

Defined by: [ ]

services.xserver.displayManager.slim.enable

Whether to enable SLiM as the display manager.

Default: true

Declared by: [ "/trace/nixos/modules/services/x11/display-managers/slim.nix" ]

Defined by: [ ]

services.xserver.displayManager.slim.hideCursor

Hide the mouse cursor on the login screen.

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/services/x11/display-managers/slim.nix" ]

Defined by: [ ]

services.xserver.displayManager.slim.theme

The theme for the SLiM login manager. If not specified, SLiM's default theme is used. See http://slim.berlios.de/themes01.php for a collection of themes.

Default:

Example: (build of slim-wave.tar.gz)

Declared by: [ "/trace/nixos/modules/services/x11/display-managers/slim.nix" ]

Defined by: [ ]

services.xserver.displayManager.xauthBin

Path to the xauth program used by display managers.

Default: "/nix/store/i2xbn38rq1lz3gc1vxcxlcv0jxf31yyq-xauth-1.0.3/bin/xauth"

Declared by: [ "/trace/nixos/modules/services/x11/display-managers/default.nix" ]

Defined by: [ ]

services.xserver.displayManager.xserverArgs

List of arguments for the X server.

Default: [ ]

Example: [ "-ac" "-logverbose" "-nolisten tcp" ]

Declared by: [ "/trace/nixos/modules/services/x11/display-managers/default.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

services.xserver.displayManager.xserverBin

Path to the X server used by display managers.

Default: "/nix/store/a4yk9l1c6w5gs94jgdb8bf1pidcjljif-xorg-server-1.5.3/bin/X"

Declared by: [ "/trace/nixos/modules/services/x11/display-managers/default.nix" ]

Defined by: [ ]

services.xserver.driSupport

Whether to enable accelerated OpenGL rendering through the Direct Rendering Interface (DRI).

Default: true

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.enable

Whether to enable the X server.

Default: false

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.enableTCP

Whether to allow the X server to accept TCP connections.

Default: false

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.exportConfiguration

Whether to symlink the X server configuration under /etc/X11/xorg.conf.

Default: false

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.extraDisplaySettings

Lines to be added to every Display subsection of the Screen section.

Default: ""

Example: "Virtual 2048 2048"

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.isClone

Whether to enable the X server clone mode for dual-head.

Default: true

Example: false

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.layout

Keyboard layout.

Default: "us"

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.moduleSection

Contents of the Module section of the X server configuration file.

Default: ""

Example: "SubSection \"extmod\"\nEndSubsection\n"

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.modules

Packages to be added to the module search path of the X server.

Default: [ ]

Example: [ (build of linuxwacom-0.8.4-1) ]

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/xserver.nix" "/trace/nixos/modules/services/x11/hardware/wacom.nix" "/trace/nixos/modules/services/x11/hardware/synaptics.nix" ]

services.xserver.monitorSection

Contents of the first Monitor section of the X server configuration file.

Default: ""

Example: "HorizSync 28-49"

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

services.xserver.resolutions

The screen resolutions for the X server. The first element is the default resolution.

Default: [ { x = 1024; y = 768; } { x = 800; y = 600; } { x = 640; y = 480; } ]

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.serverLayoutSection

Contents of the ServerLayout section of the X server configuration file.

Default: ""

Example: "Option \"AIGLX\" \"true\"\n"

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/xserver.nix" "/trace/nixos/modules/services/x11/hardware/wacom.nix" "/trace/nixos/modules/services/x11/hardware/synaptics.nix" ]

services.xserver.startSSHAgent

Whether to start the SSH agent when you log in. The SSH agent remembers private keys for you so that you don't have to type in passphrases every time you make an SSH connection. Use ssh-add to add a key to the agent.

Default: true

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.synaptics.dev

Event device for Synaptics touchpad.

Default: "/dev/input/event0"

Declared by: [ "/trace/nixos/modules/services/x11/hardware/synaptics.nix" ]

Defined by: [ ]

services.xserver.synaptics.enable

Whether to enable touchpad support.

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/services/x11/hardware/synaptics.nix" ]

Defined by: [ ]

services.xserver.synaptics.maxSpeed

Cursor speed factor for highest-speed finger motion.

Default: "0.12"

Declared by: [ "/trace/nixos/modules/services/x11/hardware/synaptics.nix" ]

Defined by: [ ]

services.xserver.synaptics.minSpeed

Cursor speed factor for precision finger motion.

Default: "0.06"

Declared by: [ "/trace/nixos/modules/services/x11/hardware/synaptics.nix" ]

Defined by: [ ]

services.xserver.synaptics.twoFingerScroll

Whether to enable two-finger drag-scrolling.

Default: false

Declared by: [ "/trace/nixos/modules/services/x11/hardware/synaptics.nix" ]

Defined by: [ ]

services.xserver.tty

Virtual console for the X server.

Default: 7

Example: 9

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.useXFS

Determines how to connect to the X Font Server.

Default: false

Example: "unix/:7100"

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.videoDriver

The name of the video driver for your graphics card.

Default: "vesa"

Example: "i810"

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.virtualScreen

Virtual screen size for Xrandr.

Default:

Example: { x = 2048; y = 2048; }

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.wacom.device

Device to use.

Default: "/dev/ttyS0"

Declared by: [ "/trace/nixos/modules/services/x11/hardware/wacom.nix" ]

Defined by: [ ]

services.xserver.wacom.enable

Whether to enable the Wacom touchscreen/digitizer.

Default: false

Declared by: [ "/trace/nixos/modules/services/x11/hardware/wacom.nix" ]

Defined by: [ ]

services.xserver.wacom.forceDeviceType

Some models (think touchscreen) require the device type to be specified.

Default: "ISDV4"

Example:

Declared by: [ "/trace/nixos/modules/services/x11/hardware/wacom.nix" ]

Defined by: [ ]

services.xserver.windowManager.compiz.enable

Enable the compiz window manager.

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/services/x11/window-managers/compiz.nix" ]

Defined by: [ ]

services.xserver.windowManager.compiz.renderingFlag

Possibly pass --indierct-rendering to Compiz.

Default: ""

Example: "--indirect-rendering"

Declared by: [ "/trace/nixos/modules/services/x11/window-managers/compiz.nix" ]

Defined by: [ ]

services.xserver.windowManager.default

Default window manager loaded if none have been chosen.

Default: "none"

Example: "wmii"

Declared by: [ "/trace/nixos/modules/services/x11/window-managers/default.nix" ]

Defined by: [ ]

services.xserver.windowManager.kwm.enable

Enable the kwm window manager.

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/services/x11/window-managers/kwm.nix" ]

Defined by: [ ]

services.xserver.windowManager.metacity.enable

Enable the metacity window manager.

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/services/x11/window-managers/metacity.nix" ]

Defined by: [ ]

services.xserver.windowManager.session

Internal option used to add some common line to window manager scripts before forwarding the value to the displayManager.

Default: [ ]

Example: [ { name = "wmii"; start = "..."; } ]

Declared by: [ "/trace/nixos/modules/services/x11/window-managers/default.nix" ]

Defined by: [ "/trace/nixos/modules/services/x11/window-managers/xmonad.nix" "/trace/nixos/modules/services/x11/window-managers/wmii.nix" "/trace/nixos/modules/services/x11/window-managers/twm.nix" "/trace/nixos/modules/services/x11/window-managers/none.nix" "/trace/nixos/modules/services/x11/window-managers/metacity.nix" "/trace/nixos/modules/services/x11/window-managers/kwm.nix" "/trace/nixos/modules/services/x11/window-managers/compiz.nix" ]

services.xserver.windowManager.twm.enable

Enable the twm window manager.

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/services/x11/window-managers/twm.nix" ]

Defined by: [ ]

services.xserver.windowManager.wmii.enable

Enable the wmii window manager.

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/services/x11/window-managers/wmii.nix" ]

Defined by: [ ]

services.xserver.windowManager.xmonad.enable

Enable the xmonad window manager.

Default: false

Example: true

Declared by: [ "/trace/nixos/modules/services/x11/window-managers/xmonad.nix" ]

Defined by: [ ]

services.xserver.xkbModel

Keyboard model.

Default: "pc104"

Example: "presario"

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.xserver.xkbOptions

X keyboard options; layout switching goes here.

Default: ""

Example: "grp:caps_toggle, grp_led:scroll"

Declared by: [ "/trace/nixos/modules/services/x11/xserver.nix" ]

Defined by: [ ]

services.zabbixAgent.enable

Whether to run the Zabbix monitoring agent on this machine. It will send monitoring data to a Zabbix server.

Default: false

Declared by: [ "/trace/nixos/modules/services/monitoring/zabbix-agent.nix" ]

Defined by: [ ]

services.zabbixAgent.server

The IP address or hostname of the Zabbix server to connect to.

Default: "127.0.0.1"

Declared by: [ "/trace/nixos/modules/services/monitoring/zabbix-agent.nix" ]

Defined by: [ ]

services.zabbixServer.enable

Whether to run the Zabbix server on this machine.

Default: false

Declared by: [ "/trace/nixos/modules/services/monitoring/zabbix-server.nix" ]

Defined by: [ ]

sound.enable

Whether to enable ALSA sound.

Default: true

Declared by: [ "/trace/nixos/modules/services/audio/alsa.nix" ]

Defined by: [ ]

swapDevices

The swap devices and swap files. These must have been initialised using mkswap. Each element should be an attribute set specifying either the path of the swap device or file (device) or the label of the swap device (label, see mkswap -L). Using a label is recommended.

Default: [ ]

Example: [ { device = "/dev/hda7"; } { device = "/var/swapfile"; } { label = "bigswap"; } ]

Declared by: [ "/trace/nixos/modules/tasks/swap.nix" ]

Defined by: [ ]

swapDevices.*.device

Path of the device.

Default:

Example: "/dev/sda3"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

swapDevices.*.label

Label of the device. Can be used instead of device.

Default:

Example: "swap"

Declared by: [ "<unknow location>" ]

Defined by: [ ]

system.activationScripts

Activate the new configuration (i.e., update /etc, make accounts, and so on).

Default: [ ]

Example: { stdio = { deps = [ ] ; text = "\n # Needed by some programs.\n ln -sfn /proc/self/fd /dev/fd\n ln -sfn /proc/self/fd/0 /dev/stdin\n ln -sfn /proc/self/fd/1 /dev/stdout\n ln -sfn /proc/self/fd/2 /dev/stderr\n "; } ; }

Declared by: [ "/trace/nixos/modules/system/activation/activation-script.nix" ]

Defined by: [ "/trace/nixos/modules/system/etc/etc.nix" "/trace/nixos/modules/system/activation/activation-script.nix" "/trace/nixos/modules/security/setuid-wrappers.nix" "/trace/nixos/modules/security/policy-kit.nix" "/trace/nixos/modules/config/users-groups.nix" ]

system.build

Attribute set of derivations used to setup the system.

Default: { }

Declared by: [ "/trace/nixos/modules/system/activation/top-level.nix" ]

Defined by: [ "/trace/nixos/modules/system/etc/etc.nix" "/trace/nixos/modules/system/boot/stage-2.nix" "/trace/nixos/modules/system/boot/stage-1.nix" "/trace/nixos/modules/system/boot/kernel.nix" "/trace/nixos/modules/system/activation/top-level.nix" "/trace/nixos/modules/programs/bash/bash.nix" "/trace/nixos/modules/installer/tools/tools.nix" "/trace/nixos/modules/installer/grub/grub.nix" "/trace/nixos/modules/config/fonts.nix" ]

system.modulesTree

Tree of kernel modules. This includes the kernel, plus modules built outside of the kernel. Combine these into a single tree of symlinks because modprobe only supports one directory.

Default: [ ]

Declared by: [ "/trace/nixos/modules/system/boot/kernel.nix" ]

Defined by: [ "/trace/nixos/modules/system/boot/kernel.nix" ]

system.nssModules

Search path for NSS (Name Service Switch) modules. This allows several DNS resolution methods to be specified via /etc/nsswitch.conf.

Default: [ ]

Declared by: [ "/trace/nixos/modules/config/nsswitch.nix" ]

Defined by: [ "/trace/nixos/modules/services/networking/avahi-daemon.nix" ]

system.sbin.modprobe

Wrapper around modprobe that sets the path to the modules tree.

Default: (build of modprobe)

Declared by: [ "/trace/nixos/modules/system/boot/kernel.nix" ]

Defined by: [ ]

system.sbin.mount

Package containing mount and umount.

Default: (build of )

Declared by: [ "/trace/nixos/modules/tasks/filesystems.nix" ]

Defined by: [ ]

tests.upstartJobs

Make it easier to build individual Upstart jobs. (e.g., nix-build /etc/nixos/nixos -A tests.upstartJobs.xserver).

Default: { }

Declared by: [ "/trace/nixos/modules/system/upstart/upstart.nix" ]

Defined by: [ "/trace/nixos/modules/system/upstart/upstart.nix" ]

time.timeZone

The time zone used when displaying times and dates.

Default: "CET"

Example: "America/New_York"

Declared by: [ "/trace/nixos/modules/config/timezone.nix" ]

Defined by: [ ]

users.defaultUserShell

This option defined the default shell assigned to user accounts. This must not be a store path, since the path is used outside the store (in particular in /etc/passwd). Rather, it should be the path of a symlink that points to the actual shell in the Nix store.

Default: "/var/run/current-system/sw/bin/bash"

Declared by: [ "/trace/nixos/modules/programs/pwdutils/pwdutils.nix" ]

Defined by: [ ]

users.extraGroups

Additional groups to be created automatically by the system.

Default: [ ]

Example: [ { gid = 1001; name = "students"; } ]

Declared by: [ "/trace/nixos/modules/config/users-groups.nix" ]

Defined by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" "/trace/nixos/modules/services/system/dbus.nix" "/trace/nixos/modules/services/scheduling/atd.nix" "/trace/nixos/modules/services/networking/vsftpd.nix" "/trace/nixos/modules/services/networking/portmap.nix" "/trace/nixos/modules/services/networking/bitlbee.nix" "/trace/nixos/modules/services/networking/avahi-daemon.nix" "/trace/nixos/modules/services/network-filesystems/samba.nix" "/trace/nixos/modules/services/misc/gpsd.nix" "/trace/nixos/modules/services/mail/postfix.nix" "/trace/nixos/modules/services/mail/dovecot.nix" "/trace/nixos/modules/services/hardware/hal.nix" "/trace/nixos/modules/services/databases/postgresql.nix" "/trace/nixos/modules/services/audio/pulseaudio.nix" "/trace/nixos/modules/services/audio/alsa.nix" ]

users.extraUsers

Additional user accounts to be created automatically by the system.

Default: [ ]

Example: [ { createHome = true; description = "Alice"; extraGroups = [ "wheel" ] ; group = "users"; home = "/home/alice"; name = "alice"; password = "foobar"; shell = "/bin/sh"; uid = 1234; } ]

Declared by: [ "/trace/nixos/modules/config/users-groups.nix" ]

Defined by: [ "/trace/nixos/modules/services/web-servers/apache-httpd/default.nix" "/trace/nixos/modules/services/system/nscd.nix" "/trace/nixos/modules/services/system/dbus.nix" "/trace/nixos/modules/services/scheduling/atd.nix" "/trace/nixos/modules/services/networking/vsftpd.nix" "/trace/nixos/modules/services/networking/ssh/sshd.nix" "/trace/nixos/modules/services/networking/portmap.nix" "/trace/nixos/modules/services/networking/ntpd.nix" "/trace/nixos/modules/services/networking/gnunet.nix" "/trace/nixos/modules/services/networking/bitlbee.nix" "/trace/nixos/modules/services/networking/avahi-daemon.nix" "/trace/nixos/modules/services/network-filesystems/samba.nix" "/trace/nixos/modules/services/monitoring/zabbix-server.nix" "/trace/nixos/modules/services/monitoring/zabbix-agent.nix" "/trace/nixos/modules/services/monitoring/nagios/default.nix" "/trace/nixos/modules/services/misc/gpsd.nix" "/trace/nixos/modules/services/mail/postfix.nix" "/trace/nixos/modules/services/mail/dovecot.nix" "/trace/nixos/modules/services/hardware/hal.nix" "/trace/nixos/modules/services/databases/postgresql.nix" "/trace/nixos/modules/services/databases/mysql.nix" "/trace/nixos/modules/services/audio/pulseaudio.nix" ]

users.ldap.base

The distinguished name of the search base.

Default: none

Example: "dc=example,dc=org"

Declared by: [ "/trace/nixos/modules/config/ldap.nix" ]

Defined by: [ ]

users.ldap.enable

Whether to enable authentication against an LDAP server.

Default: false

Declared by: [ "/trace/nixos/modules/config/ldap.nix" ]

Defined by: [ ]

users.ldap.server

The URL of the LDAP server.

Default: none

Example: "ldap://ldap.example.org/"

Declared by: [ "/trace/nixos/modules/config/ldap.nix" ]

Defined by: [ ]

users.ldap.useTLS

If enabled, use TLS (encryption) over an LDAP (port 389) connection. The alternative is to specify an LDAPS server (port 636) in users.ldap.server or to forego security.

Default: false

Declared by: [ "/trace/nixos/modules/config/ldap.nix" ]

Defined by: [ ]

NixOS Manual

Eelco Dolstra

Preface

Chapter 1. Installation

1.1. Building the installation CD

1.2. Installation

Note

1.3. Changing the configuration

1.4. Keeping NixOS up to date

Chapter 2. Configuration in home directory

2.1. Compiz Fusion

2.2. Pidgin-LaTeX

Chapter 3. Troubleshooting

3.1. Debugging the boot process

3.2. Safe mode

3.3. Maintenance mode

Chapter 4. Development

4.1. Extending NixOS

4.2. Building specific parts of NixOS

4.3. Building your own NixOS CD

4.4. Testing the installer

4.5. Testing the initrd

Chapter 5. List of Options

4.5. Testing the `initrd`