Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
dde6c9f
Start restructuring content and add preface
dleidert Jan 24, 2025
3f62bce
Update introduction
dleidert Jan 24, 2025
582afd9
Typo fix
dleidert Jan 24, 2025
e9ea4ca
Typo fix
dleidert Mar 19, 2025
a04a493
Rephrase the support status section
dleidert Mar 19, 2025
1ae4093
Move changelog and release model to appendix
dleidert Mar 19, 2025
e15a0c3
Rename section
dleidert Mar 19, 2025
ceb2e02
Rephrase the introduction to the getting started section
dleidert Mar 19, 2025
2bf78d1
Rewrite the image download section
dleidert Mar 19, 2025
7ff7c60
Change back to lowercase headings
dleidert Mar 19, 2025
5b59bdf
Rephrase the deploying image part
dleidert Mar 19, 2025
4ac5977
Minor updates to the first boot/login/installation
dleidert Mar 19, 2025
eb76eb0
Move installation and hardware tuning into a First steps section
dleidert Mar 19, 2025
f09abd6
Move firmware freeze and upgrade into Update section and create a Tro…
dleidert Mar 19, 2025
e81bfd2
Move the preface into the introduction
dleidert Mar 19, 2025
08d2f4d
Subtitle
dleidert Mar 19, 2025
d7ba7fe
Structuring
dleidert Mar 19, 2025
052dacc
Simple structure defition
dleidert Mar 19, 2025
280f9b8
Merge recovery into the troubleshooting section
dleidert Mar 19, 2025
2f1c531
Add a hint to armbian-config for first configuration
dleidert Mar 19, 2025
f8f0c59
Merge remote-tracking branch 'armbian/main'
dleidert Mar 21, 2025
4502239
Re-read the getting started section
dleidert Apr 7, 2025
2fee023
Move remaining pages into Advanced section
dleidert Apr 7, 2025
b8da932
Disable devicetree overlays
dleidert Apr 7, 2025
925a14d
Simple header rephrasing
dleidert Apr 7, 2025
7fb3955
Drop balenaetcher as discussed with @igorpecovnik
dleidert Apr 7, 2025
26deee3
Minor typo fixes
dleidert Apr 7, 2025
a6639fb
These sections are part of Getting started
dleidert Apr 7, 2025
d62fd6a
Add section for main project resources
dleidert Apr 7, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update introduction
  • Loading branch information
dleidert committed Jan 24, 2025
commit 3f62bce0b90402c7ce9cd4bbd1cddf20d8782fad
4 changes: 2 additions & 2 deletions docs/User-Guide_Preface.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Preface
# Welcome to the Armbian Documentation

Welcome to the official documentation of Armbian Linux, a highly optimized base operating system specialized for single board computers (*SBCs*) and its extensive build framework.

