Distributed build - Revision history

Mse63: corrected speedFactor comment

2026-04-13T11:49:15Z

corrected speedFactor comment

← Older revision		Revision as of 11:49, 13 April 2026
Line 145:		Line 145:
	# default is 1 but may keep the builder idle in between builds		# default is 1 but may keep the builder idle in between builds
	maxJobs = 3;		maxJobs = 3;
	# how fast is the builder compared to ~~your local machine~~		# how fast is the builder compared to other remote builders
	speedFactor = 2;		speedFactor = 2;
	supportedFeatures = [ "nixos-test" "benchmark" "big-parallel" "kvm" ];		supportedFeatures = [ "nixos-test" "benchmark" "big-parallel" "kvm" ];

Alexandru Tocar: Changed `nix store ping` to `nix store info`, because of the warning: 'ping' is a deprecated alias for 'info'.

2025-11-28T23:12:22Z

Changed `nix store ping` to `nix store info`, because of the warning: 'ping' is a deprecated alias for 'info'.

← Older revision		Revision as of 23:12, 28 November 2025
Line 40:		Line 40:
	{{Tip\|The best test to check that the SSH access works for Nix is to run on your local machine:		{{Tip\|The best test to check that the SSH access works for Nix is to run on your local machine:

	<code>nix store ~~ping~~ --store ssh://<REMOTE-BUILDER></code>		<code>nix store info --store ssh://<REMOTE-BUILDER></code>

	Where <code><REMOTE-BUILDER></code> is the remote builder's IP address, host address or whatever name you configure in ~/.ssh/config or /root/.ssh/config, including the user@ prefix.}}		Where <code><REMOTE-BUILDER></code> is the remote builder's IP address, host address or whatever name you configure in ~/.ssh/config or /root/.ssh/config, including the user@ prefix.}}

Arch is the best: Link to Nixos-rebuild#Deploying_on_other_machines

2025-10-21T17:50:16Z

Link to Nixos-rebuild#Deploying_on_other_machines

← Older revision		Revision as of 17:50, 21 October 2025
Line 249:		Line 249:
	* I can ping the store as root, but I'm getting "broken pipe" errors when trying to distribute.		* I can ping the store as root, but I'm getting "broken pipe" errors when trying to distribute.
	** You may have hit bug {{Issue\|46038}}. Add <code>nix.distributedBuilds = true;</code> to <code>configuration.nix</code> and <code>nixos-rebuild switch</code>.		** You may have hit bug {{Issue\|46038}}. Add <code>nix.distributedBuilds = true;</code> to <code>configuration.nix</code> and <code>nixos-rebuild switch</code>.

			== Tips and tricks ==

			=== One-time remote build ===

			For a quick, one-time remote build without needing to change any system settings, see [[Nixos-rebuild#Deploying_on_other_machines]].

	== See also ==		== See also ==

SigmaSquadron: /* Modify the local machine's Nix config to know about the remote machine. */ Remove erroneous bold header

2025-04-12T21:23:28Z

Modify the local machine's Nix config to know about the remote machine.: Remove erroneous bold header

← Older revision		Revision as of 21:23, 12 April 2025
Line 112:		Line 112:
	You may also want to make nix on '''the remote machine''' trust that new user by adding it to {{ic\|nix.settings.trusted-users}} if it's using NixOS, or by manually adding <code><nowiki>trusted-users = nixremote</nowiki></code> to {{ic\|/etc/nix/nix.conf}}.		You may also want to make nix on '''the remote machine''' trust that new user by adding it to {{ic\|nix.settings.trusted-users}} if it's using NixOS, or by manually adding <code><nowiki>trusted-users = nixremote</nowiki></code> to {{ic\|/etc/nix/nix.conf}}.

	== ~~'''~~Modify the local machine's Nix config to know about the remote machine~~'''~~. ==		== Modify the local machine's Nix config to know about the remote machine. ==
	The Nix package manager '''on your local machine''' '''needs to know that the remote builder exists''' and what its ''supported features'' are. See [https://nixos.org/manual/nix/stable/command-ref/conf-file#conf-system-features official supportedFeatures documentation].		The Nix package manager '''on your local machine''' '''needs to know that the remote builder exists''' and what its ''supported features'' are. See [https://nixos.org/manual/nix/stable/command-ref/conf-file#conf-system-features official supportedFeatures documentation].

SigmaSquadron: /* Setting up SSH */ Minor wikicode formatting

2025-04-12T21:22:29Z

Setting up SSH: Minor wikicode formatting

← Older revision		Revision as of 21:22, 12 April 2025
Line 40:		Line 40:
	{{Tip\|The best test to check that the SSH access works for Nix is to run on your local machine:		{{Tip\|The best test to check that the SSH access works for Nix is to run on your local machine:

	nix store ping --store ssh://<REMOTE-BUILDER>		<code>nix store ping --store ssh://<REMOTE-BUILDER></code>

	Where <REMOTE-BUILDER> is the remote builder's IP address, host address or whatever name you configure in ~/.ssh/config or /root/.ssh/config, including the user@ prefix.}}		Where <code><REMOTE-BUILDER></code> is the remote builder's IP address, host address or whatever name you configure in ~/.ssh/config or /root/.ssh/config, including the user@ prefix.}}

	An alternative check is:		An alternative check is:

Mic92: imported from old wiki

2024-09-04T07:08:44Z

imported from old wiki

← Older revision		Revision as of 07:08, 4 September 2024
Line 251:		Line 251:

	== See also ==		== See also ==
	* [https://github.com/NixOS/nix/blob/~~master~~/tests/remote-builds.nix#~~L46~~-~~L58~~ The NixOS Remote Builds Test Case]		* [https://github.com/NixOS/nix/blob/a6e6da3b0c579fc540acb00748fe3fd1858b9d99/tests/nixos/remote-builds.nix#L11-L21 The NixOS Remote Builds Test Case]
	* [https://nixos.org/nix-dev/2015-September/018255.html Mail to nixos-dev about setting up remote builds by Russell O'Connor]		* [https://nixos.org/nix-dev/2015-September/018255.html Mail to nixos-dev about setting up remote builds by Russell O'Connor]
	* [https://gist.github.com/danbst/09c3f6cd235ae11ccd03215d4542f7e7 A step-by-step guide on remote Firefox building through bastion host]		* [https://gist.github.com/danbst/09c3f6cd235ae11ccd03215d4542f7e7 A step-by-step guide on remote Firefox building through bastion host]

Jopejoe1: Use modular settings option instead of multi-line string option

2024-08-10T09:07:30Z

Use modular settings option instead of multi-line string option

← Older revision		Revision as of 09:07, 10 August 2024
Line 153:		Line 153:
	nix.distributedBuilds = true;		nix.distributedBuilds = true;
	# optional, useful when the builder has a faster internet connection than yours		# optional, useful when the builder has a faster internet connection than yours
	nix.~~extraOptions~~ = ''		nix.settings = {
	builders-use-substitutes = true		builders-use-substitutes = true;
	'';		};
	}		}
	</nowiki>}}		</nowiki>}}

Rszyma: fix formatting + fix `-L` flag not working in `useradd` + add info to chown `~nixremote/.ssh` dir

2024-05-15T00:15:21Z

fix formatting + fix `-L` flag not working in `useradd` + add info to chown `~nixremote/.ssh` dir

← Older revision		Revision as of 00:15, 15 May 2024
Line 66:		Line 66:
	For the common case where your local Nix is installed system-wide in multi-user mode, create a user on the '''remote''' machine that will have an unwriteable home directory, with a {{ic\|~/.ssh/authorized_keys}} in it, that will allow SSH access to that user without a passphrase. The steps are:		For the common case where your local Nix is installed system-wide in multi-user mode, create a user on the '''remote''' machine that will have an unwriteable home directory, with a {{ic\|~/.ssh/authorized_keys}} in it, that will allow SSH access to that user without a passphrase. The steps are:

	- {{ic\|ssh}} to the remote builder.		* {{ic\|ssh}} to the remote builder.
	- Run (requires privileges) {{ic\|useradd -m -L ~~nixremote~~}} ~~where~~ {{ic\|-L}} locks the user such that nobody will be able to {{ic\|su}} to it~~, and~~ {{ic\|-m}} ~~makes~~ sure ~~a home directory is created for the~~ {{ic\|nixremote}} user.		* Run (requires privileges) {{ic\|useradd -m nixremote}}; {{ic\|-m}} makes sure a home directory is created for the {{ic\|nixremote}} user.
	~~- Run (requires privileges)~~ {{ic\|~~mkdir ~nixremote/.ssh~~}}.		* Run (requires privileges) {{ic\|usermod nixremote -L}}; {{ic\|-L}} locks the user such that nobody will be able to {{ic\|su}} to it
			* Run (requires privileges) {{ic\|mkdir ~nixremote/.ssh}}. Make sure to run this command as {{ic\|nixremote}} user or {{ic\|chown}} it afterwards

	If your '''remote builder''' has Nix installed system-wide in multi-user mode, but you're not running NixOS, '''you may need to add something like the following to your''' {{ic\|/etc/ssh/sshd_config}} on this remote machine:		If your '''remote builder''' has Nix installed system-wide in multi-user mode, but you're not running NixOS, '''you may need to add something like the following to your''' {{ic\|/etc/ssh/sshd_config}} on this remote machine:

Malteneuss: Rephrase ssh test

2024-05-11T07:01:49Z

Rephrase ssh test

← Older revision		Revision as of 07:01, 11 May 2024
Line 38:		Line 38:
	The thing to know about the '''"Multi-user"''' installation is that '''Nix is installed with a "nix-daemon" background process that runs as root''' and actually manages the builds on your behalf. So when you call '''"nix build ..." as a non-root user, this is delegated to the nix-daemon''' process, which runs as root. And this process can further delegate the build to a remote builder; that's why the '''local machine's root user''' needs the SSH access.		The thing to know about the '''"Multi-user"''' installation is that '''Nix is installed with a "nix-daemon" background process that runs as root''' and actually manages the builds on your behalf. So when you call '''"nix build ..." as a non-root user, this is delegated to the nix-daemon''' process, which runs as root. And this process can further delegate the build to a remote builder; that's why the '''local machine's root user''' needs the SSH access.

	{{Tip\|The best ~~litmus~~ test to ~~ensure~~ that the SSH access works for ~~remote~~ Nix ~~builds~~ is:		{{Tip\|The best test to check that the SSH access works for Nix is to run on your local machine:

	nix store ping --store ssh://<REMOTE-BUILDER>		nix store ping --store ssh://<REMOTE-BUILDER>

Malteneuss: Add small explanation for ssh-ng

2024-05-11T06:57:49Z

Add small explanation for ssh-ng

← Older revision		Revision as of 06:57, 11 May 2024
Line 140:		Line 140:
	# systems = ["x86_64-linux" "aarch64-linux" "riscv64-linux"];		# systems = ["x86_64-linux" "aarch64-linux" "riscv64-linux"];
	system = "x86_64-linux";		system = "x86_64-linux";
			# Nix custom ssh-variant that avoids lots of "trusted-users" settings pain
	protocol = "ssh-ng";		protocol = "ssh-ng";
	# default is 1 but may keep the builder idle in between builds		# default is 1 but may keep the builder idle in between builds

← Older revision		Revision as of 00:15, 15 May 2024
Line 66:		Line 66:
	For the common case where your local Nix is installed system-wide in multi-user mode, create a user on the '''remote''' machine that will have an unwriteable home directory, with a {{ic\|~/.ssh/authorized_keys}} in it, that will allow SSH access to that user without a passphrase. The steps are:		For the common case where your local Nix is installed system-wide in multi-user mode, create a user on the '''remote''' machine that will have an unwriteable home directory, with a {{ic\|~/.ssh/authorized_keys}} in it, that will allow SSH access to that user without a passphrase. The steps are:

	- {{ic\|ssh}} to the remote builder.		* {{ic\|ssh}} to the remote builder.
	- Run (requires privileges) {{ic\|useradd -m -L ~~nixremote~~}} ~~where~~ {{ic\|-L}} locks the user such that nobody will be able to {{ic\|su}} to it~~, and~~ {{ic\|-m}} ~~makes~~ sure ~~a home directory is created for the~~ {{ic\|nixremote}} user.		* Run (requires privileges) {{ic\|useradd -m nixremote}}; {{ic\|-m}} makes sure a home directory is created for the {{ic\|nixremote}} user.
	~~- Run (requires privileges)~~ {{ic\|~~mkdir ~nixremote/.ssh~~}}.		* Run (requires privileges) {{ic\|usermod nixremote -L}}; {{ic\|-L}} locks the user such that nobody will be able to {{ic\|su}} to it
			* Run (requires privileges) {{ic\|mkdir ~nixremote/.ssh}}. Make sure to run this command as {{ic\|nixremote}} user or {{ic\|chown}} it afterwards

	If your '''remote builder''' has Nix installed system-wide in multi-user mode, but you're not running NixOS, '''you may need to add something like the following to your''' {{ic\|/etc/ssh/sshd_config}} on this remote machine:		If your '''remote builder''' has Nix installed system-wide in multi-user mode, but you're not running NixOS, '''you may need to add something like the following to your''' {{ic\|/etc/ssh/sshd_config}} on this remote machine: