diff --git a/docs/helios64/img/install/armbian-config-eth-select.png b/docs/helios64/img/install/armbian-config-eth-select.png new file mode 100755 index 0000000..168d0ce Binary files /dev/null and b/docs/helios64/img/install/armbian-config-eth-select.png differ diff --git a/docs/helios64/img/install/armbian-config-ip-set.png b/docs/helios64/img/install/armbian-config-ip-set.png new file mode 100755 index 0000000..e64ff1b Binary files /dev/null and b/docs/helios64/img/install/armbian-config-ip-set.png differ diff --git a/docs/helios64/img/install/armbian-config-ip-static.png b/docs/helios64/img/install/armbian-config-ip-static.png new file mode 100755 index 0000000..7e4decd Binary files /dev/null and b/docs/helios64/img/install/armbian-config-ip-static.png differ diff --git a/docs/helios64/img/install/armbian-config-network.png b/docs/helios64/img/install/armbian-config-network.png new file mode 100755 index 0000000..8a0c1fb Binary files /dev/null and b/docs/helios64/img/install/armbian-config-network.png differ diff --git a/docs/helios64/img/install/armbian-config.png b/docs/helios64/img/install/armbian-config.png new file mode 100755 index 0000000..f4fc089 Binary files /dev/null and b/docs/helios64/img/install/armbian-config.png differ diff --git a/docs/helios64/img/install/connections.jpg b/docs/helios64/img/install/connections.jpg new file mode 100755 index 0000000..9b87dce Binary files /dev/null and b/docs/helios64/img/install/connections.jpg differ diff --git a/docs/helios64/img/install/etcher_flash.png b/docs/helios64/img/install/etcher_flash.png new file mode 100755 index 0000000..e4e507b Binary files /dev/null and b/docs/helios64/img/install/etcher_flash.png differ diff --git a/docs/helios64/img/install/first-boot-userpass.png b/docs/helios64/img/install/first-boot-userpass.png new file mode 100755 index 0000000..d735d91 Binary files /dev/null and b/docs/helios64/img/install/first-boot-userpass.png differ diff --git a/docs/helios64/img/install/ifconfig.png b/docs/helios64/img/install/ifconfig.png new file mode 100755 index 0000000..d4d4dbf Binary files /dev/null and b/docs/helios64/img/install/ifconfig.png differ diff --git a/docs/helios64/img/install/network_cable.jpg b/docs/helios64/img/install/network_cable.jpg new file mode 100644 index 0000000..3d14684 Binary files /dev/null and b/docs/helios64/img/install/network_cable.jpg differ diff --git a/docs/helios64/img/install/picocom.png b/docs/helios64/img/install/picocom.png new file mode 100755 index 0000000..1d2843e Binary files /dev/null and b/docs/helios64/img/install/picocom.png differ diff --git a/docs/helios64/img/install/putty-connect.png b/docs/helios64/img/install/putty-connect.png new file mode 100755 index 0000000..124c206 Binary files /dev/null and b/docs/helios64/img/install/putty-connect.png differ diff --git a/docs/helios64/img/install/putty-connect2.png b/docs/helios64/img/install/putty-connect2.png new file mode 100755 index 0000000..18007fc Binary files /dev/null and b/docs/helios64/img/install/putty-connect2.png differ diff --git a/docs/helios64/img/install/putty_ssh.png b/docs/helios64/img/install/putty_ssh.png new file mode 100755 index 0000000..f5cf6f2 Binary files /dev/null and b/docs/helios64/img/install/putty_ssh.png differ diff --git a/docs/helios64/img/install/recommended_sdcard.jpg b/docs/helios64/img/install/recommended_sdcard.jpg new file mode 100644 index 0000000..6b9486c Binary files /dev/null and b/docs/helios64/img/install/recommended_sdcard.jpg differ diff --git a/docs/helios64/img/install/serial-port.png b/docs/helios64/img/install/serial-port.png new file mode 100755 index 0000000..65267e8 Binary files /dev/null and b/docs/helios64/img/install/serial-port.png differ diff --git a/docs/helios64/img/install/ssh_login.png b/docs/helios64/img/install/ssh_login.png new file mode 100755 index 0000000..0c8ebae Binary files /dev/null and b/docs/helios64/img/install/ssh_login.png differ diff --git a/docs/helios64/img/omv/install-1.png b/docs/helios64/img/omv/install-1.png new file mode 100755 index 0000000..1b469b6 Binary files /dev/null and b/docs/helios64/img/omv/install-1.png differ diff --git a/docs/helios64/img/omv/install-2.png b/docs/helios64/img/omv/install-2.png new file mode 100755 index 0000000..a6900da Binary files /dev/null and b/docs/helios64/img/omv/install-2.png differ diff --git a/docs/helios64/img/omv/install-3.png b/docs/helios64/img/omv/install-3.png new file mode 100755 index 0000000..7c98627 Binary files /dev/null and b/docs/helios64/img/omv/install-3.png differ diff --git a/docs/helios64/img/omv/install-4.png b/docs/helios64/img/omv/install-4.png new file mode 100755 index 0000000..6005724 Binary files /dev/null and b/docs/helios64/img/omv/install-4.png differ diff --git a/docs/helios64/install.md b/docs/helios64/install.md new file mode 100644 index 0000000..ee6bc31 --- /dev/null +++ b/docs/helios64/install.md @@ -0,0 +1,257 @@ +!!! note + Go to [Kit Assembly](/helios64/kit) to find out how to assembly Helios64. + +## **What you need before you start.** + +**1. microSD Card
** +You need a microSD Card UHS-I with a minimum capacity of 8GB to be able to flash Helios64 image. + +We recommend the following models: + +- SanDisk Extreme microSDHC UHS-I Card (32GB) +- SanDisk Extreme PRO microSDHC UHS-I Card (32GB) +- Strontium Nitro MicroSD Card (16GB) +- Samsung microSDHC UHS-I Card EVO Plus (32GB) + +![Recommended SDcard](/helios64/img/install/recommended_sdcard.jpg) + +**2. USB Type-C to Type-A cable
** +![Type C to Type A USB cable](/helios64/img/usb/typec_typea_male.jpg) + +**3. Ethernet cable (cat5/6)
** +![Network cable](/helios64/img/install/network_cable.jpg) + + +## **Step 1** - Download an Helios64 image build + +You will need first to download an image to write on the microSD Card. + +Go to [Dowload](/helios64/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 image build 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, this is the easiest method for most users. Etcher also supports writing images directly from XZ files, without any prerequired decompression. To write your image with Etcher: + +- [Download Etcher](https://www.balena.io/etcher/) 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 the Helios64 image file from your local storage. +- 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](/helios64/img/install/etcher_flash.png) + +### Under Linux (using dd via Terminal) + +Armbian images are using XZ compression format, therefore we need xz-utils or xz tools to decompress the image first. + +for Debian-based distribution (Debian/Ubuntu) you can install the utility using following command: +```bash +apt-get install xz-utils +``` + +in RedHat-based distribution (RHEL / CentOS / Fedora Linux) users can use this command: +```bash +yum install xz +``` + +after installing the compression tool, you can now decompress the images: +```bash +xz -dk Armbian_20.08.0_Helios64_buster_current_5.7.15.img.xz +``` + +finally we can write the images to sdcard using dd: + +```bash +sudo dd if=Armbian_20.08.0_Helios64_buster_current_5.7.15.img of=/dev/sdX bs=4M conv=fsync status=progress +``` + +*Replace the filename by the image file name you downloaded.* + +!!! note + /dev/sdX is where the microSD is mapped in your Linux machine, change the 'X' to your corresponding mapped device. If you set /dev/sdX to a wrong device then you might risk erasing a hard drive or different device than the designated microSD. + +## **Step 3** - Power-up Helios64 + +**Before powering-up make sure:** + +1. You inserted the prepared microSD Card. + +2. You connected your computer to the serial port with the Type-C to Type-A USB cable. + +3. You connected Helios64 to your home network with the Ethernet cable. + +4. You plugged-in properly the DC power connector before powering-up the AC adapter. + +![Connections](/helios64/img/install/connections.jpg) + +**Now you can plug-in the AC adapter and push the [Power Button](/helios64/button/)** + +!!! warning + Always proceed with caution when manipulating 110/220V appliance. + +## **Step 4** - Connect to Helios64 serial console + +!!! Important + Under Windows 10 the FTDI driver will be autodetected, you can use this microsoft default driver to access the USB to serial bridge used by Helios64. + +### Under Windows + +1. [Download PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) and install it on your computer. + +2. Make sure your serial communication device is already detected by system. +![Serial detected](/helios64/img/install/serial-port.png) + +2. Select connection type **serial**.
+![Putty connect](/helios64/img/install/putty-connect.png) + +3. Setup serial port settings (Serial line : **COM3** and Speed : **1500000**), then press **'Open'**
+![Putty config](/helios64/img/install/putty-connect2.png) + +!!! note + The serial port detection may vary on different system, please make sure to check the device manager to get the information of correct serial port to connect to Helios64. 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 Terminal) + +**1.** Install picocom + +Use apt-get under Debian/Ubuntu + + $ sudo apt-get install picocom + +Use yum under RHEL / CentOS / Fedora Linux + + $ sudo yum install picocom + +**2.** Connect to serial with picocom + + $ sudo picocom -b 1500000 /dev/ttyUSB0 + +![Picocom](/helios64/img/install/picocom.png) + +To exit picocom do **Ctrl-a** then **q** button in squence + +!!! note + Using command _ls -la /dev/ttyUSB*_ you should be able the find the USB to serial bridge device used by Helios64. Under Linux the device will be named **/dev/ttyUSBx**, where **x** is a digit. + + +### Under Mac OS (via Terminal) + +Connect serial using the *screen* command + + $ screen /dev/tty.usbserial-XXXXXXXX 1500000 -L + +To exit the session do **Ctrl-a** then **Ctrl-k** + +!!! note + Using command _ls -la /dev/tty.usb*_ you should be able the find the USB to serial bridge device used by Helios64. Under Mac OS the device will be named **/dev/tty.usbserial-xxxxxxxx**, where **xxxxxxxx** is some serial number. + +## **Step 5** - Log in + +!!! note + You might need to press **Enter** for the login prompt to come up. + +**Default credential for Debian or Ubuntu image** + +```bash +helios64 login: root +Password: 1234 +``` + +You will be prompted to change the root password and then create a new user account. + +![First Login](/helios64/img/install/first-boot-userpass.png) + +## **Step 6** - Check/Set IP address + +### Check IP address + +By default Helios64 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 +ip addr show dev eth0 +``` + +![Network Config](/helios64/img/install/ifconfig.png) + +Here the IP address of Helios64 is **10.10.10.73**. + +### Set IP address + +If you wish to manually configure your IP address you can use the **armbian-config** tool. + +```bash +armbian-config +``` + +Select the *Network* section: + +![Armbian-config](/helios64/img/install/armbian-config.png) + +Select the ethernet you want to assign IP Address to, in this case we select eth0 for the first Ethernet: + +![Armbian-config](/helios64/img/install/armbian-config-eth-select.png) + +Navigate to *IP* to configure your IPv4 address: + +![Armbian-config](/helios64/img/install/armbian-config-network.png) + +Select *Static*: + +![Armbian-config](/helios64/img/install/armbian-config-ip-static.png) + +Provide the IP Address, Netmask, and Gateway information that you want to assign: + +![Armbian-config](/helios64/img/install/armbian-config-ip-set.png) + +Press **ESC** till you exit armbian-config tool. + +You will have to reboot for the network settings to take effect. +```bash +sudo reboot +``` + +!!! info + You can also refer to the following Debian Wiki [Page](https://wiki.debian.org/NetworkConfiguration#Setting_up_an_Ethernet_Interface) for advanced network settings. + +## **Step 7** - Connect to Helios64 via SSH + +You can now connect by SSH to your Helios64 to carry on with your configuration. + +Here is the example when we use linux client: + +![SSH Login](/helios64/img/install/ssh_login.png) + +You can use putty as the SSH client if you are using windows: + +![Putty SSH](/helios64/img/install/putty_ssh.png) + +## **What to do next ?** + +You can use **armbian-config** which provides an easy way to install 3rd party applications like *OpenMediaVault*, *NextCloud*, *Syncthing*, *Emby* and many more. + +Here an example on how to install software OpenMediaVault (OMV) using the armbian-config. + +```bash +sudo armbian-config +``` + +Select *Software* section: + +![!armbian-config Main Menu](/helios64/img/omv/install-1.png) + +Navigate to *Softy*: + +![!armbian-config Software](/helios64/img/omv/install-2.png) + +Then choose *OMV*, to install the OpenMediaVault: + +![!armbian-config Selection](/helios64/img/omv/install-3.png) + +Wait the install process to complete: + +![!armbian-config Selection](/helios64/img/omv/install-4.png) diff --git a/docs/helios64/kit.md b/docs/helios64/kit.md index 7dbf79c..a7499f1 100644 --- a/docs/helios64/kit.md +++ b/docs/helios64/kit.md @@ -266,3 +266,5 @@ The Enclosure Kit has been specially designed for the Helios64 board. The follow > **Helios64 Enclosure Kit Assembly Completed !** ![!Kit Assembly](/helios64/img/kit/assembly_pic44.png) + +**Now you can jump to the [install section](/helios64/install/).** diff --git a/mkdocs.yml b/mkdocs.yml index 0d32158..f026cc7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -78,6 +78,7 @@ nav: - Introduction: 'helios64/intro.md' - Kit Assembly: 'helios64/kit.md' - Download: '/download/#helios64' + - Install: 'helios64/install.md' - Hardware: - Overview: 'helios64/hardware.md' - Button: 'helios64/button.md'