Skip to content

Latest commit

 

History

History
180 lines (109 loc) · 4.5 KB

README.md

File metadata and controls

180 lines (109 loc) · 4.5 KB
Raw

RaspberryPI as NAS

raspberry pi nas

This repos setup a Raspberry Pi as private simple NAS.

Some key concepts for the NAS

  • SFTP is the main transport protocol to get data to and from the NAS
  • Every user has one writable working directory
  • A snapshot of the working directory is taken on a periodic schedule - so history of the working directory is given
  • Snapshots are always read-only

Limitations:

  • OS Setup of the Raspberry Pi is out of scope of this script
  • (vanilla) OS must be installed
  • Only one external hard drive is (currently) supported
  • No RAID suppoted
  • BTRFS is required as file system for the external drive
  • Windows user need to install some additional software to access SFTP (see below)

⚠️ Still under active development with many breaking changes

Setup

To setup everything, make sure you have the external disk connected which should be used as NAS disk.

  1. Transfer the content of this repository to the Raspberry Pi
  2. (Run the destructive script 9-format-disk.sh if the hard drive is not yet formatted as BTRFS)
  3. Define the parameters in parameters.sh
  4. Run 1-host-setup.sh
  5. Run 2-nas-setup.sh
  6. Run 3-nas-user-setup.sh for each user to be added as a NAS User

Your Raspberry Pi is now a simple slim NAS ♥♥♥

Script Description

parameters.sh

In this script, some these important variables are defined:

  • DISK_FULL_UUID_PATH
  • DISK_FULL_MOUNT_PATH

e.g.

DISK_FULL_UUID_PATH="/dev/disk/by-uuid/3980ec2e-6fe3-4c63-8754-18c8ca394446"
DISK_FULL_MOUNT_PATH="/mnt/backup"

The following command is useful to find the right disk:

# Get a list of disks
lsblk

# See all disk UUID's and the link destination
ls -l /dev/disk/by-uuid

This is needed for the following scripts.

1-host-setup.sh

This is the first script which should be executed, because some basic system setup is done which is not NAS specific but generally good for this Linux System.

2-nas-setup.sh

Setup the disk mounts and configures the SFTP working dir for the specified disk. The disk itself is not touched (e.g. formattted) in any way. To prepare the disk (format and partition), the script 9-format-disk.sh can be used.

The parameters.sh script is mandatory.

3-nas-user-setup.sh

This script adds a new user to be used via SFTP. It is a interactive script because the password for the user needs to be entered. After this script is executed successfully, the SFTP share is usable.

The parameters.sh script is mandatory.

9-format-disk.sh

Formats and prepares the passed disk to be usable for the NAS

WARNING: ALL DATA ON THE EXTERNAL HARD DRIVE WILL BE LOST WHEN RUNNING THIS SCRIPT

External Drive Folder Structure

The hard drive for the NAS has the following folder structure:

/mnt/[MOUNT_NAME]/sftp/[USER_NAME]/current
/mnt/[MOUNT_NAME]/sftp/[USER_NAME]/snapshots/[SNAPSHOT_DATE]

e.g.

/mnt/disk1/sftp/alice/current
/mnt/disk1/sftp/alice/snapshots/2024-01-01
/mnt/disk1/sftp/alice/snapshots/2024-01-02

Useful commands:

Check the SMART status of disks

lsblk # Get a list of disks
sudo smartctl -i /dev/sda

BTRFS commands

# Delete a subvolume
sudo btrfs subvolume delete [SNAPSHOT_PATH]

# Check if a snapshot is read-only
btrfs property get /path/to/snapshot ro

# Sets snapshot to read-only
sudo btrfs property set /path/to/snapshot ro true

Windows Users

To use the SFTP share on Windows, these to programs need to be installed

# https://github.com/winfsp/sshfs-win
winget install -h -e --id "WinFsp.WinFsp" ; winget install -h -e --id "SSHFS-Win.SSHFS-Win"

After installing this prerequisites, a network drive can be mapped with an address like this:

\\sshfs\someuser@raspberryhost

Troubleshooting

HD-Idle

Disk is not spinning down after 20 Minutes of inactivity

sudo systemctl status hd-idle
sudo hdparm -C /dev/sda

# Spin down drive immediately
sudo hd-idle -c ata -t /dev/sda

Also modifying the /etc/default/hd-idle file and adding this option -l /var/log/hd-idle.log can help.

Contribution

Contribution are always welcome in any form.

You acknowledge and agree that the owner reserve the right to change the license of the Work, including but not limited to all Contributions previously submitted by You, at any time without the need for approval from You or any other contributor.

License

This project is licensed under the MIT license.