.nh
.TH LTSP-NFS 8 "2023-08-19" "LTSP 23.02-1+deb12u1" "LTSP Manual"
.SH NAME
.PP
\fBltsp nfs\fP - configure NFS exports for LTSP

.SH SYNOPSIS
.PP
\fBltsp\fP [\fIltsp-options\fP] \fBnfs\fP [\fB-h\fP \fInfs-home\fP] [\fBt\fP \fInfs-tftp\fP]

.SH DESCRIPTION
.PP
Install /etc/exports.d/ltsp-nfs.conf in order to export /srv/ltsp ($BASE_DIR),
/srv/tftp/ltsp ($TFTP_DIR) and optionally /home ($HOME_DIR).

.SH OPTIONS
.PP
See the \fBltsp(8)\fP man page for \fIltsp-options\fP\&.

.TP
\fB-h\fP, \fB--nfs-home\fP=\fI0|1\fP
Export /home over NFS3. Defaults to 0.
Note that NFS3 is insecure for home, so by default SSHFS is used.
To specify a different directory, set $HOME_DIR in /etc/ltsp/ltsp.conf.

.TP
\fB-t\fP, \fB--nfs-tftp\fP=\fI0|1\fP
Export /srv/tftp/ltsp over NFS3. Defaults to 1.
To specify a different directory, set $TFTP_DIR in /etc/ltsp/ltsp.conf.

.SH EXAMPLES
.PP
To export /home over NFS (insecure), use the following ltsp.conf parameters:

.PP
.RS

.nf
[server]
NFS_HOME=1

[clients]
FSTAB_HOME="server:/home /home nfs defaults,nolock 0 0"
.fi
.RE

.PP
And run these commands on the server:

.PP
.RS

.nf
ltsp initrd  # This is needed whenever ltsp.conf is modified
ltsp nfs
.fi
.RE

.PP
To export only some user homes over NFS while the rest still use SSHFS,
use these lines in ltsp.conf instead:

.PP
.RS

.nf
[server]
NFS_HOME=1
HOME_DIR=/home/nfs

[clients]
FSTAB_HOME="server:/home/nfs /home nfs defaults,nolock 0 0"
.fi
.RE

.PP
Then run the following commands on the server, to move some home directories
under /home/nfs and to create appropriate symlinks in case the users ever
need to SSH to the server. Note that the NFS server doesn't follow symlinks
outside of an export:

.PP
.RS

.nf
mkdir /home/nfs
for u in guest01 guest02; do
    mv "/home/$u" /home/nfs/
    ln -s "nfs/$u" "/home/$u"
done

ltsp initrd
ltsp nfs
.fi
.RE

.SH COPYRIGHT
.PP
Copyright 2019-2022 the LTSP team, see AUTHORS.

.SH SEE ALSO
.PP
\fBltsp\fP(8), \fBltsp.conf\fP(5), \fBltsp-dnsmasq\fP(8), \fBltsp-image\fP(8),
\fBltsp-info\fP(8), \fBltsp-initrd\fP(8), \fBltsp-ipxe\fP(8), \fBltsp-kernel\fP(8),
\fBltsp-remoteapps\fP(8)

.PP
Online documentation is available on https://ltsp.org