diff --git a/docs/download.md b/docs/download.md index 5f48b28..d483c21 100644 --- a/docs/download.md +++ b/docs/download.md @@ -4,6 +4,7 @@ [![Debian Jessie](/img/os/debian2.png)](https://cdn.kobol.io/files/Helios4_Debian_Jessie_4.4.96.img.xz)
*Build date : 09/11/1017
+Size : 192.2 MB
MD5SUM : ccb4f043ac74cd87e2f2ed764f25381d* @@ -16,6 +17,7 @@ MD5SUM : ccb4f043ac74cd87e2f2ed764f25381d* [![OMV](/img/os/omv.png)](https://cdn.kobol.io/files/Helios4_Debian_Jessie_4.4.96-OMV_3.0.91.img.xz)
*Build date : 09/11/1017
+Size : 273.6 MB
MD5SUM : db76e9cfaa362b73d8840a0eacaa70c8* ### Syncloud @@ -27,5 +29,5 @@ MD5SUM : db76e9cfaa362b73d8840a0eacaa70c8* Filename | Download | MD5 ---------|----------|---- -**Helios4_Debian_Jessie_4.4.96.img.xz**
Debian Jessie (Kernel 4.4.96)
Build date : 09/11/1017|[Download](https://cdn.kobol.io/files/Helios4_Debian_Jessie_4.4.96.img.xz)|ccb4f043ac74cd87e2f2ed764f25381d -**Helios4_Debian_Jessie_4.4.96-OMV_3.0.91.img.xz**
Debian Jessie (Kernel 4.4.96) with OMV 3.0.91
Build date : 09/11/1017|[Download](https://cdn.kobol.io/files/Helios4_Debian_Jessie_4.4.96-OMV_3.0.91.img.xz)|db76e9cfaa362b73d8840a0eacaa70c8 +**Helios4_Debian_Jessie_4.4.96.img.xz**
Debian Jessie (Kernel 4.4.96)
Build date : 09/11/1017
Size : 192.2 MB|[Download](https://cdn.kobol.io/files/Helios4_Debian_Jessie_4.4.96.img.xz)|ccb4f043ac74cd87e2f2ed764f25381d +**Helios4_Debian_Jessie_4.4.96-OMV_3.0.91.img.xz**
Debian Jessie (Kernel 4.4.96) with OMV 3.0.91
Build date : 09/11/1017
Size : 273.6 MB|[Download](https://cdn.kobol.io/files/Helios4_Debian_Jessie_4.4.96-OMV_3.0.91.img.xz)|db76e9cfaa362b73d8840a0eacaa70c8 diff --git a/docs/hardware.md b/docs/hardware.md index d1a171b..ef97e25 100644 --- a/docs/hardware.md +++ b/docs/hardware.md @@ -39,7 +39,7 @@ Helios4 supports 4 boot modes that can be chosen by using the dipswitch SW1. All the ready-to-use images we provide are for the **SD Card** boot mode. -Please refer to [U-boot](./uboot) section to know how to use the other modes. +Please refer to [U-boot](/uboot) section to know how to use the other modes. ## LED indicators @@ -65,7 +65,7 @@ Helios4 board provides a RESET push button (U16) to hard reset the SoC (System-O ![Reset Button](/img/hardware/reset_button.jpg) !!! Important - This button only power reset the SoC and not the overall board power circuit. For instance it won't reset the HDD. + This button only resets the SoC and not the overall board. For instance it won't reset the HDD. ## HDD Recommendation List diff --git a/docs/img/install/connections.png b/docs/img/install/connections.png new file mode 100644 index 0000000..ebdd1e3 Binary files /dev/null and b/docs/img/install/connections.png differ diff --git a/docs/img/install/console_cable.png b/docs/img/install/console_cable.png new file mode 100644 index 0000000..e62b34e Binary files /dev/null and b/docs/img/install/console_cable.png differ diff --git a/docs/img/install/etcher_flash.png b/docs/img/install/etcher_flash.png new file mode 100644 index 0000000..6056036 Binary files /dev/null and b/docs/img/install/etcher_flash.png differ diff --git a/docs/img/install/first_login.png b/docs/img/install/first_login.png new file mode 100644 index 0000000..c94952f Binary files /dev/null and b/docs/img/install/first_login.png differ diff --git a/docs/img/install/minicom_config1.png b/docs/img/install/minicom_config1.png new file mode 100644 index 0000000..2523d36 Binary files /dev/null and b/docs/img/install/minicom_config1.png differ diff --git a/docs/img/install/minicom_config2.png b/docs/img/install/minicom_config2.png new file mode 100644 index 0000000..be87c54 Binary files /dev/null and b/docs/img/install/minicom_config2.png differ diff --git a/docs/img/install/network_cable.jpg b/docs/img/install/network_cable.jpg new file mode 100644 index 0000000..3d14684 Binary files /dev/null and b/docs/img/install/network_cable.jpg differ diff --git a/docs/img/install/network_config.png b/docs/img/install/network_config.png new file mode 100644 index 0000000..5905e48 Binary files /dev/null and b/docs/img/install/network_config.png differ diff --git a/docs/img/install/putty_config.png b/docs/img/install/putty_config.png new file mode 100644 index 0000000..5a8a6d7 Binary files /dev/null and b/docs/img/install/putty_config.png differ diff --git a/docs/img/install/putty_connect.png b/docs/img/install/putty_connect.png new file mode 100644 index 0000000..00a73d9 Binary files /dev/null and b/docs/img/install/putty_connect.png differ diff --git a/docs/img/install/ssh_login.png b/docs/img/install/ssh_login.png new file mode 100644 index 0000000..88acbdc Binary files /dev/null and b/docs/img/install/ssh_login.png differ diff --git a/docs/img/omv/dashboard.png b/docs/img/omv/dashboard.png new file mode 100644 index 0000000..f1db536 Binary files /dev/null and b/docs/img/omv/dashboard.png differ diff --git a/docs/img/omv/login.png b/docs/img/omv/login.png new file mode 100644 index 0000000..8b19a92 Binary files /dev/null and b/docs/img/omv/login.png differ diff --git a/docs/install.md b/docs/install.md index 1be66d8..0916808 100644 --- a/docs/install.md +++ b/docs/install.md @@ -4,37 +4,43 @@ !!! note Go to [Starter Kit](./kit) to find out how to put together your Helios4 NAS -## **What you need before your start.** - -You need a microSD card UHS-I with a minimum of 8GB. Ideally Speed Class 3. - -We recommend the following models : - -- Samsung Evo Pro+ 32GB -- SanDisk Extreme Pro 32GB +## **What you need before you start.** +**1. microSD Card
** +You need a microSD Card UHS-I with a minimum of 8GB. Ideally Speed Class 3.
+We recommend the following models:
+\- Samsung Evo Pro+ 32GB
+\- SanDisk Extreme Pro 32GB
![Recommended SDcard](/img/install/recommended_sdcard.jpg) -## **Step 1** - Download an Helios4 OS image +**2. Micro-USB to USB cable
** +![USB cable](/img/install/console_cable.png) -You will need first to download an image to write on SD card. +**3. Ethernet cable (cat5/6)
** +![Network cable](/img/install/network_cable.jpg) -Go to [Dowload](./download) and chose one of the latest build. -## **Step 2** - Writing an image to an SD card +## **Step 1** - Download an Helios4 build image -You will need to use an image writing tool to install the image you have downloaded on your SD card. +You will need first to download a build image to write on the microSD Card. + +Go to [Dowload](/download) and chose one of the latest build. + +## **Step 2** - Writing an image to a microSD Card + +You will need to use an image writing tool to install on your microSD Card the build image you have downloaded. ### Under Windows, Mac OS or Linux (via Graphic Interface) -Etcher is a graphical SD card writing tool that works on Mac OS, Linux and Windows, and is the easiest option for most users. Etcher also supports writing images directly from the XZ file, without any prerequired decompression. To write your image with Etcher: +Etcher is a graphical SD card writing tool that works on Mac OS, Linux and Windows, and is the easiest option for most users. Etcher also supports writing images directly from XZ files, without any prerequired decompression. To write your image with Etcher: -- [Download Etcher](http://etcher.io) and install it. -- Connect an SD card reader with the SD card inside. -- Open Etcher and select from your local storage the Helios4 .img.xz file you wish to write to the SD card. -- Select the SD card you wish to write your image to. -- Review your selections and click 'Flash!' to begin writing data to the SD card. +- [Download Etcher](http://etcher.io) and install it on your computer. +- Insert the microSD Card inside your SD card reader (microSD to SD adapter might be needed). +- Open Etcher and select from your local storage the Helios4 .img.xz file you wish to write to the microSD Card. +- Select the microSD Card you wish to write your image to. +- Review your selections and click 'Flash!' to begin writing data to the microSD Card. +![Etcher](/img/install/etcher_flash.png) ### Under Linux (via CLI) @@ -46,14 +52,96 @@ $ dd bs=4M if=Helios4_Debian_Jessie_4.4.96.img of=/dev/sdX conv=fsync ## **Step 3** - Power-up Helios4 +**Before powering-up insure :** -## **Step 4** - Connect to Helios4 +1. You inserted the microSD Card that you prepared in the previous step. -**Default credential** +2. You connected your computer to the serial port with the Micro-USB to USB cable. + +3. You connected Helios4 to your home network with the Ethernet cable. + +4. You plugged-in properly the DC power connector before powering-up the AC adapter. + +![Connections](/img/install/connections.png) + +**Now you can plug-in / power-up the AC adapter.** + +## **Step 4** - Connect to Helios4 serial console + +### Under Windows + +1. [Download PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) and install it on your computer. + +2. Setup serial port settings (Speed : **115200** and Flow control : **None**).
+![Putty config](/img/install/putty_config.png) + +3. Select **serial** and click 'Open'.
+![Putty connect](/img/install/putty_connect.png) + +!!! note + 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) + +1. Install and launch minicom +> $ sudo apt-get install minicom
+> $ sudo minicom -D /dev/ttyUSB0 -b 115200 + +2. Setup serial port settings
+press **CTRL-A O**, then go to menu 'Serial port setup'. +![Minicom config](/img/install/minicom_config1.png) + +3. Disable Hardware Flow control
+press **F**, then press **ESC** twice. +![Minicom config](/img/install/minicom_config2.png) + + +## **Step 5** - Log in + +!!! note + You might need to press enter for the login prompt to come up. + +**Default credential for Debian image** ```bash helios4 login: root Password: 1234 ``` -You will be prompted to change the root password and then create a standard user account. +You will be prompted to change the root password and then create a new user account. + +**Default credential for OpenMediaVault image** + +```bash +helios4 login: root +Password: openmediavault +``` + +You will be prompted to change the root password. + +![First Login](/img/install/first_login.png) + +## **Step 6** - Check/Set IP address + +By default Helios4 will try to obtain an IP address via DHCP. To figure out what is the allocated IP address you will need to type the following command in the console. + +```bash +$ ifconfig eth0 +``` + +![Network Config](/img/install/network_config.png) + +Here the IP address of Helios4 is **10.10.10.1**. + +If you wish to manually configure your IP address refer to the following Debian Wiki [Page](https://wiki.debian.org/NetworkConfiguration#Setting_up_an_Ethernet_Interface). + +!!! note + Openmediavault comes with **mDNS** server (Avahi daemon). Therefore if your desktop/laptop runs a mDNS client you can reach the board via the following hostname address : **helios4.local** + +## **What to do next ?** + +**If you have installed an OpenMediaVault image, refer to the [OMV page](/omv) for further instructions.** + +Otherwise you can now connect by SSH to your Helios4 to carry on with your manual configuration. + +![SSH Login](/img/install/ssh_login.png) diff --git a/docs/omv.md b/docs/omv.md index 97f4cd4..71d1066 100644 --- a/docs/omv.md +++ b/docs/omv.md @@ -1,2 +1,26 @@ !!! info Wiki edition in progress + +## Connect to OpenMediaVault Control Panel + +Open your web browser and go to the one of the following addresses : + +* http://helios4.local
+* http://*xxx.xxx.xxx.xxx* ([How to check Helios4 IP address](/install/#step-6-checkset-ip-address)) + +**Default credential :** + +* Username: admin +* Password: openmediavault + +![OMV Login](/img/omv/login.png) +*Login Screen* + +![OMV Dashboard](/img/omv/dashboard.png) +*Dashboard View* + +## Configure a RAID + +## Create a LVM Logical Volume + +## Configure Share drive diff --git a/mkdocs.yml b/mkdocs.yml index 5b7a01a..aafc3c7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,6 +7,7 @@ site_url: 'https://wiki.kobol.io' # Repository repo_name: 'Helios4 GitHub Repo' repo_url: 'https://github.com/helios-4' +edit_uri: '' # Copyright copyright: 'Copyright © Kobol Team 2017'