Merge pull request #1 from subzero79/master

Add some content.

FAQ.rst

@@ -0,0 +1,91 @@
+FAQ
+----
+
+
+**Frequently Asked Questions**
+
+
+What is OMV?
+	OMV is an abbreviation of |omv|
+
+
+Is OpenMediaVault a fork of FreeNAS?
+	No
+
+Does OpenMediaVault have drivers for my hardware?
+	All module drivers are provided by the Debian standard kernel of oldstable release 8.9 (aka Jessie). This distribution ships with kernel 3.16 by default. You can optionally install the backport kernel 4.9. If your hardware is supported under Debian Jessie then is supported under OMV.
+	The Jessie backport kernel 4.9 is the default kernel used by Stretch (Debian 9.3) at the moment, so it provides support for newer hardware.
+
+Can I use a usb flash drive (stick) for installing the system?
+	Yes, but the installation does not have any optimizations to reduce writes into the OS disk. Your usb media will most likely start failing within a few weeks of usage. Most common symptom is basic command execution does not work, denied login, etc.
+
+What is the file :file:`/etc/openmediavault/config.xml` for?
+	Is the database configuration store file for |omv|. When a change is performed in the webUI, the config value is stored and/or retrieve by rpc to/from this file. If this is a save change, then mkconf passes the value to the service configuration file and reloads the daemon in case is necessary.
+
+Can I upgrade to Debian Testing/Unstable (Debian Testing/Sid) or use Ubuntu as a base distribution?
+	Yes you can. But you will end up most likely with a broken web interface and possibly broken system. |omv| releases are heavily tight to their Debian base distro.
+
+I´ve lost the WebInterface password. How do I reset it?
+	Simply connect via ssh to your server or login locally on your machine and type in: omv-firstaid . There is an option to reset your password. More information about [[openmediavault:features:omv-firstaid|omv-firstaid]]
+
+Can I backup or restore and existing OpenMediaVaut configuration?
+	No. You can keep the file :file:`/etc/openmediavault/config.xml` for references purposes if you decide to go for a clean re-install 
+
+What is the default HTTP engine of OpenMediaVault?
+	NGINX. The last version of OMV with Apache was 0.5 Sardoukar.
+
+Can I use Apache as HTTP engine?
+	You can use it but is not supported. Eventually every openmediavault package upgrade will activate NGINX again leaving you with a broken webUI. You can run a parallel Apache instance to Nginx just make sure the ports are different otherwise your OMV webUI will not work.
+
+How can use the default http engine to hold my own web page?
+	Do not modify OpenMediaVault default nginx files. Read `Nginx <http://nginx.org/en/docs/|documentation>`_. You can place your website configurations at :file:`/etc/nginx/sites-available,enabled`.
+
+Why does the system rewrites a configuration file(s) that I have manually edited?
+	OMV takes full control of some system services. This services include monit, ntp, samba, network, proftpd, nginx, php5-fpm, etc.
+
+How can I modify an internal value of some service OpenMediaVault has control of?
+	Read :doc:`here <various/advancedsettings>` for advanced configurations.
+
+How can I modify or add a network configuration of :file:`/etc/network/interfaces` with some custom options the webUI does not provide?
+	The interfaces file is controlled by OpenMediaVault. To add network interfaces that are not configurable through the webGUI or other options not present, you need to use  :doc:`advanced settings <various/advancedsettings>`
+
+Why my disks mount paths have a long alphanumeric number?
+	The long number is called UUID, it is used by fstab to mount disks. This number is unique per filesystem (or at least unlikely possible that another filesystem comes with an identical one). This helps maintaing the mount points. The old linux way (sda1, sdb1, etc) is not guaranteed that /sda1 is the same disk on next reboot. If you have trouble identiying them in terminal, you can always create a pool with symlinks to each file system with easy to remember names. 
+
+	This behaviour has been deprecated now in current omv releases including stable (Jessie). The default creation of mount paths is documented `here <https://github.com/openmediavault/openmediavault/blob/20ec529737e6eca2e1f98d0b3d1ade16a3c338e1/deb/openmediavault/usr/share/openmediavault/engined/rpc/filesystemmgmt.inc#L823-L833>`_
+
+I don't have a data disk, and I want to use my OS disk for storing data?
+	The default behaviour of OpenMediaVault is to act as NAS server, that means OS files are separated from data disks. 
+
+	You can use partitions in the same disk you use for OS and the system will recognise the partitions for formatting, mounting and to create shared folders. 
+
+	The current installer does not provide access to the partition manager, so you need to use a plain Debian iso then install OpenMediaVault on top and acommodate the partitions, or resize the partition after installing using Gparted or SystemRescueCd.
+
+Can I install OpenMediaVault on top a running Debian system?
+	Yes, but is not recommended that the running OS has a desktop environment installed.
+
+Which are the files that should not be edited by the user?
+	There are several services that OpenMediaVault takes control of, The recommended list is here.
+
+What is the permissions/ownership of folders in OMV created by shared folders?
+	The default is folders in ''2775'' mode, with ''root:users'' ownership. This means all users created in the webUI can read, write to folders created by the system in the data drives using the default.
+
+Why are my filesystems mounted as noexec?
+	This is a security measure to avoid the placement of malicious scripts in the shared folders. This will prevent any script execution in those paths, including compiling packages and binaries. 
+
+	If you need to remove the noexc flag, you need to use advanced settings.
+
+I need to delete a shared folder, why the delete button is greyed/disabled?
+	Shared folder configurations can be used across different services. If you need to remove a shared folder configuration you need to unlink it from every service is attached to it before the delete button becomes available. At the moment there is no internal database backend that can display information about which service is holding which shares.
+
+What is the :file:`omv-mkconf` command for?
+	:file:`omv-mkconf` is a terminal console command that is used by the backend of OMV to pipe directives and values to service configuration files. The arguments that omv-mkconf accepts are related to the name of the service it configures. Type ''omv-mkconf'' in terminal, press TAB key, and the terminal will display all available arguments.
+
+I want to experiment with OpenMediaVault or make changes to the code
+	As a true open source system you can do whatever you want with it. The recommendation is you don't do it in your home appliance server to avoid breaking the web interface. The best thing to do is to use a Virtual Machine. In [[http://sourceforge.net/projects/openmediavault/files/vm/VirtualBox%20images/|Sourceforge]] you can find a preconfigured OpenMediaVault virtual disk ready to launch. 
+
+What is the ''omv-update'' and ''omv-release-upgrade'' do?
+	Information about those commands are in the update/upgrade section
+
+
+

