Skip to content

Commit f01f4dd

Browse files
committed
Automatic documentation update
1 parent c8a59d9 commit f01f4dd

File tree

7 files changed

+123
-16
lines changed

7 files changed

+123
-16
lines changed

docs/User-Guide_Armbian-Config/Network.md

Lines changed: 40 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -35,22 +35,31 @@ armbian-config --cmd BNS001
3535

3636

3737
<!--- footer START from tools/include/markdown/BNS001-footer.md --->
38-
Network configuration is simple and easy to follow:
39-
40-
1. Choose the interface. If it's a wireless interface, you'll be prompted to select an access point (AP) and enter its password. Leave empty for open network.
41-
42-
2. Choose between DHCP (Dynamic Host Configuration Protocol) or static IP configuration.
43-
44-
- If you select DHCP, the setup is complete. Optionally, you can change the MAC address.
45-
46-
3. If you choose a static configuration, you'll need to provide:
47-
48-
- An optional MAC address change
49-
- A fixed IP address (e.g., x.x.x.x/y)
50-
- A route (default: 0.0.0.0/0)
51-
- A gateway (usually x.x.x.1/24)
52-
- DNS (default: 9.9.9.9)
53-
38+
1. **Select Interface:**
39+
- Launch the `armbian-config` utility:
40+
```bash
41+
sudo armbian-config
42+
```
43+
- Navigate to `Network` and choose the desired network interface (e.g., `eth0` for wired or `wlan0` for wireless).
44+
45+
2. **Wireless Interface Configuration:**
46+
- If configuring a wireless interface:
47+
- A list of available Access Points (APs) will be displayed.
48+
- Select your preferred AP and enter the password when prompted. Leave the password field empty for open networks.
49+
50+
3. **IP Address Configuration:**
51+
- Choose between:
52+
- **DHCP (Dynamic Host Configuration Protocol):** Automatically assigns an IP address.
53+
- **Static IP:** Manually enter details:
54+
- **MAC Address (optional):** Specify if you want spoofing MAC address.
55+
- **IP Address:** Use CIDR notation (e.g., `192.168.1.10/24`).
56+
- **Route:** Default is `0.0.0.0/0`.
57+
- **Gateway:** Typically the router's IP, e.g., `192.168.1.1`.
58+
- **DNS:** Default is `9.9.9.9`, but can be changed.
59+
60+
4. **Finalize Configuration:**
61+
- Review and confirm your settings.
62+
- The system applies the configurations, and your network should be set up.
5463
<!--- footer STOP from tools/include/markdown/BNS001-footer.md --->
5564
5665
@@ -254,6 +263,11 @@ More informations:
254263
***
255264
256265
## WireGuard remove
266+
267+
<!--- section image START from tools/include/images/WG002.png --->
268+
[![WireGuard remove](/images/WG002.png)](#)
269+
<!--- section image STOP from tools/include/images/WG002.png --->
270+
257271
This operation will remove WireGuard
258272
259273
**Command:**
@@ -270,6 +284,11 @@ armbian-config --cmd WG002
270284
***
271285
272286
## WireGuard clients QR codes
287+
288+
<!--- section image START from tools/include/images/WG003.png --->
289+
[![WireGuard clients QR codes](/images/WG003.png)](#)
290+
<!--- section image STOP from tools/include/images/WG003.png --->
291+
273292
**Command:**
274293
~~~
275294
armbian-config --cmd WG003
@@ -284,6 +303,11 @@ armbian-config --cmd WG003
284303
***
285304
286305
## WireGuard purge with data folder
306+
307+
<!--- section image START from tools/include/images/WG004.png --->
308+
[![WireGuard purge with data folder](/images/WG004.png)](#)
309+
<!--- section image STOP from tools/include/images/WG004.png --->
310+
287311
This operation will purge WireGuard with data folder
288312
289313
**Command:**

docs/User-Guide_Armbian-Config/System.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,33 @@
1414
[![Install alternative kernels](/images/SY201.png)](#)
1515
<!--- section image STOP from tools/include/images/SY201.png --->
1616

17+
18+
<!--- header START from tools/include/markdown/SY201-header.md --->
19+
## Kernel Switching Warning
20+
21+
Switching between different kernel versions can significantly impact the functionality of your device. A newer or older kernel may introduce changes to hardware compatibility, drivers, and system stability. Some features may stop working, while others may improve or be reintroduced.
22+
23+
### ⚠️ Important Warning: Kernel changes carry inherent risks!
24+
- A mismatched or incompatible kernel may result in **boot failures**, rendering the system unresponsive.
25+
- Certain peripherals or hardware components (e.g., Wi-Fi, GPU acceleration, or power management) may no longer function correctly.
26+
- Custom configurations or third-party modules might need to be recompiled or adjusted to work with the new kernel.
27+
28+
### ✅ Precautions Before Switching Kernels
29+
Before switching kernels, it is **strongly recommended** to:
30+
1. **Back up your system** to prevent data loss.
31+
2. **Verify compatibility** of your hardware and essential drivers with the target kernel version.
32+
3. **Keep a rescue method available**, such as a bootable SD card / USB drive or serial console access, to recover the system if necessary.
33+
34+
### 🛠️ Recovery Steps if Boot Fails
35+
If your device fails to boot after a kernel change, you may need to:
36+
- **Revert to a previous working kernel** using recovery options.
37+
- **Use a serial console or debug mode** to diagnose the issue.
38+
- **Reinstall the system** if no recovery options are available.
39+
40+
**⚡ Exercise caution when switching kernels, especially on production systems or devices with limited recovery options.**
41+
42+
<!--- header STOP from tools/include/markdown/SY201-header.md --->
43+
1744
Switching between kernels might change functionality of your device.
1845

1946
It might fail to boot!
@@ -37,6 +64,12 @@ armbian-config --cmd SY201
3764
[![Install Linux headers](/images/SY204.png)](#)
3865
<!--- section image STOP from tools/include/images/SY204.png --->
3966

67+
68+
<!--- header START from tools/include/markdown/SY204-header.md --->
69+
Linux headers are essential for compiling kernel modules and ensuring compatibility with software that interacts with the kernel.
70+
71+
<!--- header STOP from tools/include/markdown/SY204-header.md --->
72+
4073
**Command:**
4174
~~~
4275
armbian-config --cmd SY204
@@ -65,6 +98,11 @@ armbian-config --cmd SY205
6598
***
6699

67100
### Manage device tree overlays
101+
102+
<!--- section image START from tools/include/images/SY210.png --->
103+
[![Manage device tree overlays](/images/SY210.png)](#)
104+
<!--- section image STOP from tools/include/images/SY210.png --->
105+
68106
**Command:**
69107
~~~
70108
armbian-config --cmd SY210
@@ -93,6 +131,11 @@ armbian-config --cmd SY300
93131
***
94132

95133
### Edit the boot environment
134+
135+
<!--- section image START from tools/include/images/SY010.png --->
136+
[![Edit the boot environment](/images/SY010.png)](#)
137+
<!--- section image STOP from tools/include/images/SY010.png --->
138+
96139
This will open /boot/armbianEnv.txt file to edit
97140
CTRL+S to save
98141
CTLR+X to exit
@@ -136,6 +179,33 @@ armbian-config --cmd SY001
136179
***
137180

138181
### ZFS filesystem - enable support
182+
183+
<!--- header START from tools/include/markdown/SY220-header.md --->
184+
# 📌 ZFS (Zettabyte File System)
185+
186+
## 🔍 Overview
187+
188+
**ZFS (Zettabyte File System)** is a high-performance, scalable, and robust file system designed to provide advanced data protection, integrity, and storage management. Developed by Sun Microsystems, ZFS is widely used in enterprise environments, NAS systems, and personal storage solutions due to its unique features.
189+
190+
## 🛠️ Key Features
191+
192+
### ✅ Data Integrity
193+
- **Copy-on-Write (CoW):** Prevents data corruption by never overwriting live data.
194+
- **Checksumming:** Detects and corrects silent data corruption (bit rot).
195+
196+
### 📦 Storage Management
197+
- **Pooled Storage:** Eliminates the need for traditional partitions; all storage is managed dynamically.
198+
- **Snapshots & Clones:** Creates instant backups without using extra storage.
199+
200+
### 🚀 Performance & Scalability
201+
- **Efficient Compression & Deduplication:** Reduces storage usage without performance loss.
202+
- **Dynamic Striping & Caching:** Distributes data across multiple disks for optimized read/write speeds.
203+
204+
### 🔐 Advanced Security
205+
- **Native Encryption:** Supports dataset-level encryption for secure data storage.
206+
- **RAID-Z:** A superior RAID alternative that prevents write-hole issues.
207+
<!--- header STOP from tools/include/markdown/SY220-header.md --->
208+
139209
**Command:**
140210
~~~
141211
armbian-config --cmd SY220
@@ -596,6 +666,19 @@ armbian-config --cmd SY005
596666
***
597667

598668
### Change shell system wide to ZSH
669+
670+
<!--- header START from tools/include/markdown/SY006-header.md --->
671+
**ZSH (Z Shell)** is an extended and highly customizable Unix shell that offers powerful features beyond traditional shells like **Bash**. It is widely used for its user-friendly enhancements, scripting capabilities, and plugin support.
672+
673+
## 🚀 Key Features
674+
675+
- **Auto-suggestions & Syntax Highlighting**
676+
- **Powerful Tab Completion & Globbing** 🔍
677+
- **Customizable Prompt (e.g., with Oh My Zsh)** 🎨
678+
- **Shared Command History Across Sessions** 📜
679+
- **Built-in Spelling Correction** 🛠️
680+
<!--- header STOP from tools/include/markdown/SY006-header.md --->
681+
599682
This will switch system wide shell to ZSH
600683

601684
**Command:**

docs/images/SY010.png

5.3 KB
Loading

docs/images/SY210.png

7.26 KB
Loading

docs/images/WG002.png

3.69 KB
Loading

docs/images/WG003.png

3.69 KB
Loading

docs/images/WG004.png

3.63 KB
Loading

0 commit comments

Comments
 (0)