Setting up an NFS server - Revision history

Camelia: Remove duplicate "in the"

2025-11-03T00:23:41Z

Remove duplicate "in the"

← Older revision		Revision as of 00:23, 3 November 2025
Line 69:		Line 69:
	=== Server configuration ===		=== Server configuration ===

	Assuming you setup Kerberos ~~in the~~ in the network, create ticket to your NFS machine :		Assuming you setup Kerberos in the network, create ticket to your NFS machine :

	{{Cmd\|# kadmin: addprinc -randkey nfs/nfs1.example.com@EXAMPLE.COM}}		{{Cmd\|# kadmin: addprinc -randkey nfs/nfs1.example.com@EXAMPLE.COM}}

Prabuanand: changed expand template to todo template

2025-05-31T13:54:57Z

changed expand template to todo template

← Older revision		Revision as of 13:54, 31 May 2025
Line 23:		Line 23:

	==== NFS version ====		==== NFS version ====

	~~{{Expand\|NFSv4 allegedly doesn't need rpcbind. It can be disabled with <code>chmod 444 /etc/init.d/rpcbind</code>, but it breaks nfs service. }}~~

	To configure nfs version in use, pass appropriate options to nfsd in {{Path\|/etc/conf.d/nfs}}. For example: {{Cat\|/etc/conf.d/nfs\|<nowiki># Options to pass to rpc.nfsd		To configure nfs version in use, pass appropriate options to nfsd in {{Path\|/etc/conf.d/nfs}}. For example: {{Cat\|/etc/conf.d/nfs\|<nowiki># Options to pass to rpc.nfsd
Line 33:		Line 31:
	After editing {{Path\|/etc/conf.d/nfs}}, restart the server: {{Cmd\|# rc-service nfs restart}}		After editing {{Path\|/etc/conf.d/nfs}}, restart the server: {{Cmd\|# rc-service nfs restart}}

			{{Todo\|NFS v4 doesn't need rpcbind. Disabling it with command {{ic\|chmod 444 /etc/init.d/rpcbind}} breaks nfs service. Help add the correct method to disable rpcbind.}}
	=== NFS client ===		=== NFS client ===

Prabuanand: added blog post

2025-05-31T13:50:50Z

added blog post

← Older revision		Revision as of 13:50, 31 May 2025
Line 99:		Line 99:
	* [https://wiki.debian.org/NFSServerSetup#NFSv4_only NFS Server Setup in Debian wiki]		* [https://wiki.debian.org/NFSServerSetup#NFSv4_only NFS Server Setup in Debian wiki]
	* [[Raspberry_Pi_4_-_Persistent_system_acting_as_a_NAS_and_Time_Machine]]		* [[Raspberry_Pi_4_-_Persistent_system_acting_as_a_NAS_and_Time_Machine]]
			* [https://www.willowbarraco.fr/my-perfect-music-synchronization-solution/ NFS and FS-cache based synchronization solution ]
	[[Category:Server]]		[[Category:Server]]

SergeTheEngi: /* See also */ Fix debian wiki link 2

2025-05-04T19:48:40Z

SergeTheEngi: /* See also */ Fix link to debian wiki

2025-05-04T19:46:36Z

SergeTheEngi: Add nfs version configuration

2025-05-04T19:42:21Z

Add nfs version configuration

← Older revision		Revision as of 19:42, 4 May 2025
Line 19:		Line 19:

	To start NFS server service now: {{Cmd\|# rc-service nfs start}}		To start NFS server service now: {{Cmd\|# rc-service nfs start}}

			NFS server configuration file is located in {{Path\|/etc/conf.d/nfs}}.

			==== NFS version ====

			{{Expand\|NFSv4 allegedly doesn't need rpcbind. It can be disabled with <code>chmod 444 /etc/init.d/rpcbind</code>, but it breaks nfs service. }}

			To configure nfs version in use, pass appropriate options to nfsd in {{Path\|/etc/conf.d/nfs}}. For example: {{Cat\|/etc/conf.d/nfs\|<nowiki># Options to pass to rpc.nfsd
			# `-N 3` means version 3 is disabled
			OPTS_RPC_NFSD="8 -N 3"
			</nowiki>}}

			After editing {{Path\|/etc/conf.d/nfs}}, restart the server: {{Cmd\|# rc-service nfs restart}}

	=== NFS client ===		=== NFS client ===
Line 84:		Line 97:
	* [https://wiki.archlinux.org/title/NFS NFS in Arch wiki]		* [https://wiki.archlinux.org/title/NFS NFS in Arch wiki]
	* [https://wiki.gentoo.org/wiki/Nfs-utils NFS in Gentoo Wiki]		* [https://wiki.gentoo.org/wiki/Nfs-utils NFS in Gentoo Wiki]
			* [https://wiki.debian.org/NFSServerSetup]
	* [[Raspberry_Pi_4_-_Persistent_system_acting_as_a_NAS_and_Time_Machine]]		* [[Raspberry_Pi_4_-_Persistent_system_acting_as_a_NAS_and_Time_Machine]]

	[[Category:Server]]		[[Category:Server]]

Prabuanand: fixed a typo

2025-01-16T08:33:55Z

fixed a typo

← Older revision		Revision as of 08:33, 16 January 2025
Line 53:		Line 53:
	{{Note\|It is recommended to have the same Kerberos flavor across the network as both implementations are not completely mutually compatible.}}		{{Note\|It is recommended to have the same Kerberos flavor across the network as both implementations are not completely mutually compatible.}}

	The example given below uses MIT KRB5 syntax. So install the server package {{krb5-server}} on server and {{pkg\|krb5}} package for client machines.		The example given below uses MIT KRB5 syntax. So install the server package {{pkg\|krb5-server}} on server and {{pkg\|krb5}} package for client machines.

	=== Server configuration ===		=== Server configuration ===

Prabuanand: added wiki tags and links rephrased few sentences

2025-01-16T08:32:43Z

added wiki tags and links rephrased few sentences

← Older revision		Revision as of 08:32, 16 January 2025
Line 9:		Line 9:
	Setting up NFS service on Alpine Linux is no different from other Linux distributions.		Setting up NFS service on Alpine Linux is no different from other Linux distributions.

	=== NFS ~~Server~~ ===		=== NFS server ===

	Setup export dirs in /etc/exports. For example: {{Cat\|/etc/exports\|<nowiki>/data 10.10.10.0/24(rw,nohide,no_subtree_check,no_root_squash)		Setup export dirs in {{Path\|/etc/exports}} on your server with IP address 10.10.10.1. For example: {{Cat\|/etc/exports\|<nowiki>/data 10.10.10.0/24(rw,nohide,no_subtree_check,no_root_squash)
	</nowiki>}}		</nowiki>}}

	After editing /etc/exports, reload your setting: {{Cmd\|# exportfs -afv}}		After editing {{Path\|/etc/exports}}, reload your setting: {{Cmd\|# exportfs -afv}}

	To make NFS server service to autostart on boot: {{Cmd\|# rc-update add nfs}}		To make NFS server service to autostart on boot: {{Cmd\|# rc-update add nfs}}
Line 20:		Line 20:
	To start NFS server service now: {{Cmd\|# rc-service nfs start}}		To start NFS server service now: {{Cmd\|# rc-service nfs start}}

	=== NFS ~~Client~~ ===		=== NFS client ===

	To mount NFS shares automatically, an entry needs to made to {{Path\|/etc/fstab}} as follows:{{Cat\|/etc/fstab\|10.10.10.1:/data /mount/point nfs4 rw,_netdev 0 0}}		To mount NFS shares automatically, an entry needs to made to {{Path\|/etc/fstab}} as follows:{{Cat\|/etc/fstab\|10.10.10.1:/data /mount/point nfs4 rw,_netdev 0 0}}
Line 33:		Line 33:
	# rc-update add netmount</nowiki>}}		# rc-update add netmount</nowiki>}}

	=== Using autofs ===		== Using autofs ==

			[https://docs.kernel.org/filesystems/autofs.html Autofs] is another alternative for mounting filesystems like NFS. Autofs aims to provide on-demand mounting and race free automatic unmounting of various other filesystems.

	[https://docs.kernel.org/filesystems/autofs.html Autofs] can also be used for mounting NFS shares on the client. Autofs aims to provide on-demand mounting and race free automatic unmounting of various other filesystems.
	Ensure that {{pkg\|autofs}} package is installed, if not installed already. {{Cmd\|apk add autofs}}		Ensure that {{pkg\|autofs}} package is installed, if not installed already. {{Cmd\|apk add autofs}}
	Add an entry in the file {{Path\|/etc/auto.master}} that points to a map file to define the mount points for the {{ic\|/mnt/nfs}} directory.. For example:{{Cat\|/etc/auto.master\|<nowiki>/mnt/nfs /etc/auto.nfs --timeout=60</nowiki>}}		Add an entry in the file {{Path\|/etc/auto.master}} that points to a map file to define the mount points for the {{ic\|/mnt/nfs}} directory.. For example:{{Cat\|/etc/auto.master\|<nowiki>/mnt/nfs /etc/auto.nfs --timeout=60</nowiki>}}
Line 44:		Line 45:
	Eventhough autofs is primarily a client-side tool it can also be used on servers for dynamic mounting if required. For an use case of using Autofs on servers, refer to [[Raspberry_Pi_4_-_Persistent_system_acting_as_a_NAS_and_Time_Machine#Adding_and_Sharing_a_Disk\|Sharing a Disk]] page.		Eventhough autofs is primarily a client-side tool it can also be used on servers for dynamic mounting if required. For an use case of using Autofs on servers, refer to [[Raspberry_Pi_4_-_Persistent_system_acting_as_a_NAS_and_Time_Machine#Adding_and_Sharing_a_Disk\|Sharing a Disk]] page.

	== Kerberos ~~Authentication~~ ==		== Kerberos authentication ==

	By default, NFS security only validates the IP of the client. You can add user level authentication with a Kerberos ~~installation (~~[https://~~pkgs~~.~~alpinelinux~~.~~org/package~~/~~edge~~/~~main~~/~~armhf/krb5~~ MIT KRB5] or [https://~~pkgs~~.~~alpinelinux.org~~/~~package~~/~~edge/main/x86/heimdal~~ Heimdal]~~). It is recommended to have the same Kerberos flavor across the network as both implementations are not completely mutually compatible.~~		By default, NFS security only validates the IP of the client. You can add user level authentication with a Kerberos authentication protocol. The choices are:
			* [https://web.mit.edu/kerberos/www/ MIT KRB5] available in {{pkg\|krb5}} package
			* [https://github.com/heimdal/ Heimdal] available in {{pkg\|heimdal}} package

	~~=== Server Configuration ===~~		{{Note\|It is recommended to have the same Kerberos flavor across the network as both implementations are not completely mutually compatible.}}

	Assuming you setup Kerberos in the in the network, create ticket to your NFS machine ~~(examples are in MIT KRB5 syntax)~~:		The example given below uses MIT KRB5 syntax. So install the server package {{krb5-server}} on server and {{pkg\|krb5}} package for client machines.

			=== Server configuration ===

			Assuming you setup Kerberos in the in the network, create ticket to your NFS machine :

	{{Cmd\|# kadmin: addprinc -randkey nfs/nfs1.example.com@EXAMPLE.COM}}		{{Cmd\|# kadmin: addprinc -randkey nfs/nfs1.example.com@EXAMPLE.COM}}
Line 57:		Line 64:
	{{Cmd\|# kadmin: ktadd nfs/nfs1.example.com@EXAMPLE.COM}}		{{Cmd\|# kadmin: ktadd nfs/nfs1.example.com@EXAMPLE.COM}}

	Then, edit your /etc/exports, and add sec=krb5 (only authentication), sec=krb5i (also hmac signing) or sec=krb5p (also encryption). For example:		Then, edit your {{Path\|/etc/exports}}, and add sec=krb5 (only authentication), sec=krb5i (also hmac signing) or sec=krb5p (also encryption). For example:

	{{Cat\|/etc/exports\|<nowiki>/data 10.10.10.0/24(rw,nohide,no_subtree_check,sec=krb5p,no_root_squash)		{{Cat\|/etc/exports\|<nowiki>/data 10.10.10.0/24(rw,nohide,no_subtree_check,sec=krb5p,no_root_squash)
	</nowiki>}}		</nowiki>}}

	After editing /etc/exports, reload your setting		After editing {{Path\|/etc/exports}}, reload your setting
	{{Cmd\|# exportfs -afv}}		{{Cmd\|# exportfs -afv}}

	User id mapping is managed by nfsidmap.		User id mapping is managed by <code>nfsidmap</code> utility from {{pkg\|nfs-utils}} package.

	=== Client ~~Configuration~~ ===		=== Client configuration ===

	In order for the client to connect to NFS via kerberos, enable and start rpc.gssd.		In order for the client to connect to NFS via kerberos, enable and start rpc.gssd service.
	{{Cmd\|# rc-update add rpc.gssd}}		{{Cmd\|# rc-update add rpc.gssd}}
	{{Cmd\|# rc-service rpc.gssd start}}		{{Cmd\|# rc-service rpc.gssd start}}

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

	* [https://wiki.archlinux.org/title/NFS NFS in Arch wiki]		* [https://wiki.archlinux.org/title/NFS NFS in Arch wiki]
	* [https://wiki.gentoo.org/wiki/Nfs-utils NFS in Gentoo Wiki]		* [https://wiki.gentoo.org/wiki/Nfs-utils NFS in Gentoo Wiki]
	* [[Raspberry_Pi_4_-_Persistent_system_acting_as_a_NAS_and_Time_Machine]]		* [[Raspberry_Pi_4_-_Persistent_system_acting_as_a_NAS_and_Time_Machine]]

	[[Category:Server]]		[[Category:Server]]

Prabuanand: Added introduction new section autofs, clarified on the netmount and nfsmount command

2025-01-15T16:50:11Z

Added introduction new section autofs, clarified on the netmount and nfsmount command

← Older revision		Revision as of 16:50, 15 January 2025
Line 1:		Line 1:
			This page documents configuring Network File System (NFS) on both server and client side including autofs and Kerberos authentication.

	== Installation ==		== Installation ==
	~~Install the following package for both NFS client and NFS server service.~~

	{{Cmd\|# apk add nfs-utils}}		Install the following package for both NFS client and NFS server service. {{Cmd\|# apk add nfs-utils}}

	== Configuration ==		== Configuration ==

	Setting up NFS service on Alpine Linux is no different from other Linux distributions.		Setting up NFS service on Alpine Linux is no different from other Linux distributions.

	=== NFS Server ===		=== NFS Server ===

	Setup export dirs in /etc/exports. For example:		Setup export dirs in /etc/exports. For example: {{Cat\|/etc/exports\|<nowiki>/data 10.10.10.0/24(rw,nohide,no_subtree_check,no_root_squash)
	{{Cat\|/etc/exports\|<nowiki>/data 10.10.10.0/24(rw,nohide,no_subtree_check,no_root_squash)
	</nowiki>}}		</nowiki>}}

	After editing /etc/exports, reload your setting		After editing /etc/exports, reload your setting: {{Cmd\|# exportfs -afv}}
	{{Cmd\|# exportfs -afv}}

	~~To make NFS server service to autostart on boot:~~

	{{Cmd\|# rc-update add nfs}}		To make NFS server service to autostart on boot: {{Cmd\|# rc-update add nfs}}

	To start NFS server service now		To start NFS server service now: {{Cmd\|# rc-service nfs start}}

	~~{{Cmd\|# rc-service nfs start}}~~		=== NFS Client ===

	~~===~~ NFS ~~Client ===~~		To mount NFS shares automatically, an entry needs to made to {{Path\|/etc/fstab}} as follows:{{Cat\|/etc/fstab\|10.10.10.1:/data /mount/point nfs4 rw,_netdev 0 0}}

	To mount ~~NFS shares automatically, an entry needs to made to~~ /etc/fstab. To mount nfs ~~share~~ from /etc/fstab file ~~at booting of the system~~		To mount nfs share from {{Path\|/etc/fstab}} file at booting of the system:{{Cmd\|# rc-update add nfsmount}}
			To mount the nfs shares from /etc/fstab file now:{{Cmd\|# rc-service nfsmount start}}

	{{Cmd\|# rc-~~update add nfsmount~~}}		You can check your boot services:{{Cmd\|# rc-status}}

	To ~~mount~~ the ~~nfs shares from /etc/fstab file now~~:		{{Tip\| netmount is a general service for all network-based filesystems, while nfsmount is specifically tailored for NFS.}}
	{{Cmd\|# rc-service ~~nfsmount~~ start}}		To use netmount, here are the equivalent commands:{{Cmd\|<nowiki># rc-service netmount start
			# rc-update add netmount</nowiki>}}

	~~{{Cmd\|# rc-update add netmount}}~~		=== Using autofs ===

	~~You~~ can ~~check your boot services~~:		[https://docs.kernel.org/filesystems/autofs.html Autofs] can also be used for mounting NFS shares on the client. Autofs aims to provide on-demand mounting and race free automatic unmounting of various other filesystems.
	{{Cmd\|# rc-~~status~~}}		Ensure that {{pkg\|autofs}} package is installed, if not installed already. {{Cmd\|apk add autofs}}
			Add an entry in the file {{Path\|/etc/auto.master}} that points to a map file to define the mount points for the {{ic\|/mnt/nfs}} directory.. For example:{{Cat\|/etc/auto.master\|<nowiki>/mnt/nfs /etc/auto.nfs --timeout=60</nowiki>}}
			Create the Map File {{Path\|/etc/auto.nfs}} that maps the NFS share {{ic\|10.10.10.1:/data}} to {{ic\|/mnt/nfs/share}} as follows:{{Cat\|/etc/auto.nfs\|share -rw 10.10.10.1:/data}}
			Start and Enable autofs:{{Cmd\|<nowiki># rc-update add autofs
			# rc-service autofs start</nowiki>}}

	~~{{Cmd~~\|~~# rc-service netmount start}}~~		Eventhough autofs is primarily a client-side tool it can also be used on servers for dynamic mounting if required. For an use case of using Autofs on servers, refer to [[Raspberry_Pi_4_-_Persistent_system_acting_as_a_NAS_and_Time_Machine#Adding_and_Sharing_a_Disk\|Sharing a Disk]] page.

	== Kerberos Authentication ==		== Kerberos Authentication ==
Line 69:		Line 73:
	{{Cmd\|# rc-service rpc.gssd start}}		{{Cmd\|# rc-service rpc.gssd start}}

	== ~~see Also~~ ==		== See also ==
	* [https://wiki.archlinux.org/title/NFS NFS in Arch wiki]		* [https://wiki.archlinux.org/title/NFS NFS in Arch wiki]
	* [https://wiki.gentoo.org/wiki/Nfs-utils NFS in Gentoo Wiki]		* [https://wiki.gentoo.org/wiki/Nfs-utils NFS in Gentoo Wiki]
			* [[Raspberry_Pi_4_-_Persistent_system_acting_as_a_NAS_and_Time_Machine]]
	[[Category:Server]]		[[Category:Server]]

Arnaudv6: bin name: exports -> exportfs

2024-09-26T12:21:55Z

bin name: exports -> exportfs

← Older revision		Revision as of 12:21, 26 September 2024
Line 14:		Line 14:

	After editing /etc/exports, reload your setting		After editing /etc/exports, reload your setting
	{{Cmd\|# ~~exports~~ -afv}}		{{Cmd\|# exportfs -afv}}

	To make NFS server service to autostart on boot:		To make NFS server service to autostart on boot:
Line 59:		Line 59:

	After editing /etc/exports, reload your setting		After editing /etc/exports, reload your setting
	{{Cmd\|# ~~exports~~ -afv}}		{{Cmd\|# exportfs -afv}}

	User id mapping is managed by nfsidmap.		User id mapping is managed by nfsidmap.

← Older revision		Revision as of 19:48, 4 May 2025
Line 97:		Line 97:
	* [https://wiki.archlinux.org/title/NFS NFS in Arch wiki]		* [https://wiki.archlinux.org/title/NFS NFS in Arch wiki]
	* [https://wiki.gentoo.org/wiki/Nfs-utils NFS in Gentoo Wiki]		* [https://wiki.gentoo.org/wiki/Nfs-utils NFS in Gentoo Wiki]
	* [https://wiki.debian.org/NFSServerSetup#NFSv4_only]		* [https://wiki.debian.org/NFSServerSetup#NFSv4_only NFS Server Setup in Debian wiki]
	* [[Raspberry_Pi_4_-_Persistent_system_acting_as_a_NAS_and_Time_Machine]]		* [[Raspberry_Pi_4_-_Persistent_system_acting_as_a_NAS_and_Time_Machine]]

	[[Category:Server]]		[[Category:Server]]

← Older revision		Revision as of 19:46, 4 May 2025
Line 97:		Line 97:
	* [https://wiki.archlinux.org/title/NFS NFS in Arch wiki]		* [https://wiki.archlinux.org/title/NFS NFS in Arch wiki]
	* [https://wiki.gentoo.org/wiki/Nfs-utils NFS in Gentoo Wiki]		* [https://wiki.gentoo.org/wiki/Nfs-utils NFS in Gentoo Wiki]
	* [https://wiki.debian.org/NFSServerSetup]		* [https://wiki.debian.org/NFSServerSetup#NFSv4_only]
	* [[Raspberry_Pi_4_-_Persistent_system_acting_as_a_NAS_and_Time_Machine]]		* [[Raspberry_Pi_4_-_Persistent_system_acting_as_a_NAS_and_Time_Machine]]

	[[Category:Server]]		[[Category:Server]]