Nix configuration fileA number of persistent settings of Nix are stored in the file
sysconfdir/nix/nix.conf.
This file is a list of name =
value pairs, one per line.
Comments start with a # character. An example
configuration file is shown in .Nix configuration file
gc-keep-outputs = true # Nice for developers
gc-keep-derivations = true # Idem
env-keep-derivations = false
The following variables are currently available:
gc-keep-outputsIf true, the garbage collector
will keep the outputs of non-garbage derivations. If
false (default), outputs will be deleted unless
they are GC roots themselves (or reachable from other roots).In general, outputs must be registered as roots separately.
However, even if the output of a derivation is registered as a
root, the collector will still delete store paths that are used
only at build time (e.g., the C compiler, or source tarballs
downloaded from the network). To prevent it from doing so, set
this option to true.gc-keep-derivationsIf true (default), the garbage
collector will keep the derivations from which non-garbage store
paths were built. If false, they will be
deleted unless explicitly registered as a root (or reachable from
other roots).Keeping derivation around is useful for querying and
traceability (e.g., it allows you to ask with what dependencies or
options a store path was built), so by default this option is on.
Turn it off to safe a bit of disk space (or a lot if
gc-keep-outputs is also turned on).env-keep-derivationsIf false (default), derivations
are not stored in Nix user environments. That is, the derivation
any build-time-only dependencies may be garbage-collected.If true, when you add a Nix derivation to
a user environment, the path of the derivation is stored in the
user environment. Thus, the derivation will not be
garbage-collected until the user environment generation is deleted
(nix-env --delete-generations). To prevent
build-time-only dependencies from being collected, you should also
turn on gc-keep-outputs.The difference between this option and
gc-keep-derivations is that this one is
“sticky”: it applies to any user environment created while this
option was enabled, while gc-keep-derivations
only applies at the moment the garbage collector is
run.build-max-jobsThis 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). It can be overriden using the ()
command line switch.build-coresSets the value of the
NIX_BUILD_CORES environment variable in the
invocation of builders. Builders can use this variable at their
discretion to control the maximum amount of parallelism. For
instance, in Nixpkgs, if the derivation attribute
enableParallelBuilding is set to
true, the builder passes the
flag to GNU Make.
It can be overriden using the command line switch and
defaults to 1. The value 0
means that the builder should use all available CPU cores in the
system.build-max-silent-timeThis option defines the maximum number of seconds that a
builder can go without producing any data on standard output or
standard error. This is useful (for instance in a automated
build system) to catch builds that are stuck in an infinite
loop, or to catch remote builds that are hanging due to network
problems. It can be overriden using the command
line switch.The value 0 means that there is no
timeout. This is also the default.build-timeoutThis option defines the maximum number of seconds that a
builder can run. This is useful (for instance in a automated
build system) to catch builds that are stuck in an infinite loop
but keep writing to their standard output or standard error. It
can be overriden using the command line
switch.The value 0 means that there is no
timeout. This is also the default.build-users-groupThis options specifies the Unix group containing
the Nix build user accounts. In multi-user Nix installations,
builds should not be performed by the Nix account since that would
allow users to arbitrarily modify the Nix store and database by
supplying specially crafted builders; and they cannot be performed
by the calling user since that would allow him/her to influence
the build result.Therefore, if this option is non-empty and specifies a valid
group, builds will be performed under the user accounts that are a
member of the group specified here (as listed in
/etc/group). Those user accounts should not
be used for any other purpose!Nix will never run two builds under the same user account at
the same time. This is to prevent an obvious security hole: a
malicious user writing a Nix expression that modifies the build
result of a legitimate Nix expression being built by another user.
Therefore it is good to have as many Nix build user accounts as
you can spare. (Remember: uids are cheap.)The build users should have permission to create files in
the Nix store, but not delete them. Therefore,
/nix/store should be owned by the Nix
account, its group should be the group specified here, and its
mode should be 1775.If the build users group is empty, builds will be performed
under the uid of the Nix process (that is, the uid of the caller
if NIX_REMOTE is empty, the uid under which the Nix
daemon runs if NIX_REMOTE is
daemon, or the uid that owns the setuid
nix-worker program if NIX_REMOTE
is slave). Obviously, this should not be used
in multi-user settings with untrusted users.build-use-chrootIf set to true, builds will be
performed in a chroot environment, i.e., the
build will be isolated from the normal file system hierarchy and
will only see the Nix store, the temporary build directory, and
the directories configured with the build-chroot-dirs
option (such as /proc and
/dev). This is useful to prevent undeclared
dependencies on files in directories such as
/usr/bin.The use of a chroot requires that Nix is run as root (but
you can still use the “build users” feature to
perform builds under different users than root). Currently,
chroot builds only work on Linux because Nix uses “bind mounts” to
make the Nix store and other directories available inside the
chroot.build-use-substitutesIf set to true (default), Nix
will use binary substitutes if available. This option can be
disabled to force building from source.build-chroot-dirsWhen builds are performed in a chroot environment,
Nix will mount (using mount --bind on Linux)
some directories from the normal file system hierarchy inside the
chroot. These are the Nix store, the temporary build directory
(usually
/tmp/nix-pid-number)
and the directories listed here. The default is dev
/proc. Files in /dev (such as
/dev/null) are needed by many builds, and
some files in /proc may also be needed
occasionally.The value used on NixOS is
build-use-chroot = /dev /proc /bin
to make the /bin/sh symlink available (which
is still needed by many builders).build-cache-failuresIf set to true, Nix will
“cache” build failures, meaning that it will remember (in its
database) that a derivation previously failed. If you then try to
build the derivation again, Nix will immediately fail rather than
perform the build again. Failures in fixed-output derivations
(such as fetchurl calls) are never cached.
The “failed” status of a derivation can be cleared using
nix-store --clear-failed-paths. By default,
failure caching is disabled.systemThis option specifies the canonical Nix system
name of the current installation, such as
i686-linux or
powerpc-darwin. Nix can only build derivations
whose system attribute equals the value
specified here. In general, it never makes sense to modify this
value from its default, since you can use it to ‘lie’ about the
platform you are building on (e.g., perform a Mac OS build on a
Linux machine; the result would obviously be wrong). It only
makes sense if the Nix binaries can run on multiple platforms,
e.g., ‘universal binaries’ that run on powerpc-darwin and
i686-darwin.It defaults to the canonical Nix system name detected by
configure at build time.fsync-metadataIf set to true, changes to the
Nix store metadata (in /nix/var/nix/db) are
synchronously flushed to disk. This improves robustness in case
of system crashes, but reduces performance. The default is
true.