Main Page

From Freenas
Jump to: navigation, search

Welcome to the FreeNAS® 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 due to unpatched security vulnerabilities. New 0.7 development has been rebranded as NAS4Free. All 0.7 users are strongly encouraged to move to either NAS4Free or to upgrade to the latest version of FreeNAS®

This is the wiki area for the collaborative creation of documentation for the next release of FreeNAS®. Unless you are beta testing the upcoming version, you should NOT be reading the wiki version of the documentation.

The current release of FreeNAS® is FreeNAS® 9.2.1.6-RELEASE. Users running previous versions are encouraged to upgrade to or install the current release and to refer to the 9.2.1 Users Guide and the 9.2.1.6 ERRATA for documentation.

Since the Users Guide is specific to a released version, always use the version of the Guide that matches your software version. If you are running an older version of FreeNAS®, you will find archived versions of the Guide at Past Releases.

If you are interested in translating the most recent released version of the documentation, send an email to the freenas-translations mailing list.

Work in Progress: 9.3 User Guide

The rest of this wiki is the editing area for the upcoming 9.3 Users Guide. The 9.3 User Guide is considered to be a work in progress, meaning that it changes on a daily basis as new features are added to 9.3. Unless you are beta testing 9.3, you should not be referring to the wiki documentation as what you read will most likely 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 9.3 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-2014 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

Preface

Introduction

9.2.1.6 ERRATA

Known Issues

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

Groups

Users

System Configuration

Cron Jobs

Init/Shutdown Scripts

NTP Servers

Rsync Tasks

S.M.A.R.T. Tests

Settings

Sysctls

System Information

Tunables

Network Configuration

Global Configuration

Interfaces

IPMI

Link Aggregations

Network Summary

Static Routes

VLANs

Storage Configuration

Periodic Snapshot Tasks

Replication Tasks

Volumes

ZFS Scrubs

Sharing Configuration

Apple (AFP) Shares

Unix (NFS) Shares

Windows (CIFS) Shares

Services Configuration

Control Services

AFP

CIFS

Directory Services

Dynamic DNS

FTP

iSCSI

NFS

Rsync

S.M.A.R.T.

SNMP

SSH

TFTP

UPS

Plugins

Available FreeNAS® PBIs

Jails

Jails Configuration

Adding Jails

Jail Templates

Installing FreeNAS® PBIs

Installing non-PBI Software

Reporting

Additional Options

Display System Processes

Shell

Reboot

Shutdown

Help

Log Out

Alert

Section 3: Getting Help

FreeNAS® Support Resources

Website and Social Media

Forums

Support Database

IRC

Mailing Lists

Instructional Videos

Professional Support

Useful Command Line Utilities

Iperf

Netperf

IOzone

arcstat.py and arc_summary.py

XDD

tw_cli

MegaCli

freenas-debug

tmux

Dmidecode

OpenVPN

Section 4: Contributing to FreeNAS®

Assist with Localization and Document Translation

Test Upcoming Versions

Using the FreeNAS® API

Personal tools
Navigation