Home ›

How to Make a FreeNAS Box

Submitted by tsgadmin on Sun, 11/15/2009 - 14:01
in
Episode Number: 
1

Pox and Ragble give an in depth guide for making your own Network Attached Storage device.

Video for iPhone and iPad: 

480p H.264

Video Download HD: 

720p H.264

Show Links: 

FreeNAS Install

Check Hardware Compatibility List

Don't make the assumption that your hardware will work under FreeNAS. Take the time and verify all necessary components of your system are supported.

First, check the HCL on the FreeNAS site:
http://www.freenas.org/index.php?option=com_openwiki&Itemid=30&id=freenas_users_hardware

Secondly, search around the forums for your specific piece of hardware you're checking and see if anybody else is having problems.
Lastly, search around Google the same way but with FreeBSD or FreeNAS attached at the end of the search string.

Parts we used from NewEgg:

1

Intel BOXD945GCLF Intel Atom processor 230 Intel 945GC Mini ITX Motherboard/CPU Combo

Intel BOXD945GCLF Intel Atom processor 230 Mini ITX Motherboard/CPU Combo
Item #:N82E16813121342
Return Policy: Standard Return Policy

   $64.99
1

SYBA SD-CF-IDE-DI IDE to Compact Flash Adapter ( Direct Insertion Mode )

SYBA SD-CF-IDE-DI IDE to Compact Flash Adapter ( Direct Insertion Mode )
Item #:N82E16822998003
Return Policy: Standard Return Policy

   $6.99
2

SAMSUNG HD502HI 500GB 5400 RPM SATA 3.0Gb/s 3.5

SAMSUNG 500GB 3.5" SATA 3.0Gb/s Internal Hard Drive
Item #:N82E16822152137
Return Policy: Standard Return Policy

   $99.98
1

IN WIN BP655 Black Mini-ITX Tower Computer Case 200W Power Supply

IN WIN BP655 Black Computer Case
Item #:N82E16811108189
Return Policy: Standard Return Policy

   $39.99
1

SanDisk Ultra II 2GB Compact Flash (CF) Flash Card

SanDisk Ultra II 2GB Compact Flash (CF) Flash Card
Item #:N82E16820171353
Return Policy: Standard Return Policy

   $14.49
1

Kingston ValueRAM 512MB 240-Pin DDR2 SDRAM DDR2 400 (PC2 3200) System Memory Model KVR400D2N3/512

Kingston ValueRAM 512MB 240-Pin DDR2 SDRAM DDR2 400 (PC2 3200) System Memory
Item #:N82E16820144164
Return Policy: Memory Standard Return Policy



Taking this time will save you from potentially head wrenching headaches later on.

Install Points

An install point is where the embedded OS will reside that hosts the configuration file. Upon boot everything is loaded into a RAMdisk and only changes to the configuration file are written. This is ideal for a CF card as it minimizes writes and prolongs the life of the card. There are several choices for an install point. The following are recommendations.

Recommended:

  • USB stick
  • CF Card

HDD install is not recommended for the following reasons:

  • Partitioning of data drives is messy
  • HDD replacement is messy
  • An install HDD requires another bay, which are limited in a slim PC case

Advantages/Disadvantages Of Install Points

USB Stick Pros:
  • Cheapest solution
  • Easiest install

USB Stick Cons:
  • Potential loss of configuration due to loss of USB stick
  • NOTE: This can be alleviated with the use of a USB pin header to Type A adapter for $15
 
CF Card Pros:
  • Integrated and permanent
  • Larger storage capacity

CF Card Cons:
  • DMA adapters/cards are expensive
  • Non DMA adapters/cards require complex install process
  • Potential for adapter+card being taller than case
  • Cheaper Non DMA cards are still more expensive than a USB adapter

Deployment Methods

  • Install via LiveCD with CD/DVD drive
  • If you don't have an existing internal/external CD/DVD drive this adds $20 to project total

Write image file to install point

  • If you don't have a CF reader already, this can add around $10 to project total

USB Stick Installation

