···

       
1
       
1
       
+
       
# Building Images with `nixos-rebuild build-image` {#sec-image-nixos-rebuild-build-image}

     

       
2
       
2
       
+
       


     

       
3
       
3
       
+
       
Nixpkgs contains a variety of modules to build custom images for different virtualization platforms and cloud providers, such as e.g. `amazon-image.nix` and `proxmox-lxc.nix`.

     

       
4
       
4
       
+
       


     

       
5
       
5
       
+
       
While those can be imported individually, `system.build.images` provides an attribute set mapping variant names to image derivations. Available variants are defined - end extendable - in `image.modules`, an attribute set mapping variant names to a list of NixOS modules.

     

       
6
       
6
       
+
       


     

       
7
       
7
       
+
       
All of those images can be built via both, their `system.build.image` attribute, and the CLI `nixos-rebuild build-image`. To build i.e. an Amazon image from your existing NixOS configuration:

     

       
8
       
8
       
+
       


     

       
9
       
9
       
+
       
```ShellSession

     

       
10
       
10
       
+
       
$ nixos-rebuild build-image --image-variant amazon

     

       
11
       
11
       
+
       
$ ls result

     

       
12
       
12
       
+
       
nixos-image-amazon-25.05pre-git-x86_64-linux.vhd  nix-support

     

       
13
       
13
       
+
       
```

     

       
14
       
14
       
+
       


     

       
15
       
15
       
+
       
To get a list of all variants available, run `nixos-rebuild build-image` without arguments.

     

       
16
       
16
       
+
       


     

···

       
1
       
1
       
 
       
# Building a NixOS (Live) ISO {#sec-building-image}

     

       
2
       
2
       
 
       


     

       
3
       
3
       
 
       
Default live installer configurations are available inside `nixos/modules/installer/cd-dvd`.

     

       
4
       
4
       
-
       
For building other system images, [nixos-generators] is a good place to start looking at.

     

       
4
       
4
       
+
       
For building other system images, see [Building Images with `nixos-rebuild build-image`](#sec-image-nixos-rebuild-build-image).

     

       
5
       
5
       
 
       


     

       
6
       
6
       
 
       
You have two options:

     

       
7
       
7
       
 
       


     
···

       
13
       
13
       
 
       


     

       
14
       
14
       
 
       
However, if you are confident, you can opt to override those

     

       
15
       
15
       
 
       
enforced values with `mkForce`.

     

       
16
       
16
       
-
       


     

       
17
       
17
       
-
       
[nixos-generators]: https://github.com/nix-community/nixos-generators

     

       
18
       
16
       
 
       


     

       
19
       
17
       
 
       
## Practical Instructions {#sec-building-image-instructions}

     

       
20
       
18
       
 
       


     

···

       
8
       
8
       
 
       
changing-config.chapter.md

     

       
9
       
9
       
 
       
upgrading.chapter.md

     

       
10
       
10
       
 
       
building-nixos.chapter.md

     

       
11
       
11
       
+
       
building-images-via-nixos-rebuild-build-image.chapter.md

     

       
11
       
12
       
 
       
building-images-via-systemd-repart.chapter.md

     

       
12
       
13
       
 
       
```

     

···

       
167
       
167
       
 
       
  "sec-building-image-tech-notes": [

     

       
168
       
168
       
 
       
    "index.html#sec-building-image-tech-notes"

     

       
169
       
169
       
 
       
  ],

     

       
170
       
170
       
+
       
  "sec-image-nixos-rebuild-build-image": [

     

       
171
       
171
       
+
       
    "index.html#sec-image-nixos-rebuild-build-image"

     

       
172
       
172
       
+
       
  ],

     

       
170
       
173
       
 
       
  "sec-image-repart": [

     

       
171
       
174
       
 
       
    "index.html#sec-image-repart"

     

       
172
       
175
       
 
       
  ],