Update OMV guide

Update IMG Release
Overall Clean-up
Update README with instructions

README.md

@@ -2,6 +2,38 @@
 
 Powered by mkdocs : http://www.mkdocs.org/
 
-Template : http://squidfunk.github.io/mkdocs-material/
+### Template
+Material : http://squidfunk.github.io/mkdocs-material/
 
-Lightbox Markdown Extension : https://github.com/g-provost/lightgallery-markdown
+### Extension
+Lightgallery : https://github.com/g-provost/lightgallery-markdown
+
+## How to run this wiki locally
+
+1. Install mkdocs
+
+```bash
+$ pip install mkdocs
+```
+
+2. Install Material Template
+
+```bash
+$ pip install mkdocs-material
+```
+
+3. Install Lightgallery Extension
+
+```bash
+$ git clone https://github.com/g-provost/lightgallery-markdown.git
+
+$ cd lightgallery-markdown
+
+$ python setup.py install
+```
+
+4. Cloning and Start mkdocs server
+
+```bash
+$ mkdocs serve
+```

docs/dev.md

@@ -1,6 +1,3 @@
-!!! info
-    Wiki edition in progress
-
 Helios4 Github Development Repositories :
 
 * [U-Boot](https://github.com/helios-4/u-boot-marvell)

docs/docs.md

@@ -1,6 +1,5 @@
 # Helios4 Documents
 
-
 ## Carrier Board
 
 Doc-Type | Filename | Version | Date | Download | Description

docs/download.md

@@ -24,7 +24,6 @@ MD5SUM : 6d2e3cea12c2e4091de6cfac24daa9fc*
 
 *coming soon*
 
-
 ## Image List
 
 Filename | Download | MD5

docs/hardware.md

@@ -1,10 +1,10 @@
 ## Block Diagram
 
-![Block Diagram](/img/hardware/block_diagram.jpg)
+![!Block Diagram](/img/hardware/block_diagram.jpg)
 
 ## Connector / Interface List
 
-![Board Legend](/img/hardware/board_legend.jpg)
+![!Board Legend](/img/hardware/board_legend.jpg)
 
 Name |Peripheral Type|Connector Type|Details
 -----|---------------|--------------|-------

docs/install.md

@@ -39,7 +39,7 @@ Etcher is a graphical SD card writing tool that works on Mac OS, Linux and Windo
 
 ![Etcher](/img/install/etcher_flash.png)
 
-### Under Linux (via CLI)
+### Under Linux (via Terminal)
 
 ```bash
 $ unxz Helios4_Debian_Jessie_4.4.96.img.xz
@@ -82,7 +82,7 @@ $ dd bs=4M if=Helios4_Debian_Jessie_4.4.96.img of=/dev/sdX conv=fsync
     If you computer already has a serial port then COM1 might not be the correct serial line to connect to Helios4. Check this [link](https://tnp.uservoice.com/knowledgebase/articles/172101-determining-the-com-port-of-a-usb-to-serial-adapte) to learn how to determine the right COM port.
 
 
-### Under Linux (via CLI)
+### Under Linux (via Terminal)
 
 1. Install picocom (under Debian/Ubuntu)
 > $ sudo apt-get install picocom<br>
@@ -171,3 +171,5 @@ $ sudo reboot
 Otherwise you can now connect by SSH to your Helios4 to carry on with your configuration.
 
 ![SSH Login](/img/install/ssh_login.png)
+
+![Putty SSH](/img/install/putty_ssh.png)

docs/kernel.md

@@ -1,2 +1,2 @@
 !!! info
-    Wiki edition in progress
+    To be done.

docs/linux.md

@@ -1,2 +1,2 @@
 !!! info
-    Wiki edition in progress
+    To be done.

docs/omv.md

@@ -1,6 +1,3 @@
-!!! info
-    Wiki edition in progress
-
 This is a basic guide to help you setting up Helios4 NAS with [OpenMediaVault](https://www.openmediavault.org/) (**OMV**). OMV offers a large collection of features that we don't cover here. We invite you to look online for the existing OMV guides or go on the [OMV forum](https://forum.openmediavault.org/).
 
 ## Connect to OpenMediaVault (OMV) Control Panel
@@ -23,106 +20,341 @@ Open your web browser and go to the one of the following addresses :
 
 ## Wipe Disk (Optional)
 
-If you are using HDD which aren't blank or brand new you might need to wipe them first before being able to setup an RAID array.
+If you are using HDDs which aren't blank or brand new you might need to wipe them first before being able to setup a RAID array.
 
-> Go to **Physical Disks** section.
+> Go to **Physical Disks** page in *Storage* section.
 
 > Select an HDD and click **Wipe**.
 
 !!! note
-    HDD should be device starting with **/dev/sdX**
+    HDDs are the devices starting with **/dev/sdX**
 
-![!OMV HDD Wipe](/img/omv/disk-wipe1.png)
+![!OMV HDD Wipe](/img/omv/disk_wipe1.png)
 
-> Choose **Quick** wipe method.
+> Click **Quick** wipe method.
 
-![OMV HDD Wipe](/img/omv/disk-wipe2.png)
+![!OMV HDD Wipe](/img/omv/disk_wipe2.png)
 
-> Repeat this step for each HDD you want to use for your RAID array.
+> Repeat above steps for each HDD you want to use for your RAID array.
 
 
 ## Create a RAID array
 
-In this guide we chose to create a RAID10 for the following reasons :
+In this guide we chose to create a RAID10 with 4 HDDs for the following reasons :
 
-- A
-- B
-- C
+- Best performance, less compute intensive.
+- Fastest (re)build, less performance degradation.
+- Support up to 2 disk failures, but not every 2 disk failures combination like RAID6.
 
-You can choose to go for RAID5 or RAID6 but take in consideration that the syncing will take up to 3 times the syncing time of RAID10.
+!!! info
+    You can choose to go for  RAID6 but take in consideration that the building will take up to 3 times the building time of RAID10. There are plenty of threads online which compare the pros and cons between each RAID option.
 
-> Go to **RAID Management** section.
+> Go to **RAID Management** page in *Storage* section.
 
 > Click **Create**.
 
-> Select RAID level and the devices you want to be used for the RAID array.
+> Select RAID level and the devices you want to use for the RAID array.
 
-> Give it a name and press **Create**.
+> Give it a name and click **Create**.
 
 
-![OMV RAID 10](/img/omv/create-raid10.png)
+![!OMV RAID 10](/img/omv/create_raid10.png)
 
-> You can see the ongoing re-syncing process and get a finish estimated time.
+You can see the ongoing build / re-syncing process and get an estimated finish time.
 
-![OMV RAID Syncing](/img/omv/syncing-raid10.png)
+![!OMV RAID Syncing](/img/omv/syncing_raid10.png)
 
 !!! important
     While you could carry on with some part of OMV configuration during the RAID re-syncing process, we strongly advice to let this process complete first. You should see the following in the RAID state once re-syncing is complete : **active**.
 
-![OMV RAID Clean](/img/omv/raid10-active.png)
-
+![!OMV RAID Clean](/img/omv/raid10_active.png)
 
 !!! info
     Whenever you change some settings in OMV, the following banner will appear. You can immediately apply the configuration by clicking **Apply** or you can carry on with your configuration and apply the changes at a later stage.
-![OMV Save Settings](/img/omv/save_settings.png)
+![!OMV Save Settings](/img/omv/save_settings.png)
 
 
 
+## Install LVM Plugin
+
+To have a better control of storage partitioning we will use Linux Logical Volume Manager (LVM). To create Logical Volume in OMV you will need first to install the LVM plugin.
+
+> Go to **Plugins** page in *System* section.
+
+![!Plugin List](/img/omv/plugin_list.png)
+
+To get the latest plugins you will need to update the plugins database.
+
+> Click **Check**
+
+![!Plugin Update](/img/omv/plugin_update.png)
+
+Once plugins database update is done :
+
+> Search for *lvm* in the search field.
+
+> Select openmediavault-lvm2 and click **Install**.
+
+![!Plugin LVM](/img/omv/plugin_lvm.png)
+
+> Wait till the lvm plugins install shows *Done...* then click **Close**.
+
+![!Plugin Install](/img/omv/plugin_install.png)
+
+!!! info
+    OMV Control Panel will reload and you should see the **Logical Volument Management** page in *Storage* section.
+
 ## Create a LVM Logical Volume
 
-*First you need to install OMV LVM Plugin.*
+To create a Logicial Volume 3 steps are necessary :
 
-![LVM Install Plugin](/img/omv/lvm-plugin.png)
+1. Add a Physical Volume. (The RAID array you created previously)
+2. Add a Volume Group. (Volume Group contains Physical Volumes)
+3. Add one ore more Logical Volumes. (Logical Volumes are like partitions)
 
-![LVM Add Physical Volume](/img/omv/lvm-add-pv.png)
+> Go to **Logical Volument Management** page in *Storage* section.
 
-![LVM Add Volume Group](/img/omv/lvm-add-vg.png)
+> Click **Add** under *Physical Volumes* tab.
 
-![LVM Add Logical Volume](/img/omv/lvm-add-lv.png)
+> Select the RAID array you created previously and click **Save**.
 
-![LVM Volumes](/img/omv/lvm-lv-volumes.png)
+
+![!LVM Add Physical Volume](/img/omv/lvm_add-pv.png)
+
+> Go to *Volume groups* tab.
+
+> Click **Add**.
+
+> Select the Physical Volume you just created.
+
+> Give it a name and click **Save**.
+
+![!LVM Add Volume Group](/img/omv/lvm_add-vg.png)
+
+> Go to *Logical volumes* tab.
+
+> Click **Add**.
+
+> Select the Volume Group you just created.
+
+> Choose a partition size.
+
+> Give it a name and click **Save**.
+
+![!LVM Add Logical Volume](/img/omv/lvm_add-lv.png)
+
+!!! info
+    You can create several Logical Volumes according to your needs and the way you want to organize your data.
+
+    In the current example we created 2 volumes :
+
+    - public : to put all non-sensitive data like movie & music collections.
+    - secure : to setup an encrypted space for sensitive data (not covered in this guide).
+
+![!LVM Volumes](/img/omv/lvm_lv-volumes.png)
 
 
 ## Format and Mount Volume
 
-![Format Volume](/img/omv/format-volume.png)
+Now that your Logical Volumes are created, you need to format and mount them in order to use them.
 
-![Format Process](/img/omv/format-process.png)
+> Go to **File System** page in *Storage* section.
 
-![Format Status](/img/omv/format-status.png)
+> Click **Create**
 
-![Format Complete](/img/omv/format-complete.png)
+> Choose a Logical Volume you created.
 
-![Format Volume](/img/omv/format-volume.png)
+> Choose a File system type (e.g EXT4).
+
+> Give it a label and click **OK**.
+
+!!! info
+    While you could choose BTRFS as a copy-on-write File system (COW), we recommend to use to EXT4 unless you know how to take advantage of BTRFS features.
+
+![!Format Volume](/img/omv/format_volume.png)
+
+You can see the ongoing formatting process. You don't have to wait the process to finish.
+
+> Click **Close**.
+
+![!Format Process](/img/omv/format_process.png)
+
+You can check the status of all devices.
+
+Once formatting process is complete, device status will show *Online*.
+
+!!! info
+    Depending on your Logical Volume size, formatting can take a while to complete.
+
+![!Format Status](/img/omv/format_status.png)
+
+> Select device you formatted and click **Mount**.
+
+![!Mount Volume](/img/omv/mount_volume.png)
+
+> Repeat the action for each Logical Volume you created.
 
 ## Create User
 
-![User Create](/img/omv/user-create.png)
+In this guide we will create a super user *john* that will have the write access on the share folders we will create. We will also give SSH access and sudo right to this user.
 
-![User Group](/img/omv/user-group.png)
+> Go to **User** page in *Access Rights Management* section.
+
+> Click **Add** under *Users* tab.
+
+> Fill Name and Password section.
+
+> Select */bin/bash* for Shell (Optional).
+
+![!User Create](/img/omv/user_create.png)
+
+> Go to *Groups* tab.
+
+> Activate group *ssh* and *sudo*.
+
+> Click **Save**.
+
+![!User Group](/img/omv/user_group.png)
 
 ## Create Shared Folder
 
-![Folder Add](/img/omv/folder-add.png)
+Now you need to create Shared Folders that will be exposed through network sharing services. OMV offers many sharing service options, however in this guide we only show how to setup a Windows Share which is the most common option.
 
-![Folder List](/img/omv/folder-list.png)
+> Go to **Share Folders** page in *Access Rights Management* section.
+
+> Click **Add**.
+
+> Fill Name (e.g movie).
+
+> Select Device which is one of the Logical Volumes you created and mounted previously.
+
+> Change Path Name if necessary.
+
+!!! info
+    You can leave the default permission. But later on you should explore how the permissions settings work and impact your Share Folders.
+
+![!Folder Add](/img/omv/folder_add.png)
+
+> Repeat the action to add more Share Folders.
+
+Once done you can see the list of Share Folders you have created and under which Device / Logical Volume they are.
+
+![!Folder List](/img/omv/folder_list.png)
 
 ## Configure Windows Share (SMB/CIFS)
 
-![Share Enable](/img/omv/share-enable.png)
+We will now activate the Windows Share service (a.k.a SMB/CIFS) and enlist the Share Folders you created previously.
 
-![Share Add](/img/omv/share-add.png)
+> Go to **SMB/CIFS** page in *Services* section.
 
-![Share List](/img/omv/share-list.png)
+> Toggle the Enable button under *General Settings*.
 
-## Accessing Shared Folder
+![!Share Enable](/img/omv/share_enable.png)
+
+> Go to *Shares* tab.
+
+> Click **Add**.
+
+> Choose a Shared Folder that you created previously.
+
+> Choose the Public settings (e.g Guests Allowed).
+
+> Click **Save**
+
+![!Share Add](/img/omv/share_add.png)
+
+Once done you can see the list of active Shares.
+
+![!Share List](/img/omv/share_list.png)
+
+!!! info
+    Don't forget to apply your settings by clicking **Apply** when the following banner appears.
+
+![!OMV Save Settings](/img/omv/save_settings.png)
+
+**Now you should be able to access your Share Folders from your laptop / computer connected to your Home network.**
+
+
+## Accessing Shared Folder (Linux / Ubuntu)
+
+### Using File Manager
+
+Some Linux flavors, like Ubuntu, provide File Manager that supports natively Windows Share Folder discovery and access.
+
+> Open File Manager
+
+> Go to Network
+
+> Click **helios4 - SMB/CIFS**
+
+!!! info
+    If your File Manager doesn't find helios4, it can be due that your laptop / computer is not on the same subnet that Helios4. Check your network configuration.
+
+
+![!Share Network](/img/omv/share_network.png)
+
+> Click on one of the Share Folders (e.g movie).
+
+> Select *Registered User*.
+
+> Enter Username and Password of the user you created previously (e.g john).
+
+> click **Connect**.
+
+![!Share Credential](/img/omv/share_credential.png)
+
+Now you should be connected to the Share Folder. Check in the side pane, you should see something like *'movie on helios4.local'* with an Eject icon.
+
+You can start copying over from your laptop / computer files in the Share Folder.
+
+![!Share File](/img/omv/share_file.png)
+
+You can also try to access as anonymous user which should allow you access the files but not to add / delete files.
+
+> Click the **Eject** icon of the Share Folder.
+
+> Repeat above steps but this time connect as *Anonymous*.
+
+![!Share Anonymous](/img/omv/share_anonymous.png)
+
+You can repeat the above steps to connect to your other Share Folders.
+
+### Using Terminal
+
+```bash
+$ mount -t cifs //10.10.10.1/movie /mnt -o username=anonymous
+```
+
+## Accessing Shared Folder (Windows)
+
+> Open File Explorer.
+
+> Go to Network.
+![!Windows Discovery](/img/omv/windows_discovery.png)
+
+!!! info
+    If your File Manager doesn't find helios4, it can be due that your laptop / computer is not on the same subnet that Helios4. Check your network configuration.
+
+> Go to Helios4.
+
+> Right-Click on a Share Folder and click **Map network drive...**.
+
+![!!Windows Access](/img/omv/windows_access.png)
+
+> Check *Connect using different credentials*.
+
+> Click **Finish**.
+
+![!!Windows Drive](/img/omv/windows_netdrive.png)
+
+> Enter Username and Password of the user you created previously (e.g john).
+
+> click **OK**.
+
+![!!Windows Credential](/img/omv/windows_credential.png)
+
+Now you should be connected to the Share Folder. Check in the side pane, you should see something like *'movie (\\\\HELIOS4)'*.
+
+![!Windows Share](/img/omv/windows_share.png)
+
+You can repeat the above steps to connect to your other Share Folders.

docs/syncloud.md

@@ -1,2 +1,2 @@
 !!! info
-    Wiki edition in progress
+    To be done.

docs/uboot.md

@@ -1,2 +1,2 @@
 !!! info
-    Wiki edition in progress
+    To be done.

mkdocs.yml

@@ -39,7 +39,7 @@ extra:
     - type: 'rss-square'
       link: 'https://blog.kobol.io'
   sd_release:
-    latest: '29/11/2017'
+    latest: '18/12/2017'
 
 # Google Analytics
 google_analytics:

theme/partials/header.html

@@ -4,9 +4,9 @@
       <div class="md-flex__cell md-flex__cell--shrink">
         <a href="{{ config.site_url | default(nav.homepage.url, true) }}" title="{{ config.site_name }}" class="md-header-nav__button md-logo">
           {% if config.theme.logo.icon %}
-            <i class="md-icon">{{ config.theme.logo.icon }}</i>
+          <i class="md-icon">{{ config.theme.logo.icon }}</i>
           {% else %}
-            <img src="{{ base_url }}/{{ config.theme.logo }}" width="24" height="24">
+          <img src="{{ base_url }}/{{ config.theme.logo }}" width="24" height="24">
           {% endif %}
         </a>
       </div>
@@ -16,32 +16,32 @@
       <div class="md-flex__cell md-flex__cell--stretch">
         <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
           {% block site_name %}
-            {% if config.site_name == page.title %}
-              {{ config.site_name }}
-            {% else %}
-              <span class="md-header-nav__topic">
-                {{ config.site_name }}
-              </span>
-              <span class="md-header-nav__topic">
-                {{ page.title }}
-              </span>
-            {% endif %}
+          {% if config.site_name == page.title %}
+          {{ config.site_name }}
+          {% else %}
+          <span class="md-header-nav__topic">
+            {{ config.site_name }}
+          </span>
+          <span class="md-header-nav__topic">
+            {{ page.title }}
+          </span>
+          {% endif %}
           {% endblock %}
         </div>
       </div>
       {% if config.repo_url %}
-        <div class="md-flex__cell md-flex__cell--shrink">
-          <div class="md-header-nav__source">
-            {% include "partials/source.html" %}
-          </div>
+      <div class="md-flex__cell md-flex__cell--shrink">
+        <div class="md-header-nav__source">
+          {% include "partials/source.html" %}
         </div>
+      </div>
       {% endif %}
       <div class="md-flex__cell md-flex__cell--shrink">
         <div class="md-header-nav__source">
           <a href="/download" title="Go to Download" class="md-source">
- <div class="md-source__icon" style="vertical-align:middle; display:inline-block; height:100%">
-   <img src="/img/sd.png" style="position:relative; left:10px;">
-</div>
+            <div class="md-source__icon" style="vertical-align:middle; display:inline-block; height:100%">
+              <img src="/img/sd.png" style="position:relative; left:10px;">
+            </div>
             <div class="md-source__repository">
               Download IMG
               <ul class="md-source__facts">
@@ -53,10 +53,10 @@
       </div>
       <div class="md-flex__cell md-flex__cell--shrink">
         {% block search_box %}
-          {% if "search" in config["plugins"] %}
-            <label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
-            {% include "partials/search.html" %}
-          {% endif %}
+        {% if "search" in config["plugins"] %}
+        <label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
+        {% include "partials/search.html" %}
+        {% endif %}
         {% endblock %}
       </div>
     </div>

theme/partials/nav.html

@@ -2,17 +2,17 @@
   <label class="md-nav__title md-nav__title--site" for="drawer">
     <span class="md-nav__button md-logo">
       {% if config.theme.logo.icon %}
-        <i class="md-icon">{{ config.theme.logo.icon }}</i>
+      <i class="md-icon">{{ config.theme.logo.icon }}</i>
       {% else %}
-        <img src="{{ base_url }}/{{ config.theme.logo }}" width="24" height="24">
+      <img src="{{ base_url }}/{{ config.theme.logo }}" width="24" height="24">
       {% endif %}
     </span>
     {{ config.site_name }}
   </label>
   {% if config.repo_url %}
-    <div class="md-nav__source">
-      {% include "partials/source.html" %}
-    </div>
+  <div class="md-nav__source">
+    {% include "partials/source.html" %}
+  </div>
   {% endif %}
   <div class="md-nav__source">
     <a href="/download" title="Go to Download" class="md-source">
@@ -29,9 +29,9 @@
   </div>
   <ul class="md-nav__list" data-md-scrollfix>
     {% for nav_item in nav %}
-      {% set path = "nav-" + loop.index | string %}
-      {% set level = 1 %}
-      {% include "partials/nav-item.html" %}
+    {% set path = "nav-" + loop.index | string %}
+    {% set level = 1 %}
+    {% include "partials/nav-item.html" %}
     {% endfor %}
   </ul>
 </nav>