This is the easiest installation method, and the cheapest. However, loss of USB stick is a loss of the configuration file.

Firstly, determine the deployment method:

  • Boot off of a LiveCD is the easiest and quickest way
  • Requires an external CD/DVD drive
  • Or your case has a full sized for a CD/DVD drive
  • Or your case has a bay for a slim CD/DVD drive
  • NOTE: Adding a drive may increase the cost, but it makes the install much easier now, and in the future.

Write image file to the USB stick

  • Working method requires Windows machine or virtual install

LiveCD Install

 
  • Select the Source CD drive (e.g. acd0)
  • Select da0

Write Image File


NIC Support Install

If you manage to end up with a board with an embedded chipset not supported under FreeNAS, but is still supported by FreeBSD then you'll have to manually copy over the necessary kernel module and add a PostInit command to have it loaded.

When checking compatibility you should check across the two available versions of FreeNAS; one is based on FreeBSD 6 and the other FreeBSD 7. In the instance of the chipset on my Intel Atom (RTL8102EL) the driver worked under version 6 of FreeBSD, but not 7.

A compile version of the RealTek kernel module is available through this forum post:
http://sourceforge.net/apps/phpbb/freenas/viewtopic.php?f=9&t=192&hilit=realtek+kernel+module

If in the situation there is no support for your embedded chipset in FreeBSD, you'll have to find/buy a supported NIC. If you purchased a micro case then you'll have to make sure the NIC includes a low-height faceplate.

Options to transfer Kernel Module to Install Point.

  1. Upload via a service on the FreeNAS box (FTP, SMB, etc.)
  2. Transfer directly to the install point through a FreeBSD LiveCD

Upload via FreeNAS

NOTE: This requires a spare NIC on hand that is supported in FreeNAS.

Configure Network
  1. Plug in the spare NIC. You may have to take off the faceplate of the card if your case doesn't support a full-height faceplate. But don't worry, it's only temporary!
  2. Start up FreeNAS
  3. Type 1 to select option "1", "Assign Interfaces"
  4. The NIC we just plugged in should be listed and highlighted, press Enter
  5. Select "none finish and exit configuration" as we don't need an optional name
  6. A summary screen will show the interface being assigned to the LAN, select Yes and press Enter
  7. Back at the menu type 2 to select option "2", "Set LAN IP address"
  8. If you have DHCP enabled on your network (most likely), select "Yes"
  1. If not, then you'll be guided through a few screens asking for basic IP information. If you're not running DHCP then I'll assume you know what this is all about.
  2. The only "gotcha" is that the subnet mask is asked for in bits. For a typical home network this is 255.255.255.0 which is 24 bits

Select "No" to skip configuration of IPv6

 

The network now has a basic configuration and the Web UI can now be accessed.



Configure Share

Configure FreeNAS to Load Module at Run time

The kernel module must be loaded at run time and this is done via the kldload program on FreeBSD. FreeNAS can be configured (via WebUI) to run commands prior to initializing; this is the "Post Init" process.
 
PostInit Command: kldload /cf/boot/kernel/if_rl.ko

 

FreeNAS System Configuration

  1. Access the WebUI using the IP address reported when the LAN interface was configured.
  2. The default username and password is: admin/freenas
  3. The left hand side is the navigation for all the configuration options in FreeNAS. The right hand side is for viewing and updating the settings for an option.
  4. Change the default username and password.
  1. Click the System->General link in the Navigation side of the WebUI
  2. Type in a new admin user name
  3. Type in a new password and verify
  4. Click the "Apply Changes" button

Set up a RAID array

  1. NOTE: BEFORE AN ARRAY CAN BE SETUP DISKS MUST FIRST BE ADDED TO MANAGE
  2. NOTE: TO KNOW WHICH DISK TO SELECT USE TABLE 1 ON FREEBSD DEVICE NAMING
  3. Add Disks
  1. Click the Disks->Management link in the Navigation side of the WebUI
  2. Click the "plus" graphic image to add a disk
  3. In the "Disk" drop-down box, select the first HDD (See above NOTE)
  4. Leave other options at their defaults
  5. Click the "Add" button
  6. Repeat steps 4 and 5 for the number of HDDs in the system, probably 2 or more.
  7. After all devices have been added, click the "Apply Changes" button at the top of the "Disks: Management" screen.

