Main Page

From Freenas
Revision as of 16:02, 31 December 2012 by Dru (Talk | contribs)
Jump to: navigation, search

Welcome to the FreeNAS® 8.x Documentation Project!

Are you using FreeNAS 0.7? The 0.7 branch was EOL'd in late 2011 and is no longer available for download from SourceForge due to unpatched security vulnerabilities. New development has been rebranded as NAS4Free. All 0.7 users are strongly encouraged to move to either NAS4Free or FreeNAS® 8.x.

This is the wiki area for the collaborative editing of FreeNAS® 8.x documentation. Beginning with version 8.0.1, a User Guide matching the released version is published in various formats. If you are interested in translating a released version of the documentation, send an email to the freenas-translations mailing list.

If you are running a version of FreeNAS® 8.x that is earlier than FreeNAS® 8.3.0-RELEASE, it is recommended that you upgrade to 8.3.0-RELEASE.

Published User Guide (use the Guide that matches your release version):


FreeNAS® 8.3.0-RELEASE-p1 was released on December 14, 2012. This is a bug fix release for those experiencing the "welcome to nginx" error. Use the 8.3.0 Users Guide and the release notes for documentation.

Past Releases:

FreeNAS® 8.3.0-RELEASE was released on October 26, 2012. The 8.3.0 Users Guide is available for download in the following formats:

  • * A Kindle version of the 8.3.0 Users Guide is also available for purchase from Amazon. The ASIN is B009Z245ZU and this version is text-to-speech enabled.

FreeNAS® 8.2.0-RELEASE-p1 was released on July 20, 2012. The 8.2 Users Guide is available in HTML and PDF formats.

FreeNAS® 8.0.4-RELEASE-p3 was released on June 13, 2012 in order to address several critical security vulnerabilities. Use the 8.0.3 Users Guide plus the Release Notes for FreeNAS 8.0.4-RELEASE-p3 for documentation.

FreeNAS® 8.0.4-RELEASE was released on February 29, 2012. This is a bug-fix release, meaning that you should use the 8.0.3 Users Guide plus the 8.0.4 Release Notes for documentation.

FreeNAS® 8.0.3-RELEASE was released on January 3, 2012. The 8.0.3 Users Guide is available for download in the following formats:

FreeNAS® 8.0.2-RELEASE was released on October 13, 2011. The 8.0.2 Users Guide is available for download in the following formats:

FreeNAS® 8.0.1-RELEASE was released on September 30, 2011. The 8.0.1 Users Guide is available for download in the following formats:

  • HTML
  • PDF
  • ODT
  • EPUB
  • A Kindle version of the 8.0.1 Users Guide is also available for purchase from Amazon. The ASIN is B005R3F6K4 and this version is text-to-speech enabled.

Work in Progress: 8.3.1 User Guide

The rest of this wiki is the editing area for the upcoming 8.3.1 Users Guide. As of January, 2013 the 8.3.1 User Guide is considered to be a work in progress, meaning that it changes on a daily basis as new features are added to 8.3.1. Unless you are beta testing 8.3.1 or a FreeNAS® nightly, you should not be referring to this portion of the wiki as the documentation you read will not match what you are seeing on your FreeNAS® system. Refer to the published User Guide that matches your RELEASE version of FreeNAS® instead.

We need your help to fill in the documentation gaps and to provide real-world usage examples to make sure that the 8.3.1 FreeNAS® Users Guide is as useful as possible when it is published. This Guide grows into a useful resource when users (meaning you!) contribute to it. You don't have to write large sections in order to be a contributor. You also don't need to have a lot of time on your hands. You simply have to create a login account in order to assist with any of the following tasks:

  • proofread existing pages and fix any typos, incorrect grammar, or unclearly worded sections.
  • add to sections containing missing, outdated, or incomplete content.
  • update any screenshots that are out of date.
  • every page has a Discussion tab. You can use this if you would like to suggest further information that should appear in that section of the Handbook.

We are emailed whenever edits are made and will contact you for clarification if an edit is unclear. You can also be notified when specified pages are edited--simply click the "my preferences" or "my watchlist" links whenever you are logged into the wiki.

Copyright 2011, 2012 The FreeNAS® Project. FreeNAS® and the FreeNAS® logo are registered trademarks of iXsystems.
All other content within the FreeNAS® Users Guide is freely available for sharing under the terms of the Creative Commons Attribution License.

Section 1: Introduction and Installation




Known Issues

What's New in 8.3.1

Hardware Recommendations

Installing and Upgrading FreeNAS®

Getting FreeNAS®

FreeNAS® in a Virtual Environment

Installing from CDROM

Burning an IMG File

Initial Setup

Upgrading FreeNAS®

Section 2: Using the Graphical Interface

Quick Start Guide

Account Configuration

Admin Account



System Configuration

Cron Jobs

NTP Servers


Rsync Tasks

S.M.A.R.T. Tests



System Information


Network Configuration

Global Configuration


Link Aggregations

Network Summary

Static Routes


Storage Configuration

Periodic Snapshot Tasks

Replication Tasks


ZFS Scrubs

Sharing Configuration

Apple (AFP) Shares

Unix (NFS) Shares

Windows (CIFS) Shares

Services Configuration

Control Services

Active Directory



Dynamic DNS












Additional Options

Display System Processes





Log Out


Section 3: Getting Help

FreeNAS® Support Resources

Useful Command Line Utilities

Section 4: Contributing to FreeNAS®

Assist with Localization and Document Translation

Submit Bug Reports

Test Upcoming Versions

Personal tools