Expand All @@ -10,7 +10,7 @@ If you are **new to Armbian**, the [_Introduction_](index.md) and the [_Getting

It then continues on to [_Configuration_](User-Guide_Configuration.md) tasks and tools to customize your installation, e.g. change the network address, start or stop services like SSH, or install one of the many prepared software stacks. This section and the links contained in it are useful to **all user levels**.

**Advanced users** will find more complex topics in the [_Advanced_](User-Guide_Advanced-Features.md) section.
**Advanced users** will find more complex topics in the [_Advanced_](User-Guide_Advanced-Features.md) section, including how to customize your initial installation.

If you have read through the documentation and still **need help**, check out our [_Troubleshooting_](User-Guide_Troubleshooting.md) advice.

Expand Down
79 changes: 43 additions & 36 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

Linux for ARM development boards

# Welcome to the Armbian Documentation!

## What is Armbian?

Armbian is **highly optimized base operating system specialized for single board computers**. It embodies extremely **lightweight** hardware features with **well-known** and supported Debian-based user-space experience, **extensive build framework** and is suitable for **industrial or home use**.
Armbian's goal is to provide a **highly optimized base operating system specialized for single board computers**. It embodies extremely **lightweight** hardware features with a **well-known** and supported Debian-based user-space experience, an **extensive build framework**, and it is suitable for **industrial or home use**.

Armbian is **not** a Linux distribution itself. Instead, we use Debian GNU/Linux and Ubuntu Linux as base for the images, that our users can download and deploy. We build our own set of optimized kernels for each board, and then provide an extensive and customizable framework to build, adjust, and configure these images. This framework is the heart of the project.

``` mermaid
graph LR
Expand All @@ -22,20 +22,39 @@ graph LR

```

## Key Advantages
As a user, you can simply download one of our images, deploy and run it on your SBC. As an advanced user, a manufacturer or provider, you can create fully configured custom images for your board or product.

In any case, you will get these key advantages:

- lean and standard **Debian** or **Ubuntu** based user space with well known APT package manager
- independent kernel development and maintenance with **long term support**
- extensive [build framework](https://github.com/armbian/build) with fast **hybrid assembly** of whole operating system and **endless capabilities**
- advanced **hardware and OS config** and **software installation** with build-in [armbian-config](/User-Guide_Armbian-Config/)
- daily **automated stress and upgrade testing** on key hardware targets
- exclusive support of **exotic hardware** nobody else supports
- **stabilized point** and **rolling** distribution of upgrades and OS images
- world wide download infrastructure with **perfect coverage also in China mainland**
- **extensive build infrastructure** to assist CI automation
- strong ties to embedded Linux.
- you get a lean and standard **Debian** or **Ubuntu** based user space with the well known APT package manager
- we provide an independent kernel development and maintenance with **long term support**
- we provide an extensive [build framework](https://github.com/armbian/build) with fast **hybrid assembly** of the whole operating system and **endless capabilities**
- we provide advanced **hardware and OS configuration** and **software installation** with the built-in [armbian-config](/User-Guide_Armbian-Config/) tool
- we provide exclusive support for **exotic hardware** that nobody else supports
- we provide **stabilized point** and **rolling** distribution of upgrades and OS images
- we provide a global download infrastructure with **perfect coverage, also in China mainland**
- we provide an **extensive build infrastructure** to assist in CI automation
- we do daily **automated stress and upgrade testing** on key hardware targets
- we have strong ties to embedded Linux

## Comparison
???+ "Other features and performance tweaks worth mentioning"

- Images are highly compressed and automatically expand across the boot media at first boot
- Preinstalled standard system utilities like BASH or ZSH shell
- Login is possible via serial, HDMI/VGA or SSH
- Custom login MOTD showing a collection of important information
- `/var/log` is mounted as compressed device (zram, lzo) and the log2ram service saves the logs to disk daily and on shutdown
- Half of the memory is allocated/extended for/with compressed zswap
- `/tmp` is mounted as `tmpfs` (and can be optionally compressed)
- Browser profile memory caching is enabled on desktop images
- Optimized IO scheduler (check `/etc/init.d/armhwinfo`)
- Journal data writeback is enabled (`/etc/fstab`)
- Ethernet interrupts are using a dedicated core


### Comparison

TODO: where to???

| Distributions | Armbian | Downstream | Upstream |
| -------- | -------- | -------- |-------- |
Expand All @@ -56,40 +75,28 @@ graph LR
| Pre-installed packages | optimized for fast install | makes install of anything slower | optimized for fast install |
| Declaring support | where we know maintainers | everything is "supported" | everything is "supported" |

???+ "Other features and performance tweaks worth mentioning"

- Images are highly compressed and automatically expand across boot media at first boot
- BASH or ZSH shell, preinstalled standard system utilities
- login is possible via serial, HDMI/VGA or SSH
- Login MOTD shows collection of important information
- `/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 zswap
- `/tmp` is mounted as `tmpfs` (optionally compressed)
- Browser profile memory caching is enabled on desktop images
- Optimized IO scheduler (check `/etc/init.d/armhwinfo`)
- Journal data writeback enabled. (`/etc/fstab`)
- ethernet interrupts are using dedicated core

## What is supported?
## Which hardware is supported?

Armbian distributes stable images for maintained hardware through its own [mirror network](/Mirrors/). *Supported / maintained* is not a guarantee. It implies a particular SBC is at a **high level of software maturity** and has a named maintainer. Due to the complexity and lack of cooperation in the ecosystem it is unlikely that all specialized functionalities (like 3D, VE, I²C...) are always available.

## Support status
Armbian supports many different single board computers (SBCs). But noch each model receives the same amount of support and maintenance. This might be due to lack of man-power, lack of support by the manufacturer, etc. We have therefore a system that shows the support status for each board:

[Platinum Support](https://www.armbian.com/download/?device_support=Platinum%20support){ .md-button .md-button--primary }

At least one person providing maintainance and support.
At least one person is providing constant maintainance and support.

[Standard Support](https://www.armbian.com/download/?device_support=Standard%20support){ .md-button }

Support is not secured but still good anything from this list.
Support is not secured, but it is still overall good.

[Community maintained](https://www.armbian.com/download/?device_support=Community%20maintained){ .md-button }

Most of those will also work, but no warranty as Armbian does not monitor their status.
Most of the images for boards in this category will also work, but no warranty can be given as Armbian does not monitor their status.

For more information is see the [Board Support Guide](User-Guide_Board-Support-Rules.md)

## What is supported?

Armbian distributes stable images for maintained hardware through its own [mirror network](/Mirrors/). *Supported / maintained* is not a guarantee. It implies a particular SBC is at a **high level of software maturity** and has a named maintainer. Due to the complexity and lack of cooperation in the ecosystem it is unlikely that all specialized functionalities (like 3D, VE, I²C...) are always available.

## Software titles

You can quickly and easily install popular software! They are ready to run and optimized for Armbian. Here are few highlights:
Expand Down