Format the disks

  1. Click the Disks->Format link in the Navigation side of the WebUI
  2. In the "Disk" drop-down box select the first HDD to format
  3. In the "File System" drop-down box select "Software RAID"
  4. Click the "Format disk" button
  5. Repeat this step for all disks to be added to the RAID array

Create the Software RAID Array

  1. Click the Disks->Software RAID link in the Navigation side of the WebUI
  2. Click a tab along the top to select a RAID configuration setup. In our instance, we're doing a RAID 1 (Mirror) so we click on Geom Mirror
  3. Click the "plus" graphic image to add an array
  4. In the "Raid name" textbox give the array a meaningful name
  5. Check the boxes next to each drive listed. It will only list the disks formatted as "Software RAID"
  6. Click the "Add" button
  7. The array has been added, click the "Apply Changes" button
  8. The array will now start to be initialized
  • NOTE: DEPENDING ON THE SIZE AND TYPE OF RAID ARRAY, THIS CAN TAKE A WHILE. H-O-U-R-S
  • NOTE: EVEN DURING A BUILD FREENAS DOCUMENTATION STATES THAT THE ARRAY CAN STILL BE USED. WTF?!

Format the RAID Array

  1. Make sure the status of the array is "Up" or "Rebulding"
  • You can check this under the "Disks->Software RAID" link, the array will be listed with the status to the right.
  • The page does not auto-refresh, so you'll have to manually refresh the page to get the latest status of the array

Click the Disks->Format link in the Navigation side of the WebUIThe RAID array should now be listed in the "Disks" drop-down menu, select it.Leave the "File System" option at the default of "UFS"Click the "Format Disk" buttonCreate a Mount Point: this mounts the volume within FreeBSD which will enable it to be visible to the system

  1. Click the Disks->Mount Point link in the Navigation side of the WebUI
  2. Click the "plus" graphic image to add a mount point
  3. In the "Disk" drop-down box select the RAID array
  4. In the "Partition" drop-down box select "EFI - GPT"
  5. In the "File System" select "UFS"
  6. In the "Share Name" text box give the mount point a meaningful name
  7. In the "Description" text box you can elaborate on the share name and purpose further’
  8. Click the "Add" button
  9. Click the "Apply Changes" button

Configure a Service: this will enable a mounted drive/array to be visible across the network

  1. Since SMB is lowest common denominator for a mixed environment, it's the safest one to setup
  2. Click the Services->CIFS/SMB link in the Navigation side of the WebUI
  3. If you have an existing NetBIOS network in place:
  1. Give a more meaningful NetBIOS name for your FreeNAS box if you wish to in the "NetBiosName" text box
  2. Change the "Workgroup" text box to match the name of your network
  3. Click the "Save and Restart CIFS" button

Click the "Shares" tab to go to the share management pageClick the "plus" graphic image to add a share

 

Table 1. Disk Naming Convention in FreeBSD

  • /dev/ad0 : Is the First ATA hard drive on the ATA channel 1
  • /dev/ad1 : Is the Second ATA hard drive on the ATA channel 1
  • /dev/ad2 : Is the First ATA hard drive on the ATA channel 2
  • /dev/acd0: Is the first ATA CD/DVD drive detected
  • /dev/da0: Is the first SCSI hard drive. USB key device under FreeBSD are using an SCSI driver, then this name can link to your USB key/drive too.
  • /dev/da0p1: The ‘p’ represents an EFI/GPT partition type, and ‘1’ represents the first partition on the device. This is the new standard starting from version 0.684
  • /dev/da0s1: The ‘s’ represents the old standard partition type. For any filesystem other that UFS you should look for an ‘s’ type partition.
  • /dev/raid5/RAIDname: ‘RAID’ is only the array device.
  • /dev/raid5/RAIDp1: This is the filesystem on the RAID device.