NFS - Revision history

Klinger: Intro Sentence, Link, Category:Networking added (its not only a filesystem its a way to define networks too)

2025-04-30T19:08:03Z

Intro Sentence, Link, Category:Networking added (its not only a filesystem its a way to define networks too)

← Older revision		Revision as of 19:08, 30 April 2025
Line 1:		Line 1:
	__FORCETOC__		__FORCETOC__

			[[wikipedia:Network_File_System\|NFS]] is a distribute filesystem protocol to access directories and files over a network.

	= Server =		= Server =

Line 225:		Line 228:
	<syntaxhighlight lang="console"><host_or_ip>/nix /nix nfs nofail,x-systemd.device-timeout=4,local_lock=all 0 0</syntaxhighlight>'''TODO:''' Why this? That seems extremely unsafe. This disables NFS locks (which apply to all NFS clients), and makes locks ''local'', meaning a lock taken by one NFS client isn't seen by another, and both can take their locks. So this removes protection against concurrent writes, which Nix assumes.		<syntaxhighlight lang="console"><host_or_ip>/nix /nix nfs nofail,x-systemd.device-timeout=4,local_lock=all 0 0</syntaxhighlight>'''TODO:''' Why this? That seems extremely unsafe. This disables NFS locks (which apply to all NFS clients), and makes locks ''local'', meaning a lock taken by one NFS client isn't seen by another, and both can take their locks. So this removes protection against concurrent writes, which Nix assumes.
	[[Category:Filesystem]]		[[Category:Filesystem]]
			[[Category:Networking]]

Pigs: Cleaned up client section

2025-04-28T04:54:44Z

Cleaned up client section

← Older revision		Revision as of 04:54, 28 April 2025
Line 54:		Line 54:

	This configuration exposes all our shares to 2 local IPs; you can find more examples at [https://wiki.gentoo.org/wiki/NFSv4 Gentoo's wiki on NFS].		This configuration exposes all our shares to 2 local IPs; you can find more examples at [https://wiki.gentoo.org/wiki/NFSv4 Gentoo's wiki on NFS].

			To list the current loaded exports, use: <code>exportfs -v</code>

	Other options are available on the [https://search.nixos.org/options?query=nfs NixOS option page] or via the <code>nixos-option</code> command.		Other options are available on the [https://search.nixos.org/options?query=nfs NixOS option page] or via the <code>nixos-option</code> command.
Line 86:		Line 88:
	= Client =		= Client =

	To ensure the client has the necessary utilities installed, add		To ensure the client has the necessary NFS utilities installed, add the following to your system configuration (for example, in <code>configuration.nix</code>).

	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
	boot.supportedFilesystems = [ "nfs" ];		boot.supportedFilesystems = [ "nfs" ];
	</syntaxhighlight>		</syntaxhighlight>

	~~to your Nix configuration (e.g.~~ <code>~~configuration.nix~~</code>~~) file~~.		NFS shares can be mounted on a client system using the standard <code>filesystem</code> option. Continuing the server example, to mount the <code>tomoyo</code> share:

	Continuing the server example, ~~mounting~~ the ~~now-exposed ''~~tomoyo'' share ~~on another box (on a client) is as simple as~~:

	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
Line 103:		Line 104:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	~~Replace~~ "server" ~~in the above device attribute~~ with the IP address or DNS entry of ~~the~~ NFS server. ~~Note that clients see~~ exposed shares as if they were exposed at the root level - i.e. <code>/export/foo</code> becomes <code>/foo</code> (in the <code>device</code> option)~~. Other, regular '''fileSystems''' options apply.~~
			In the above configuration, replace "server" with the appropriate IP address or DNS entry of your NFS server. Other, regular [https://search.nixos.org/options?query=filesystems.%3Cname%3E filesystem options] apply.

			{{note\| On the client side, the exposed shares are as if they were exposed at the root level - i.e. <code>/export/foo</code> becomes <code>/foo</code> (in the <code>device</code> option) }}

	== Specifying NFS version ==		== Specifying NFS version ==
Line 145:		Line 149:
	== Using systemd.mounts and systemd.automounts ==		== Using systemd.mounts and systemd.automounts ==

	Here is an example with auto-disconnecting and lazy-mounting implemented, and the <code>noatime</code> mount option added.		This section provides an alternative approach for users who prefer to manage mounts using dedicated systemd units. Here is an example with auto-disconnecting and lazy-mounting implemented, and the <code>noatime</code> mount option added.

	Note that <code>wantedBy = [ "multi-user.target" ];</code> is required for the automount unit to start at boot.		Note that <code>wantedBy = [ "multi-user.target" ];</code> is required for the automount unit to start at boot.

Pigs: /* Using bind mounts */Add link to the filesystem bind mount section

2025-04-27T16:04:42Z

Using bind mounts: Add link to the filesystem bind mount section

← Older revision		Revision as of 16:04, 27 April 2025
Line 31:		Line 31:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

			Refer to [[Filesystems#Bind mounts]] for more information on bind mounts.

	=== Using btrfs subvolumes ===		=== Using btrfs subvolumes ===

Pigs: Adds btrfs section and refactored layout for readability. Decrease the example from 4 mounts to 2 mounts. The 4 examples made a lot of boilerplate and didn't show off any extra functionality that just 2 example nfs shares would show.

2025-04-27T06:55:03Z

Adds btrfs section and refactored layout for readability. Decrease the example from 4 mounts to 2 mounts. The 4 examples made a lot of boilerplate and didn't show off any extra functionality that just 2 example nfs shares would show.

← Older revision		Revision as of 06:55, 27 April 2025
Line 1:		Line 1:
	__FORCETOC__		__FORCETOC__
	== Server ==		= Server =

	Let's say that we've got one server-machine with 4 directories that we want to share: <code>/mnt/~~kotomi</code>, <code>/mnt/mafuyu</code>, <code>/mnt/sen~~</code> and <code>/mnt/~~tomoyo~~</code>.		== NFS share setup ==

			=== Using bind mounts ===

			Let's say that we've got one server-machine with 2 directories that we want to share: <code>/mnt/tomoyo</code> and <code>/mnt/kotomi</code>.

	First, we have to create a dedicated directory from which our NFS server will access the data:		First, we have to create a dedicated directory from which our NFS server will access the data:
Line 16:		Line 20:
	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
	{		{
	~~fileSystems."/export/mafuyu" = {~~
	~~device = "/mnt/mafuyu";~~
	~~options = [ "bind" ];~~
	};

	~~fileSystems."/export/sen" = {~~
	~~device = "/mnt/sen";~~
	~~options = [ "bind" ];~~
	};

	fileSystems."/export/tomoyo" = {		fileSystems."/export/tomoyo" = {
	device = "/mnt/tomoyo";		device = "/mnt/tomoyo";
Line 37:		Line 31:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

			=== Using btrfs subvolumes ===

			If you are using Btrfs, instead of moving existing directories or bind-mounting them into <code>/export</code>, you can create dedicated subvolumes directly under <code>/export</code>. This avoids the need for additional bind mounts and makes snapshotting or quota management easier. See [[btrfs#Subvolumes]] for details on creating subvolumes.

			== NFS service configuration ==

	Having the filesystem ready, we can proceed to configure the NFS server itself:		Having the filesystem ready, we can proceed to configure the NFS server itself:

	<syntaxhighlight lang="nix">{		<syntaxhighlight lang="nix">
			{
	services.nfs.server.enable = true;		services.nfs.server.enable = true;
	services.nfs.server.exports = ''		services.nfs.server.exports = ''
	/export 192.168.1.10(rw,fsid=0,no_subtree_check) 192.168.1.15(rw,fsid=0,no_subtree_check)		/export 192.168.1.10(rw,fsid=0,no_subtree_check) 192.168.1.15(rw,fsid=0,no_subtree_check)
	/export/kotomi 192.168.1.10(rw,nohide,insecure,no_subtree_check) 192.168.1.15(rw,nohide,insecure,no_subtree_check)		/export/kotomi 192.168.1.10(rw,nohide,insecure,no_subtree_check) 192.168.1.15(rw,nohide,insecure,no_subtree_check)
	~~/export/mafuyu 192.168.1.10(rw,nohide,insecure,no_subtree_check) 192.168.1.15(rw,nohide,insecure,no_subtree_check)~~
	~~/export/sen 192.168.1.10(rw,nohide,insecure,no_subtree_check) 192.168.1.15(rw,nohide,insecure,no_subtree_check)~~
	/export/tomoyo 192.168.1.10(rw,nohide,insecure,no_subtree_check) 192.168.1.15(rw,nohide,insecure,no_subtree_check)		/export/tomoyo 192.168.1.10(rw,nohide,insecure,no_subtree_check) 192.168.1.15(rw,nohide,insecure,no_subtree_check)
	'';		'';
	}</syntaxhighlight>		}
	This configuration exposes all our shares to 2 local IPs; you can find more examples at ~~Gentoo's wiki~~ [https://wiki.gentoo.org/wiki/NFSv4].		</syntaxhighlight>

			This configuration exposes all our shares to 2 local IPs; you can find more examples at [https://wiki.gentoo.org/wiki/NFSv4 Gentoo's wiki on NFS].

	Other options are available on the [https://search.nixos.org/options?query=nfs NixOS option page] or via the <code>nixos-option</code> command.		Other options are available on the [https://search.nixos.org/options?query=nfs NixOS option page] or via the <code>nixos-option</code> command.

			{{note\| If you are exporting a btrfs subvolume, it is recommended to use the fsid option with a unique id, e.g. <code>fsid{{=}}12345</code>. See the [https://btrfs.readthedocs.io/en/latest/Interoperability.html#nfs btrfs interoperability docs] for more info.}}

	=== Firewall ===		=== Firewall ===

	If your server-machine has a firewall turned on (as NixOS does by default, for instance), don't forget to open appropriate ports; e.g. for NFSv4:		If your server-machine has a firewall turned on (as NixOS does by default, for instance), don't forget to open appropriate ports; e.g. for NFSv4:
	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
Line 78:		Line 82:
	</syntaxhighlight>		</syntaxhighlight>

	== Client ==		= Client =

	To ensure the client has the necessary utilities installed, add		To ensure the client has the necessary utilities installed, add
Line 99:		Line 103:
	Replace "server" in the above device attribute with the IP address or DNS entry of the NFS server. Note that clients see exposed shares as if they were exposed at the root level - i.e. <code>/export/foo</code> becomes <code>/foo</code> (in the <code>device</code> option). Other, regular '''fileSystems''' options apply.		Replace "server" in the above device attribute with the IP address or DNS entry of the NFS server. Note that clients see exposed shares as if they were exposed at the root level - i.e. <code>/export/foo</code> becomes <code>/foo</code> (in the <code>device</code> option). Other, regular '''fileSystems''' options apply.

	=== Specifying NFS version ===		== Specifying NFS version ==

	You can specify NFS version by adding the <code>"nfsvers="</code> option:		You can specify NFS version by adding the <code>"nfsvers="</code> option:
Line 111:		Line 115:
	</syntaxhighlight>		</syntaxhighlight>

	=== Lazy-mounting ===		== Lazy-mounting ==

	By default, all shares will be mounted right when your machine starts - apart from being simply unwanted sometimes, this may also cause issues when your computer doesn't have a stable network connection or uses WiFi; you can fix this by telling systemd to mount your shares the first time they are ''accessed'' (instead of keeping them mounted at all times):		By default, all shares will be mounted right when your machine starts - apart from being simply unwanted sometimes, this may also cause issues when your computer doesn't have a stable network connection or uses WiFi; you can fix this by telling systemd to mount your shares the first time they are ''accessed'' (instead of keeping them mounted at all times):
Line 124:		Line 128:
	</syntaxhighlight>		</syntaxhighlight>

	=== Auto-disconnecting ===		== Auto-disconnecting ==

	You can tell systemd to disconnect your NFS-client from the NFS-server when the directory has not been accessed for some time:		You can tell systemd to disconnect your NFS-client from the NFS-server when the directory has not been accessed for some time:
Line 137:		Line 141:
	</syntaxhighlight>		</syntaxhighlight>

	=== Using systemd.mounts and systemd.automounts ===		== Using systemd.mounts and systemd.automounts ==

	Here is an example with auto-disconnecting and lazy-mounting implemented, and the <code>noatime</code> mount option added.		Here is an example with auto-disconnecting and lazy-mounting implemented, and the <code>noatime</code> mount option added.
Line 188:		Line 192:

	(commonMountOptions // {		(commonMountOptions // {
	what = "server:/~~oyomot~~";		what = "server:/kotomi";
	where = "/mnt/~~oyomot~~";		where = "/mnt/kotomi";
	})		})
	];		];
Line 204:		Line 208:
	[		[
	(commonAutoMountOptions // { where = "/mnt/tomoyo"; })		(commonAutoMountOptions // { where = "/mnt/tomoyo"; })
	(commonAutoMountOptions // { where = "/mnt/~~oyomot~~"; })		(commonAutoMountOptions // { where = "/mnt/kotomi"; })
	];		];
	}		}
	</syntaxhighlight>		</syntaxhighlight>

	== Nix store on NFS ==		= Nix store on NFS =

	In a single-user setup ('''not on Nixos''') the Nix store can be also exported over NFS (common in HPC clusters) to share package over the networks. The only requirement is to also pass <code>local_lock=flock</code> or <code>local_lock=all</code> as mount option to allow the nix packages to take locks on modifications. Example entry in <code>fstab</code>:		In a single-user setup ('''not on Nixos''') the Nix store can be also exported over NFS (common in HPC clusters) to share package over the networks. The only requirement is to also pass <code>local_lock=flock</code> or <code>local_lock=all</code> as mount option to allow the nix packages to take locks on modifications. Example entry in <code>fstab</code>:

Kvtb: ensure nfs utils get installed

2025-02-23T21:27:19Z

ensure nfs utils get installed

← Older revision		Revision as of 21:27, 23 February 2025
Line 79:		Line 79:

	== Client ==		== Client ==

			To ensure the client has the necessary utilities installed, add
			<syntaxhighlight lang="nix">
			boot.supportedFilesystems = [ "nfs" ];
			</syntaxhighlight>

			to your Nix configuration (e.g. <code>configuration.nix</code>) file.

	Continuing the server example, mounting the now-exposed ''tomoyo'' share on another box (on a client) is as simple as:		Continuing the server example, mounting the now-exposed ''tomoyo'' share on another box (on a client) is as simple as:

Nh2: add TODO regarding local_lock=all on Nix store

2024-07-22T01:41:36Z

add TODO regarding local_lock=all on Nix store

← Older revision		Revision as of 01:41, 22 July 2024
Line 206:		Line 206:
	In a single-user setup ('''not on Nixos''') the Nix store can be also exported over NFS (common in HPC clusters) to share package over the networks. The only requirement is to also pass <code>local_lock=flock</code> or <code>local_lock=all</code> as mount option to allow the nix packages to take locks on modifications. Example entry in <code>fstab</code>:		In a single-user setup ('''not on Nixos''') the Nix store can be also exported over NFS (common in HPC clusters) to share package over the networks. The only requirement is to also pass <code>local_lock=flock</code> or <code>local_lock=all</code> as mount option to allow the nix packages to take locks on modifications. Example entry in <code>fstab</code>:

	<syntaxhighlight lang="console"><host_or_ip>/nix /nix nfs nofail,x-systemd.device-timeout=4,local_lock=all 0 0</syntaxhighlight>		<syntaxhighlight lang="console"><host_or_ip>/nix /nix nfs nofail,x-systemd.device-timeout=4,local_lock=all 0 0</syntaxhighlight>'''TODO:''' Why this? That seems extremely unsafe. This disables NFS locks (which apply to all NFS clients), and makes locks ''local'', meaning a lock taken by one NFS client isn't seen by another, and both can take their locks. So this removes protection against concurrent writes, which Nix assumes.

	[[Category:Filesystem]]		[[Category:Filesystem]]

Jopejoe1: Fix category

2024-04-03T22:44:16Z

Fix category

← Older revision		Revision as of 22:44, 3 April 2024
Line 208:		Line 208:
	<syntaxhighlight lang="console"><host_or_ip>/nix /nix nfs nofail,x-systemd.device-timeout=4,local_lock=all 0 0</syntaxhighlight>		<syntaxhighlight lang="console"><host_or_ip>/nix /nix nfs nofail,x-systemd.device-timeout=4,local_lock=all 0 0</syntaxhighlight>

	[[Category:~~Filesystems~~]]		[[Category:Filesystem]]

imported>IgorM: Added to category "Filesystems"

2023-09-27T11:11:46Z

Added to category "Filesystems"

← Older revision		Revision as of 11:11, 27 September 2023
Line 207:		Line 207:

	<syntaxhighlight lang="console"><host_or_ip>/nix /nix nfs nofail,x-systemd.device-timeout=4,local_lock=all 0 0</syntaxhighlight>		<syntaxhighlight lang="console"><host_or_ip>/nix /nix nfs nofail,x-systemd.device-timeout=4,local_lock=all 0 0</syntaxhighlight>

			[[Category:Filesystems]]

imported>RCasatta: Added a step I needed to make the example work

2023-02-27T11:08:27Z

Added a step I needed to make the example work

← Older revision		Revision as of 11:08, 27 February 2023
Line 9:		Line 9:
	$ mkdir /export		$ mkdir /export
	</syntaxhighlight>		</syntaxhighlight>

			You may need to change ownership of the <code>/export</code> directory to <code>nobody:nogroup</code>

	Then we have to either move our already-existing directories inside <code>/export</code> (using <code>mv</code> from the command line) or bind-mount them there:		Then we have to either move our already-existing directories inside <code>/export</code> (using <code>mv</code> from the command line) or bind-mount them there:

imported>\\\\\\\\\\\: /* Client */

2022-10-10T14:40:55Z

Client

← Older revision		Revision as of 14:40, 10 October 2022
Line 88:		Line 88:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	Note that clients see exposed shares as if they were exposed at the root level - i.e. <code>/export/foo</code> becomes <code>/foo</code> (in the <code>device</code> option). Other, regular '''fileSystems''' options apply.		Replace "server" in the above device attribute with the IP address or DNS entry of the NFS server. Note that clients see exposed shares as if they were exposed at the root level - i.e. <code>/export/foo</code> becomes <code>/foo</code> (in the <code>device</code> option). Other, regular '''fileSystems''' options apply.

	=== Specifying NFS version ===		=== Specifying NFS version ===