Files
documentation/docs/User-Guide_Getting-Started.md

185 lines
9.1 KiB
Markdown
Raw Normal View History

2016-12-22 10:51:32 +01:00
# Prerequisites for new users
Please, make sure you have:
2016-12-22 10:51:32 +01:00
- a proper power supply according to the board manufacturer requirements (basic usage example: 5V/2A with DC Jack barrel OR thick USB cable)
- a reliable SD card (see below "How to prepare a SD card?")
# What to download?
For each board we usually provide:
2016-12-22 10:51:32 +01:00
- one CLI Debian **and** one CLI Ubuntu based server image,
- one desktop Ubuntu Xenial **or** Debian Stretch
Some boards have different options due to their hardware specialities - router or IoT boards.
2016-12-22 10:51:32 +01:00
# Legacy or mainline?
Both kernels, where exists, are stable and production ready, but you should use them for different purpuses since their basic support differs:
2017-10-11 13:43:52 +02:00
**legacy**: video acceleration, NAND support, connecting displays
**mainline**: headless server, light desktop operations
2017-10-11 13:43:52 +02:00
# What are testing images?
- made from stable branches
- not very well tested
- for end users
2017-05-20 10:08:51 +02:00
# What are experimental images?
- made from unstable branches,
- unstested,
- for experienced users only.
Dont use them for anything productive but to give constructive [feedback to developers](https://forum.armbian.com/index.php?/forum/4-development/).
# How to check download authenticity?
All our images are digitally signed and therefore it's possible to check their authenticity. You need to unzip the download package and issue those commands (Linux/macOS, you might need to install dependencies first, eg. `apt-get install gnupg p7zip` on Debian/Ubuntu or `brew install gnupg p7zip` on macOS):
# download public key from the database
gpg --keyserver pgp.mit.edu --recv-key DF00FAF1C577104B50BF1D0093D6889F9F0E78D5
2016-09-15 00:11:31 +02:00
gpg --verify Armbian_5.18_Armada_Debian_jessie_3.10.94.img.asc
2017-10-11 13:43:52 +02:00
# proper response
gpg: Signature made sob 09 jan 2016 15:01:03 CET using RSA key ID 9F0E78D5
2017-10-11 13:43:52 +02:00
gpg: Good signature from "Igor Pecovnik (Ljubljana, Slovenia) <igor.++++++++++++@gmail.com>"
# wrong reponse. Not genuine Armbian image!
gpg: Signature made Sun 03 Jan 2016 11:46:25 AM CET using RSA key ID 9F0E78D5
gpg: BAD signature from "Igor Pecovnik (Ljubljana, Slovenia) <igor.++++++++++++@gmail.com>"
It is safe to ignore the message `WARNING: This key is not certified with a trusted signature!`.
# How to check download integrity?
Since it might happen that your download got somehow corrupted we integrate a checksum/hash for the image. After uncompressing the download you can compare the image's SHA-256 hash with the one contained in the `sha256sum.sha` file. On Windows you can use [7-Zip's built-in hash functionality](https://superuser.com/a/1024913) to display the SHA256 hash while on Linux/macOS you would do this
shasum -a 256 -c sha256sum.sha Armbian_*.img
Armbian_5.35_Clearfogpro_Debian_stretch_next_4.13.16.img: OK
^C
# How to prepare a SD card?
2017-11-11 12:24:15 +01:00
**Important note:** Make sure you use a **good, reliable and fast** SD card. If you encounter boot or stability troubles in over 95 percent of the time it's either insufficient power supply or related to SD card (bad card, bad card reader, something went wrong when burning the image, card too slow to boot -- 'Class 10' highly recommended!). Armbian can simply not run on unreliable hardware so checking your SD card with either [F3](http://oss.digirati.com.br/f3/) or [H2testw](http://www.heise.de/download/h2testw.html) is mandatory if you run in problems. Since [counterfeit SD cards](http://www.happybison.com/reviews/how-to-check-and-spot-fake-micro-sd-card-8/) are still an issue checking with F3/H2testw directly after purchase is **highly recommended**.
7z and zip archives can be uncompressed with [7-Zip](http://www.7-zip.org/) on Windows, [Keka](http://www.kekaosx.com/en/) on OS X and 7z on Linux. Images shall only be written with [Etcher](https://www.etcher.io) on all platforms since unlike other tools Etcher validates burning results **saving you from corrupted SD card contents**.
Also important: Most SD cards are only optimised for sequential reads/writes as it's common with digital cameras. This is what the *speed class* is about. The SD Association defined [*Application Performance Class*](https://www.sdcard.org/developers/overview/application/index.html) as a standard for random IO performance.
|Application Performance Class|Pictograph|Miniumum Random Read|Minimum Random Write|Minimum Sustained (Seq. Write)|
|---|---|---|---|---|
|Class 1 (A1)|![a1-logo](https://raw.githubusercontent.com/armbian/documentation/master/docs/images/a1-logo.png)|1500 4k IOPS|500 4k IOPS|10MBytes/sec|
|Class 2 (A2)|![a2-logo](https://raw.githubusercontent.com/armbian/documentation/master/docs/images/a2-logo.png)|4000 4k IOPS|2000 4k IOPS|10MBytes/sec|
2018-10-15 14:53:30 +02:00
At the time of this writing A1 and A2 cards are only widely available from SanDisk. Armbian **only** recommends A1 rated SD-Cards now ([A2 rated cards need yet lacking driver support and therefore show lower overall and especially random IO performance](https://github.com/ThomasKaiser/Knowledge/blob/master/articles/A1_and_A2_rated_SD_cards.md)). For example:
![a1-16gb-card](https://raw.githubusercontent.com/armbian/documentation/master/docs/images/sandisk-ultra-a1.png) ![a1-32gb-card](https://raw.githubusercontent.com/armbian/documentation/master/docs/images/sandisk-extremepro-a1.png) ![a2-64gb-card](https://raw.githubusercontent.com/armbian/documentation/master/docs/images/sandisk-extreme-a2.png)
In case you chose an SD card that was already in use before please consider resetting it back to 'factory default' performance with [SD Formatter](https://www.sdcard.org/downloads/formatter_4/) before burning Armbian to it ([explanation in the forum](https://forum.armbian.com/index.php?/topic/3776-the-partition-is-not-resized-to-full-sd-card-size/&do=findComment&comment=27413)). Detailed information regarding ['factory default' SD card performance](https://forum.armbian.com/topic/954-sd-card-performance/?page=3&tab=comments#comment-49811).
# How to boot?
2017-05-20 10:08:51 +02:00
Insert SD card into a slot and power the board. (First) boot (with DHCP) takes up to 35 seconds with a class 10 SD Card and cheapest board.
2017-10-11 13:43:52 +02:00
# How to login?
2017-08-23 17:29:58 +02:00
Login as **root** on console (HDMI / serial) or via SSH and use password **1234**. You will be prompted to change this password at first login. You will then be asked to create a normal user account that is sudo enabled (beware of default QWERTY keyboard settings at this stage). Please use [this tool](http://angryip.org/), to find your board IP address.
Desktop images start into desktop without asking for password. To change this add some display manager:
apt-get install lightdm
... or edit the contents of file:
/etc/default/nodm
and change the autologin user.
# How to update?
2016-09-20 13:13:57 +02:00
apt-get update
apt-get upgrade
2016-07-05 07:37:31 +02:00
**Update process can take hours in case of using cheap SD card and/or under heavy load.**
If the kernel was upgraded during this process you will be prompted to reboot at next login.
2017-10-11 13:43:52 +02:00
# How to adjust hardware features?
[Use Armbian configuration utility](User-Guide_Armbian-Config.md).
# How to install to eMMC, NAND, SATA & USB?
![Installer](https://www.armbian.com/wp-content/uploads/2016/12/nandsata.png)
Required condition:
NAND:
* kernel 3.4.x and NAND storage
* pre-installed system on NAND (stock Android or other Linux)
eMMC/SATA/USB:
* any kernel
2017-05-20 10:08:51 +02:00
* onboard eMMC storage
* attached SATA or USB storage
2017-10-11 13:43:52 +02:00
Start the install script:
nand-sata-install
and follow the guide. You can create up to three scenarios:
* boot from SD, system on SATA / USB
* boot from eMMC / NAND, system on eMMC/NAND
* boot from eMMC / NAND, system on SATA / USB
2016-12-21 16:39:56 +01:00
and you can choose the following file system options:
* ext2,3,4
* btrfs
2017-10-11 13:43:52 +02:00
On Allwinner devices after switching to boot from NAND or eMMC clearing the boot loader signature on the SD card is recommended: `dd if=/dev/zero of=/dev/mmcblkN bs=1024 seek=8 count=1` (replace `/dev/mmcblkN` with the correct device node -- in case you run this directly after `nand-sata-install` without a reboot in between then it's `/dev/mmcblk0`). When booting from eMMC to get SD cards auto-detected on Allwinner legacy images please consider changing `mmc0`'s `sdc_detmode` from 3 to 1 in the board's fex file (see [here](http://forum.armbian.com/index.php/topic/1702-orange-pi-plus-2e-where-is-16ghz-and-sd/?p=13163) for details).
# How to connect to wireless?
2016-12-22 10:51:32 +01:00
Required condition: a board with onboard or supported 3rd party wireless adapter on USB
If you know what is your wireless SSID:
nmtui-connect SSID
![](https://www.armbian.com/wp-content/uploads/2016/12/wifi-1.png)
If you don't know, you can browse and then connect
nmtui-connect
![](https://www.armbian.com/wp-content/uploads/2016/12/wifi-2.png)
# How to set fixed IP?
By default your main network adapter's IP is assigned by your router DHCP server and all network interfaces are managed by **NetworkManager**:
user@boardname:~$ nmcli con show
NAME UUID TYPE DEVICE
Wired connection 1 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx 802-3-ethernet eth0
2017-10-11 13:43:52 +02:00
The conncetion can now be edited with the following:
nmcli con mod "Wired connection 1"
ipv4.addresses "HOST_IP_ADDRESS"
ipv4.gateway "IP_GATEWAY"
ipv4.dns "DNS_SERVER(S)"
ipv4.dns-search "DOMAIN_NAME"
ipv4.method "manual"
The same changes can also be done with NetworkManagers text user interface:
sudo nmtui