index.rst

@@ -27,6 +27,10 @@ plugins are available via the `OMV-Extras repository <http://omv-extras.org/>`_.
    copyright
    prerequisites
    installation/index
+   releases
+   plugins
+   support
+   FAQ
 
 
 

installation/index.rst

@@ -5,25 +5,21 @@ Installation
 
 You can install |omv| in 3 easy steps.
 
-1. Make sure your hardware is supported::
+Make sure your hardware is supported:
+   Before you proceed check if your hardware is supported on the system :doc:`requirements page </prerequisites>`.
 
-   Before you proceed check if your hardware is supported on the system
-   requirements page.
-
-2. Install the software::
 
+Install the software:
    Choose your Installation target and follow the instructions.
 
-   Dedicated Drive - Adviced Method, This runs OMV from its own Drive.
-   USB Flash Drive - This runs OMV from a USB flash-drive
-   Shared Data Drive - This runs OMV from a drive that also contains your data
-   Debian Operating System - This Runs OMV as a services on top of a Debian OS
+   **Dedicated Drive**  Adviced Method, This runs OMV from its own drive. A typical HDD will have much more endurance than USB flash media
+
+   **USB Flash Drive**  The operative system will be running from usb drives. This helps liberating a SATA port that can be used for data drives. Read :doc:`here </FAQ>` for information.
 
    You can read at top of of each method if its suitable for you situation,
    just pick the one that suits you best.
 
-3. First time use::
-
+First time use:
    Your NAS is installed and ready to be used for the for the first time.
 
 .. toctree::

plugins.rst

@@ -0,0 +1,19 @@
+Plugins
+=============
+
+The following is the list of official plugins by |omv|.
+
+* **CLAMAV**: Provides antivirus scan for folders
+
+* **Route**: Add static routes
+
+* **iSCSITarget**: Control panel for sharing block devices in the network.
+* **Forked-daap**: Provides a daap protocol music server
+* **LDAP**: Integrates the user management panel with a LDAP server
+* **LVM2**: LVM managing. Create volume groups and logical partitions.
+* **Netatalk**: Provides AFP sharing protocol used mainly in Mac OS X environments.
+* **Diskstats**: Complementary plugin to extend current system statistics collection by adding iostats graphs.
+* **NUT**: Controlling and configuring UPS. The driver support is based on NUT
+* **USB Backup**: Backup internal data to external disks on scheduled basis or on plug drive event (via UDEV)
+
+An overview of the third party plugin list can be found here

prerequisites.rst

@@ -3,7 +3,7 @@ Prerequisites
 
 Before installing |omv| make sure your hardware is supported.
 
-* CPU: Any i486 or amd64 compatible processor.
+* CPU: Any i486, amd64 or arm compatible processor.
 * RAM: 1 GiB capacity
 * HDD:
   * System Drive: min. 4 GiB capacity

releases.rst

@@ -0,0 +1,19 @@
+
+Releases
+=============
+
+
+.. csv-table:: |omv| historical releases
+   :header: "Version", "Codename", "Base Distro", "Status", "Date Released"
+   :widths: 5, 10, 10, 15, 30
+
+   0.2,Ix,Debian 6,EOL,Oct 2011
+   0.3,Omnious,Debian 6,EOL,Jul 2012
+   0.4,Fedaykin,Debian 6,EOL,Sep 2012
+   0.5,Sardoukar,Debian 6,EOL,Ago 2013
+   1.0,Kralizec,Debian 7,EOL,Sept 2014
+   2.0,Stoneburner,Debian 7,EOL,Jun 2015
+   3.0,Erasmus,Debian 8, Current, Jun 2016
+   4.0,Arrakis,Debian 9,In Development,Q2 2018 (Estimate)
+
+

support.rst

@@ -0,0 +1,12 @@
+Support
+=============
+
+At present there are two ways of getting support, both of them are done by the community. The current support channels are:
+
+|omv| `forums <http://forums.openmediavault.org/>`_.
+
+There is also the official IRC channel more info :doc:`here <various/irc>`
+
+Since last year there is also a discord group. You can get access by clicking `here <https://discord.gg/ZjknBdg>`_. 
+
+Make sure you provide as much information as you can when posting in the forum and describing your problem. If you have an error in the webUI make sure you take screenshots of the backtrace, to identify properly what's failing.

various/advancedsettings.rst

@@ -0,0 +1,2 @@
+Advanced Settings
+=========

various/irc.rst

@@ -0,0 +1,7 @@
+IRC Channel
+========
+
+.. _irc:
+
+
+We have a support IRC channel at freenode servers, just type :file:`/join #openmediavault` in your favourite IRC client, type your question and wait for someone available to help you.