about summary refs log tree commit diff
path: root/nixos/doc/manual/development/importing-modules.xml
blob: 1c6a5671eda8bb6397753dad58d9d15b790bc970 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<section xmlns="http://docbook.org/ns/docbook"
         xmlns:xlink="http://www.w3.org/1999/xlink"
         xmlns:xi="http://www.w3.org/2001/XInclude"
         version="5.0"
         xml:id="sec-importing-modules">
 <title>Importing Modules</title>

 <para>
  Sometimes NixOS modules need to be used in configuration but exist outside of
  Nixpkgs. These modules can be imported:
 </para>

<programlisting>
{ config, lib, pkgs, ... }:

{
  imports =
    [ # Use a locally-available module definition in
      # ./example-module/default.nix
        ./example-module
    ];

  services.exampleModule.enable = true;
}
</programlisting>

 <para>
  The environment variable <literal>NIXOS_EXTRA_MODULE_PATH</literal> is an
  absolute path to a NixOS module that is included alongside the Nixpkgs NixOS
  modules. Like any NixOS module, this module can import additional modules:
 </para>

<programlisting>
# ./module-list/default.nix
[
  ./example-module1
  ./example-module2
]
</programlisting>

<programlisting>
# ./extra-module/default.nix
{ imports = import ./module-list.nix; }
</programlisting>

<programlisting>
# NIXOS_EXTRA_MODULE_PATH=/absolute/path/to/extra-module
{ config, lib, pkgs, ... }:

{
  # No `imports` needed

  services.exampleModule1.enable = true;
}
</programlisting>
</section>