Files
calypso/docs/alpha/components/nfs/nfs_setup.md
2026-01-09 16:54:39 +00:00

61 lines
2.3 KiB
Markdown

# NFS Service Setup Guide
This document outlines the steps taken to set up the NFS (Network File System) service on this machine, with a custom configuration file location.
## Setup Steps
1. **Install NFS Server Package**
The `nfs-kernel-server` package was installed using `apt-get`:
```bash
sudo apt-get install -y nfs-kernel-server
```
2. **Create Custom Configuration Directory**
A dedicated directory for NFS configuration files was created at `/opt/calypso/conf/nfs/`:
```bash
sudo mkdir -p /opt/calypso/conf/nfs/
```
3. **Handle Default `/etc/exports` File**
The default `/etc/exports` file, which typically contains commented-out examples, was removed to prepare for the custom configuration:
```bash
sudo rm /etc/exports
```
4. **Create Custom `exports` Configuration File**
A new `exports` file was created in the custom directory `/opt/calypso/conf/nfs/exports`. This file will be used to define NFS shares. Initially, it contains a placeholder comment:
```bash
sudo echo "# NFS exports managed by Calypso
# Add your NFS exports below. For example:
# /path/to/share *(rw,sync,no_subtree_check)" > /opt/calypso/conf/nfs/exports
```
**Note:** You should edit this file (`/opt/calypso/conf/nfs/exports`) to define your actual NFS shares.
5. **Create Symbolic Link for `/etc/exports`**
A symbolic link was created from the standard `/etc/exports` path to the custom configuration file. This ensures that the NFS service looks for its configuration in the designated `/opt/calypso/conf/nfs/exports` location:
```bash
sudo ln -s /opt/calypso/conf/nfs/exports /etc/exports
```
6. **Start NFS Kernel Server Service**
The NFS kernel server service was started:
```bash
sudo systemctl start nfs-kernel-server
```
7. **Enable NFS Kernel Server on Boot**
The NFS service was enabled to start automatically every time the system boots:
```bash
sudo systemctl enable nfs-kernel-server
```
## How to Configure NFS Shares
To define your NFS shares, edit the file `/opt/calypso/conf/nfs/exports`. After making changes to this file, you must reload the NFS exports using the command:
```bash
sudo exportfs -ra
```
This ensures that the NFS server recognizes your new or modified shares without requiring a full service restart.