From ed5cf22fa2af003fd89d8651f410d5b0e036dd54 Mon Sep 17 00:00:00 2001 From: Werner Date: Sat, 21 Mar 2020 18:07:52 +0100 Subject: [PATCH] Mostly cosmetics (#65) * Mostly cosmetics - Added H6 to supported chips. I have no clue about the other SoC families if there were changes. - Removed a few oldstyle HTML codes @lanefu * More cosmetics * Cosmetics * Cosmectics Remove outdated hint for Jessie The "how to unbrick" section needs a complete rework since the package names and so on meanwhile changed again. Same for overlayfs Same for docker * Update User-Guide_Advanced-Features.md --- docs/Quick_facts.md | 36 +++++++-------- docs/User-Guide_Advanced-Features.md | 22 ++++----- docs/User-Guide_Getting-Started.md | 32 ++++++------- docs/index.md | 68 ++++++++++++++-------------- 4 files changed, 78 insertions(+), 80 deletions(-) diff --git a/docs/Quick_facts.md b/docs/Quick_facts.md index f844f21b..e5fd5a42 100644 --- a/docs/Quick_facts.md +++ b/docs/Quick_facts.md @@ -1,51 +1,51 @@ # What is Armbian Linux? # -Armbian Linux provides optimized Debian and Ubuntu Linux images for ARM-based SBCs. There's an incredible ecosystem of small computing platforms that are powerful alternatives to the Raspberry Pi. Armbian's mission is to provide a uniform system offering that is trustworthy to run on any of the dozens of OS-neglected ARM SBCs. +Armbian Linux provides optimized Debian and Ubuntu Linux images for ARM-based SBCs. There is an incredible ecosystem of small computing platforms that are powerful alternatives to the Raspberry Pi. Armbian's mission is to provide a uniform system offering that is trustworthy to run on any of the dozens of OS-neglected ARM single board computers. # Challenges -## Armbian is the opposite of Raspbian +### Armbian is the opposite of Raspbian -Raspbian has dozens of contributors to focus on a single SBC platform. Armbian has a dozen contributors to focus on 100+ SBCs in over 30 platforms. +Raspbian has dozens of contributors to focus on a single SBC platform. Armbian has a dozen contributors to focus on 100+ SBCs spread over 30 platforms. -## Balancing Development and Support +### Balancing Development and Support -Given the point above, resources are thin. Armbian developers have to focus on the core mission of maintaining the [Armbian Build Platform](https://github.com/armbian/build). We heavily rely on other members of the community to support each other. Although Armbian does provide a lot of [user friendly features](https://github.com/armbian/config), the reality is that Armbian is for more advanced users. If you're really struggling with your SBC, you may want to consider first getting more comfortable with Raspbian Linux on the Raspberry Pi. +Given the point above, resources are thin. Armbian developers have to focus on the core mission of maintaining the [Armbian Build Platform](https://github.com/armbian/build). We heavily rely on other members of the community to support each other. Although Armbian does provide a lot of [user friendly features](https://github.com/armbian/config), the reality is that Armbian is for more advanced users. If you are really struggling with your SBC, you may want to consider first getting more comfortable with Raspbian Linux on the Raspberry Pi. -## More SBCs Continuously Coming to Market +## More SBCs continuously coming to market -SBC and TV Box manufacturers love to design and ship new products. Unfortunately they do not like to spend time on software and instead rely on community projects such as Armbian to fill in the gaps. +SBC and TV Box manufacturers love to design and ship new products. Unfortunately they do not like to spend time on software and instead rely on community projects such as Armbian to fill in the gaps. # Benefits -## Simple +### Simple BASH shell, standard Debian/Ubuntu utilities. Common and specific features can be with minimalistic menu-driven utility. Login is possible via serial, HDMI/VGA or SSH. -## Light +### Light No bloatware or spyware. Special utilities are completely optional. Suitable for newcomers and professionals. -## Optimized +### Optimized -A distributed image is compacted to real data size and starts at around 1G. Size is optimized for SD card usage. Bigger is better. Installing applications later severely reduces the life of your SD card. They were not designed for this type of usage. +A distributed image is compacted to real data size and starts at around of 1G. Size is optimized for SD card usage. Bigger is better. Installing applications later severely reduces the life of your SD card. They were not designed for this type of usage. -## Fast +### Fast Boards are optimized on kernel and userspace level. DVFS optimization, memory log caching, browser profile memory caching, swap usage tuning, garbage commit delay. Our system runs almost read-only and is one of the the fastest Linux for many development boards in just about every case. -## Secure +### Secure -Security level is on a stock Debian level and can be hardened with the configuration utility. It provides a good starting point for industrial or home usage. The system is regularly inspected by professionals within a community. Each official stable build is thoroughly tested. Images are a direct base for all 3rd party builders. +Security level is on a stock Debian/Ubuntu level and can be hardened with the configuration utility. It provides a good starting point for industrial or home usage. The system is regularly inspected by professionals within the community. Each official stable build is thoroughly tested. Images are a direct base for all 3rd party builders. -## Supported +### Supported Providing long term updates, security fixes, documentation, user support. -## Smart +### Smart Deep understanding how boards work, how operating system work and how hardware should be designed to run better. Involved in board design. Experience in Linux since early 90'. Specialized in ARM development boards since 2013. -## Open +### Open -Opensource build script and kernel development, maintenance and distribution for more than [30 different ARM and ARM64 Linux kernels](https://www.armbian.com/kernel). Powerful build and software development tools. Can run in fully parallel mode. Can run under Docker. +Open source build script and kernel development, maintenance and distribution for more than [30 different ARM and ARM64 Linux kernels](https://www.armbian.com/kernel). Powerful build and software development tools. Can run in fully parallel mode. Can run under Docker. diff --git a/docs/User-Guide_Advanced-Features.md b/docs/User-Guide_Advanced-Features.md index 63366bec..a361727e 100644 --- a/docs/User-Guide_Advanced-Features.md +++ b/docs/User-Guide_Advanced-Features.md @@ -1,10 +1,10 @@ -# How to switch kernels? +### How to switch kernels? -Check [this for](http://www.armbian.com/kernel/) more info. +Check [_this_](http://www.armbian.com/kernel/) for more info. -# How to troubleshoot? +### How to troubleshoot? -**Important: If you came here since you can't get Armbian running on your board please keep in mind that in 95 percent of all cases it's either a faulty/fraud/counterfeit SD card or an insufficient power supply that's causing these sorts of _doesn't work_ issues!** +**Important: If you came here since you cannot get Armbian running on your board please keep in mind that in 95 percent of all cases it is either a faulty/fraud/counterfeit SD card or an insufficient power supply that is causing these sorts of _does not work_ issues!** If you broke the system you can try to get in this way. You have to get to u-boot command prompt, using either a serial adapter or monitor and usb keyboard (USB support in u-boot currently not enabled on all H3 boards). @@ -33,11 +33,9 @@ System should eventually boot to bash shell: Now you can try to fix your broken system. -- [Fix a Jessie systemd problem due to upgrade from 3.4 to 4.x](https://github.com/igorpecovnik/lib/issues/111) +### How to unbrick the system? (outdated) -# How to unbrick the system? - -When something goes terribly wrong and you are not able to boot the system, this is the way to proceed. You need some linux machine, where you can mount the failed SD card. With this procedure you will reinstall the u-boot, kernel and hardware settings. In most cases this should be enough to unbrick the board. It's recommended to issue a filesystem check before mounting: +When something goes terribly wrong and you are not able to boot the system, this is the way to proceed. You need some Linux machine where you can mount the failed SD card. With this procedure you will reinstall the u-boot, kernel and hardware settings. In most cases this should be enough to unbrick the board. It is recommended to issue a filesystem check before mounting: fsck /dev/sdX -f @@ -66,7 +64,7 @@ If you upgrade from some very old build, you might need to update your boot scri Unmount SD card, move it to the board and power on. -# How to build a wireless driver? +### How to build a wireless driver? Install and recreate kernel headers scripts (optional) @@ -109,7 +107,7 @@ Check which wireless stations / routers are in range iwlist wlan0 scan | grep ESSID -# How to freeze your filesystem? +#### How to freeze your filesystem? (outdated) In certain situations it is desirable to have a virtual read-only root filesystem. This prevents any changes from occurring on the root filesystem that may alter system behavior and it allows a simple reboot to restore a system to its clean state. @@ -125,7 +123,7 @@ After your system boots up it will always remain as is. If you want to make any Changes inside this will be preserved. -# How to run Docker? +### How to run Docker? (outdated) Preinstallation requirements: @@ -147,7 +145,7 @@ Test if Docker works correctly: # How to set wireless access point? -There are two different hostap daemons. One is **default** and the other one is for some **Realtek** wifi cards. Both have their own basic configurations and both are patched to gain maximum performances. +There are two different HostAP daemons. One is **default** and the other one is for some **Realtek** wifi cards. Both have their own basic configurations and both are patched to gain maximum performances. Sources: [https://github.com/igorpecovnik/hostapd](https://github.com/igorpecovnik/hostapd "https://github.com/igorpecovnik/hostapd") diff --git a/docs/User-Guide_Getting-Started.md b/docs/User-Guide_Getting-Started.md index 0decfe49..4b030084 100644 --- a/docs/User-Guide_Getting-Started.md +++ b/docs/User-Guide_Getting-Started.md @@ -5,7 +5,7 @@ Please, make sure you have: - 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? +### What to download? For each board we usually provide: @@ -16,18 +16,18 @@ Other builds (like Debian Stretch/Bullseye Ubuntu Disco/Eoan) are experimental a Some boards have different options due to their hardware specialities - router or IoT boards. -# Legacy or current? +### 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. -# What are testing images? +### What are testing images? - made from stable branches - not very well tested - for end users -# What are experimental/dev images? +### What are experimental/dev images? - made from unstable branches - unstested @@ -35,7 +35,7 @@ On the bottom line it depends on the board family. If in your specific case some Do not use them in a productive environment but your constructive [feedback to developers](https://forum.armbian.com/forum/4-development/) is highly appreciated. -# How to check download authenticity? +### 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): @@ -53,7 +53,7 @@ All our images are digitally signed and therefore it is possible to check their It is safe to ignore the message `WARNING: This key is not certified with a trusted signature!`. -# How to check download integrity? +### 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 @@ -61,7 +61,7 @@ Since it might happen that your download got somehow corrupted we integrate a ch Armbian_5.35_Clearfogpro_Debian_stretch_next_4.13.16.img: OK ^C -# How to prepare a SD card? +### 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**. @@ -80,11 +80,11 @@ At the time of this writing A1 and A2 cards are only widely available from SanDi 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/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? +### How to boot? Insert SD card into a slot and power the board. (First) boot (with DHCP) takes up to two minutes with a class 10 SD card and cheapest board. -# How to login? +### How to login? 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. @@ -98,7 +98,7 @@ Desktop images start into desktop without asking for password. To change this ad and change the autologin user. -# How to update? +### How to update? apt update apt upgrade @@ -107,17 +107,17 @@ and change the autologin user. If the kernel was upgraded during this process you will be prompted to reboot at next login. -# How to update u-boot? +### How to update u-boot? First you need to update packages described in a previous "How to update" step. Then run armbian-config utility, go to system settings and proceed to: **"Install" "Install to/update boot loader"** -> **Install/Update the bootloader on SD/eMMC** -# How to adjust hardware features? +### How to adjust hardware features? -[Use Armbian configuration utility](User-Guide_Armbian-Config.md). +[Use the Armbian configuration utility `armbian-config`](User-Guide_Armbian-Config.md) -# How to install to eMMC, NAND, SATA & USB? +### How to install to eMMC, NAND, SATA & USB? ![Installer](https://www.armbian.com/wp-content/uploads/2016/12/nandsata.png) @@ -151,7 +151,7 @@ and you can choose the following file system options: 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](https://forum.armbian.com/topic/1702-orange-pi-plus-2e-where-is-16ghz-and-sd/?p=13163) for details). -# How to connect to wireless? +### How to connect to wireless? Required condition: a board with onboard or supported 3rd party wireless adapter on USB @@ -167,7 +167,7 @@ If you do not know, you can browse and then connect ![](https://www.armbian.com/wp-content/uploads/2016/12/wifi-2.png) -# How to set fixed IP? +### 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**: diff --git a/docs/index.md b/docs/index.md index 2402da22..032d30e4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,70 +2,70 @@ Linux for ARM development boards -

Welcome to the Armbian Documentation!

+# Welcome to the Armbian Documentation! -If you're **new to Armbian**, the [Getting Started](User-Guide_Getting-Started.md) section +If you are **new to Armbian**, the [_Getting Started_](User-Guide_Getting-Started.md) section provides a tutorial for everything you need to get Armbian running, -and answers many Frequently Asked Questions. +and answers many **F**requently **A**sked **Q**uestions. It then continues on to more advanced topics. -If you **need help**, and have read through Getting Started, check out [Troubleshooting](User-Guide_Advanced-Features.md#how-to-troubleshoot). +If you **need help**, and have read through _Getting Started_, check out [_Troubleshooting_](User-Guide_Advanced-Features.md#how-to-troubleshoot). -If you still can't find what you need here, visit the [Armbian forum](http://forum.armbian.com/), where your input can help improve this documentation. +If you still cannot find what you need here, visit the [_Armbian forum_](http://forum.armbian.com/), where your input can help improve this documentation. -# What is Armbian? # +# What is Armbian? -*Armbian is a base operating system platform for single board computers that other projects can trust to build upon.* +*Armbian is a base operating system platform for single board computers (SBCs) that other projects can trust to build upon.* -- Lightweight Debian or Ubuntu based linux distribution specialized for ARM development boards. -- Each system is compiled, assembled and optimized by [Armbian Build Tools](https://github.com/armbian/build) -- It has powerful build and software development tools to make [custom builds](Developer-Guide_Build-Preparation.md) -- A vibrant community. +- Lightweight Debian or Ubuntu based linux distribution specialized for ARM development boards +- Each system is compiled, assembled and optimized by [_Armbian Build Tools_](https://github.com/armbian/build) +- It has powerful build and software development tools to make [_custom builds_](Developer-Guide_Build-Preparation.md) +- A vibrant community -**Common features** +### Common features -- Armbian Linux is availble as Debian and Ubuntu based images. Compiled from scratch, -- Install images are reduced to actual data size and resized at first boot, -- Root password is `1234`. You are forced to change this password and create a normal user at first login, +- Armbian Linux is availble as Debian and Ubuntu based images, compiled from scratch +- Images are reduced to actual data size and automatically resized at first boot +- Root password is `1234`. You are forced to change this password and (optional) create a normal user at first login - Ethernet adapter with DHCP and SSH server ready on default port (22) -- Wireless adapter with DHCP ready if present but disabled. You can use armbian-config to connect to your router or create AP -- NAND, SATA, eMMC and USB install script is included (nand-sata-install) -- Upgrades are done via standard apt-get upgrade method -- Login script shows: board name with large text, distribution base, kernel version, system load, up time, memory usage, IP address, CPU temp, drive temp, ambient temp from Temper if exits, SD card usage, battery conditions and number of updates to install. +- Wireless adapter with DHCP ready (if present) but disabled. You can use `armbian-config` to connect to your router or create an AP +- NAND, SATA, eMMC and USB install script is included (`nand-sata-install`) +- Upgrades are done via standard `apt upgrade` method +- Login script shows: board name with large text, distribution base, kernel version, system load, uptime, memory usage, IP address, CPU and drive temperature, ambient temperature from Temper if exits, SD card usage, battery conditions and number of updates to install -**Performance tweaks** +### Performance tweaks -- /var/log is mounted as compressed device (zram, lzo), log2ram service saves logs to disk daily and on shutdown -- half of memory is alocatted/extended for/with compressed swap -- /tmp is mounted as tmpfs (optional compressed) -- browser profile memory caching -- optimized IO scheduler. (check /etc/init.d/armhwinfo) -- journal data writeback enabled. (/etc/fstab) -- commit=600 to flush data to the disk every 10 minutes (/etc/fstab) -- optimized CPU frequency scaling with interactive governor (/etc/init.d/cpufrequtils) +- `/var/log` is mounted as compressed device (zram, lzo), log2ram service saves logs to disk daily and on shutdown +- Half of memory is allocated/extended for/with compressed swap +- `/tmp` is mounted as `tmpfs` (optionally compressed) +- Browser profile memory caching +- Optimized IO scheduler (check `/etc/init.d/armhwinfo`) +- Journal data writeback enabled. (`/etc/fstab`) +- `commit=600` to flush data to the disk every 10 minutes (`/etc/fstab`) +- Optimized CPU frequency scaling with `interactive` governor (`/etc/init.d/cpufrequtils`) - 480-1010Mhz @Allwinner A10/A20 - 480-1260Mhz @Allwinner H3 - 392-996Mhz @Freescale imx - 600-2000Mhz @Exynos & S905 - eth0 interrupts are using dedicated core (Allwinner based boards) -# What is Supported? # +# What is supported? -"Supported" is not a guarantee. "Supported" implies a particular SBC is at a high level of software maturity, but has no intention to support all possible SBC functions. Supported Board do receive preferential treatment to bugfix, improve, or add additional functionality based on any of the following, **non-exclusive** criteria: +"Supported" is not a guarantee. "Supported" implies a particular SBC is at a high level of software maturity, but has no intention to support all possible SBC functions. Supported boards do receive preferential treatment to bugfix, improve, or add additional functionality based on any of the following, **non-exclusive** criteria: 1. The discretion of the "Armbian Development Team" 1. The availability of the "Armbian Development Team" 1. The availability of sample boards and ease of testing 1. The mainline kernel maturity for the particular SoC or SBC platform 1. Paid engagements, long-term sponsorship to the Armbian Project or volunteer developers -1. Vendor or 3rd party has a **designated** resource providing support for a SBC or platform ON BEHALF OF THE COMMUNITY and is contributing to the project. +1. Vendor or 3rd party has a **designated** resource providing support for a SBC or platform ON BEHALF OF THE COMMUNITY and is contributing to the project -## Supported chips +### Supported chips -- Allwinner A10, A20, A31, H2+, H3, H5, A64 +- Allwinner A10, A20, A31, H2+, H3, H5, H6, A64 - Amlogic S805 and S905 (Odroid boards), S802/S812, S805, S905, S905X and S912 (fork by `@balbes150`) - Actionsemi S500 - Freescale / NXP iMx6 @@ -73,7 +73,7 @@ If you still can't find what you need here, visit the [Armbian forum](http://for - Rockchip RK3288 - Samsung Exynos 5422 -## Supported boards +### Supported boards Check [download page](http://www.armbian.com/download/) for recently supported list. # Get Involved! #