FreeNAS: network attached storage
All harddrives fail. This guide will show you how to create something every home needs: highly efficient automated backups for every computer requiring so little network bandwidth it's practical even over Wireless-G (thanks rsync). All you need is an old PC with at least one harddrive, a 2GB or larger flash drive for the FreeNAS operating system, and a blank CD.
I prefer to burn the ISO from FreeNAS.org with ImgBurn. Network your soon-to-be FreeNAS box to your router via an ethernet cable. Before booting to the CD you may want to jump into BIOS and confirm the system is set to boot from not only CDs but also USB drives, and that it isn't set to halt on a missing keyboard if you plan to remove the peripherals later.
Insert and boot to the CD. At the FreeNAS prompt choose to Install/Upgrade it to your flash drive. More than likely you aren't upgrading an existing installation. As noted, the drive you install FreeNAS to will be completely wiped, so make sure you've properly selected your flash drive.
Remove the CD, reboot, and hopefully you're greeted with a URL that you can successfully access. (Provided your router has DHCP enabled.) If you can, and the BIOS isn't set to halt on a missing keyboard, your FreeNAS box should no longer require any peripherals such as a monitor, keyboard, or mouse.
Browse to the web interface from a different machine. http://freenas should work, if not try the one given and you may need to tweak your network's DNS configuration. Set a password by clicking Account, Change Password (leave Change root password as well checked).
Now we will set up a storage volume, click Storage and Volume Manager. Select your storage disk(s) and filesystem type. ZFS is recommended but "requires 4GB of memory and needs 6 to run smoothly", mine is an old box so I chose UFS. I named my volume
data but you may want to choose something that shows up better in log files. FreeNAS will wipe the selected drives, so make sure you don't need any data from them.
I created a user account for my mom so that I could give only her access to her folder. If you're going to add others and would like folders shareable between them, first create a group they can belong to (such as "family"). You'll find Add Group and Add User under Account. Add a user, specifying username, full name, and password. Uncheck Create a new primary group for the user, and select either the family group you created or nogroup. Leave the rest at defaults.
(Screenshot of edit window, the one during creation is larger.)
Now we will create our folders. Click Shell and navigate to the volume with
cd /mnt/data or similar. Since we may store other files on our NAS, let's create a folder just for backups:
mkdir backup. We'll navigate into our folder,
cd backup, and create a folder for mom:
mkdir mom. We can view permissions with
ls -l. Her folder is owned by root, and group wheel (whose members consist of just root by default). Mom's account is neither root nor a member of wheel, so let's change the folder's ownership to mom:
chown mom mom (username then folder).
Now we'll set up our Windows shares. Close the shell and navigate to Sharing, Windows (CIFS) Shares, Add Windows (CIFS) Share. If we share the backup folder in general she may see folders to which she doesn't have access, so let's share her folder directly. Name:
/mnt/data/backup/mom, defaults for everything else. Click OK and you will be asked to enable the CIFS service, choose Yes.
You can now navigate to
\\freenas\mom from a networked computer. Browse there from hers, supplying her FreeNAS username and password and select to Remember my credentials. This is important. Hooray! Access. You've just learned to use FreeNAS.
rsync on the server
rsync is an incredibly cool protocol and tool for sending only changed data through a network, hence small incremental backups to our FreeNAS box on a regular basis will yield a consistently complete backup.
We'll begin by creating an rsync module on the server, which isn't much more than an alias to a path with the credentials to access it. Use Add Rsync Module under Services. We'll name it
Under Services click to turn on Rsync, and the wrench icon to configure it. We will add the following Auxiliary parameters:
incoming chmod = ug=rwx,o= exclude from = /mnt/data/backup/exclude.txt
These settings apply to all rsync modules. Chmod sets the permission on incoming data so that our folder and files can continue to be accessed.
Back in Shell navigate to backup (
cd /mnt/data/backup) and let's create exclude.txt to avoid backing up non-essentials.
nano exclude.txt opens the file in a text editor, where we enter the following:
/$Recycle.Bin /Windows /Program Files /hiberfil.sys /pagefile.sys Temp Temporary Internet Files *.tmp
Paths matching these patterns will be excluded. The initial forward slash designates the root of the folder we're sending, in our case this will be C:\, thus excluding C:\Windows, C:\Program Files and so forth. The others match anywhere: excluding all folders named Temp, Temporary Internet Files, and all files ending in .tmp.
Ctrl+Shift+X exits the editor, type
y to save changes and press Enter to confirm the filename.
rsync on the client
The client configuration is easier. First we need rsync, so run setup.exe to install Cygwin to
C:\cygwin. When choosing packages, search for
rsync, expand Net, and click Skip, it should change to a version number indicating it's marked to be installed. Continue with the installation.
Now we'll schedule our backup. Launch Task Scheduler and Create a basic task. Name it
rsync backup to FreeNAS or similar, set to run Daily at a time of your choice.
-c '/bin/rsync -amv --delete --ignore-errors /cygdrive/c/ freenas::mom 2>/dev/null'
The last part,
2>/dev/null hides error messages and
--delete --ignore-errors delete files at the destination that no longer exist at the source. The first letter of amv means we want to recurse into sub-directories and preserve almost everything, m prunes empty directories, and v will output our progress. The trailing slash on /c/ is important as it specifies we're transferring the contents of the c drive. Without it our paths in exclude.txt would be incorrect.
For the very first transfer, copying the data manually will be fastest; rsync is designed for sending changes between files and suffers on whole-file copies. Run the task to verify it works. Don't be surprised if it takes a while just on "building file list", an entire drive has a lot of files. If successful, open the task's properties and select to Run whether user is logged on or not, then check Do not store password. This will completely hide the backup.
You're finished! Your family members now have a complete daily backup with minimal network bandwidth. Congratulations.
It shouldn't be too daunting to modify this for the full system image created by Windows Backup and Restore as an instant emergency restoration, though it would require much more storage. Another dynamic possibility is hourly, daily, and weekly snapshots for perusing old files. Future blog post if I do either.