Distributed build: Difference between revisions

Line 1:

~~Sometimes you want to use a faster~~ machine for ~~building a nix~~ derivation you want to ~~use on a slower one~~. ~~If you have ssh~~ access to a machine where Nix ~~(not necessarily NixOS) is~~ installed, ~~you can offload building to this machine~~.

When your '''local machine''' is too slow or doesn't have the right CPU architecture or operating system for the Nix derivation you want to build, you can delegate the build to some other '''remote machine'''. You only '''need SSH access to the remote machine''' and both machines need to have the [https://nixos.org/download/ Nix package manager installed] ; the remote machine '''doesn't need to run NixOS''', any Linux distro like Debian or where Nix can be installed, should work.

There is a dedicated chapter in the [https://nixos.org/manual/nix/stable/advanced-topics/distributed-builds.html Nix Manual].

There is a dedicated chapter in the [https://nixos.org/manual/nix/stable/advanced-topics/distributed-builds.html Nix Manual] but it may be difficult to follow for beginners.

This is a step-by-step guide to setting up distributed builds, ~~that~~ includes some SSH tips that are out of scope for the Nix Manual chapter.

This is an easier, step-by-step guide to setting up a "'''remote builder'''" machine to create distributed builds, and includes some SSH tips that are out of scope for the Nix Manual chapter.

== Prerequisites ==

SSH access to the remote builder must be set up to enable distribution of builds to it. The table below lists SSH access requirements for most scenarios.

The main tool to connect to a remote builder, exchange files and trigger builds is SSH.

So SSH access to the remote builder must be set up to enable distribution of builds to it. The table below lists SSH access requirements for most scenarios.

{| class="wikitable" style="margin:auto"

@@ Line 1: / Line 1: @@
-Sometimes you want to use a faster machine for building a nix derivation you want to use on a slower one. If you have ssh access to a machine where Nix (not necessarily NixOS) is installed, you can offload building to this machine.
+When your '''local machine''' is too slow or doesn't have the right CPU architecture or operating system for the Nix derivation you want to build, you can delegate the build to some other '''remote machine'''. You only '''need SSH access to the remote machine''' and both machines need to have the [https://nixos.org/download/ Nix package manager installed] ; the remote machine '''doesn't need to run NixOS''', any Linux distro like Debian or where Nix can be installed, should work.
-There is a dedicated chapter in the [https://nixos.org/manual/nix/stable/advanced-topics/distributed-builds.html Nix Manual].
+There is a dedicated chapter in the [https://nixos.org/manual/nix/stable/advanced-topics/distributed-builds.html Nix Manual] but it may be difficult to follow for beginners.
-This is a step-by-step guide to setting up distributed builds, that includes some SSH tips that are out of scope for the Nix Manual chapter.
+This is an easier, step-by-step guide to setting up a "'''remote builder'''" machine to create distributed builds, and includes some SSH tips that are out of scope for the Nix Manual chapter.
 == Prerequisites ==
-SSH access to the remote builder must be set up to enable distribution of builds to it. The table below lists SSH access requirements for most scenarios.
+The main tool to connect to a remote builder, exchange files and trigger builds is SSH.
+So SSH access to the remote builder must be set up to enable distribution of builds to it. The table below lists SSH access requirements for most scenarios.
 {| class="wikitable" style="margin:auto"