diff --git a/docs/User-Guide_Getting-Started-Download-Page.md b/docs/User-Guide_Getting-Started-Download-Page.md index f9d79511..94d4e90d 100644 --- a/docs/User-Guide_Getting-Started-Download-Page.md +++ b/docs/User-Guide_Getting-Started-Download-Page.md @@ -1,6 +1,6 @@ **Preparation** -Make sure you have a **good & reliable** SD card and a **proper power supply**. 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 (apt-get install p7zip-full). RAW images should be written with an approved imaging tool capable of validating the burn. +Make sure you have a **good & reliable** SD card and a **proper power supply**. The XZ-compressed should be written with an approved imaging tool capable of validating the burn. **Approved Imaging Tools** diff --git a/docs/User-Guide_Getting-Started.md b/docs/User-Guide_Getting-Started.md index 4b030084..4a80e9ba 100644 --- a/docs/User-Guide_Getting-Started.md +++ b/docs/User-Guide_Getting-Started.md @@ -7,19 +7,22 @@ Please, make sure you have: ### What to download? +The download for each image consists of three separate files: An **xz-compressed image file**, a **sha file** for download verification and an **asc file** for image authentication. + For each board we usually provide: - one CLI Debian **and** one CLI Ubuntu based server image, - one desktop Ubuntu Bionic **or** Debian Buster -Other builds (like Debian Stretch/Bullseye Ubuntu Disco/Eoan) are experimental and are unsupported. +Other unsupported builds may also be available(like Debian Stretch/Bullseye Ubuntu Disco/Eoan). Some boards have different options due to their hardware specialities - router or IoT boards. ### Legacy or current? Only _current_ kernel branch is considered fully supported and can bring up video acceleration for example. NAND support is there but is still experimental. -On the bottom line it depends on the board family. If in your specific case something does not work well you are always free to try an image with _legacy_ kernel included. + +The level of kernel support does depend on the board family. If in your specific case something does not work well, you are always free to try an image with _legacy_ kernel included. ### What are testing images? @@ -33,15 +36,17 @@ On the bottom line it depends on the board family. If in your specific case some - unstested - for experienced users only -Do not use them in a productive environment but your constructive [feedback to developers](https://forum.armbian.com/forum/4-development/) is highly appreciated. +Do not use testing or dev images in a productive environment. We do appreciate your constructive [feedback to developers](https://forum.armbian.com/forum/4-development/). ### How to check download authenticity? -All our images are digitally signed and therefore it is 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): +All our images are digitally signed and therefore it is possible to check their authenticity. You need to issue these commands (Linux/macOS, you might need to install dependencies first, eg. `apt-get install gnupg ` on Debian/Ubuntu or `brew install gnupg ` on macOS. on windows install the current simple gnupg [Gnupg](https://gnupg.org/download/): # download public key from the database gpg --keyserver ha.pool.sks-keyservers.net --recv-key DF00FAF1C577104B50BF1D0093D6889F9F0E78D5 - gpg --verify Armbian_5.18_Armada_Debian_jessie_3.10.94.img.asc + + # perform verification + gpg --verify Armbian_5.18_Armada_Debian_jessie_3.10.94.img.xz.asc # proper response gpg: Signature made sob 09 jan 2016 15:01:03 CET using RSA key ID 9F0E78D5 @@ -55,17 +60,23 @@ It is safe to ignore the message `WARNING: This key is not certified with a trus ### 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 +Since it might happen that your download got somehow corrupted we integrate a checksum/hash for the image. You can compare the image's SHA-256 hash with the one contained in the `sha256sum.sha` file. - shasum -a 256 -c Armbian_*.img.sha Armbian_*.img +On Windows, you can download and use the [QuickHash GUI](https://quickhash-gui.org/download/quickhash-v3-1-0-windows/) and follow the instructions in the gui. + + +while on Linux/macOS, in the directory in which you have downloaded the files ,you would do this + + shasum -a 256 -c Armbian_*.img.sha Armbian_*.img.xz + #good response Armbian_5.35_Clearfogpro_Debian_stretch_next_4.13.16.img: OK - ^C + ### How to prepare a SD card? **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 is 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**. +Write the xz compressed image with [USBImager](https://gitlab.com/bztsrc/usbimager) or [Etcher](https://balena.io/etcher) on all platforms since unlike other tools, either can validate burning results **saving you from corrupted SD card contents**. Also important: Most SD cards are only optimised for sequential reads/writes as it is 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.