diff --git a/docs/User-Guide_Armbian-Config/Localisation.md b/docs/User-Guide_Armbian-Config/Localisation.md new file mode 100644 index 00000000..363e1ee7 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Localisation.md @@ -0,0 +1,77 @@ +# Localisation + + +*** + +## Change Global timezone (WIP) +**Command:** +~~~ +armbian-config --cmd L00 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Change Locales reconfigure the language and character set +**Command:** +~~~ +armbian-config --cmd L01 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Change Keyboard layout +**Command:** +~~~ +armbian-config --cmd L02 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Change APT mirrors +This will change the APT mirrors + +**Command:** +~~~ +armbian-config --cmd L03 +~~~ + +**Author:** + +**Status:** Disabled + + + +*** + +## Change System Hostname +**Command:** +~~~ +armbian-config --cmd L04 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Network.md b/docs/User-Guide_Armbian-Config/Network.md new file mode 100644 index 00000000..18a11f80 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Network.md @@ -0,0 +1,127 @@ +# Fixed and wireless network settings + + +*** + +## Configure network interfaces + + +*** + +### Add / change interface +**Command:** +~~~ +armbian-config --cmd N02 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + +### Revert to Armbian defaults +**Command:** +~~~ +armbian-config --cmd N03 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + +### Show configuration +**Command:** +~~~ +armbian-config --cmd N04 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + +### Show active status +**Command:** +~~~ +armbian-config --cmd N06 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + +## Install Bluetooth support +**Command:** +~~~ +armbian-config --cmd N15 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Remove Bluetooth support +**Command:** +~~~ +armbian-config --cmd N16 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Bluetooth Discover +This will enable bluetooth and discover devices + + +**Command:** +~~~ +armbian-config --cmd N17 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Toggle system IPv6/IPv4 internet protocol +This will toggle your internet protocol + +**Command:** +~~~ +armbian-config --cmd N18 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System.md b/docs/User-Guide_Armbian-Config/System.md new file mode 100644 index 00000000..a8799e96 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System.md @@ -0,0 +1,456 @@ +# System wide and admin settings + + +*** + +## Enable Armbian kernel/firmware upgrades +This will enable Armbian kernel upgrades. + +**Command:** +~~~ +armbian-config --cmd S01 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Disable Armbian kernel upgrades +Disable Armbian kernel/firmware upgrades + +**Command:** +~~~ +armbian-config --cmd S02 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Edit the boot environment +This will open /boot/armbianEnv.txt file to edit +CTRL+S to save +CTLR+X to exit +would you like to continue? + +**Command:** +~~~ +armbian-config --cmd S03 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Install Linux headers +**Command:** +~~~ +armbian-config --cmd S04 +~~~ + +**Author:** @Tearran + +**Status:** Preview + + + +*** + +## Remove Linux headers +**Command:** +~~~ +armbian-config --cmd S05 +~~~ + +**Author:** @Tearran + +**Status:** Preview + + + +*** + +## Install to internal storage +**Command:** +~~~ +armbian-config --cmd S06 +~~~ + +**Author:** https://github.com/igorpecovnik + +**Status:** Preview + + + +*** + +## Manage SSH login options + + +*** + +### Disable root login +**Command:** +~~~ +armbian-config --cmd S07 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +### Enable root login +**Command:** +~~~ +armbian-config --cmd S08 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +### Disable password login +**Command:** +~~~ +armbian-config --cmd S09 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +### Enable password login +**Command:** +~~~ +armbian-config --cmd S10 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +### Disable Public key authentication login +**Command:** +~~~ +armbian-config --cmd S11 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +### Enable Public key authentication login +**Command:** +~~~ +armbian-config --cmd S12 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +### Disable OTP authentication +**Command:** +~~~ +armbian-config --cmd S13 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +### Enable OTP authentication +**Command:** +~~~ +armbian-config --cmd S14 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +### Generate new OTP authentication QR code +**Command:** +~~~ +armbian-config --cmd S15 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +### Show OTP authentication QR code +**Command:** +~~~ +armbian-config --cmd S16 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + +### Disable last login banner +**Command:** +~~~ +armbian-config --cmd S30 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +### Enable last login banner +**Command:** +~~~ +armbian-config --cmd S31 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Change shell system wide to BASH +**Command:** +~~~ +armbian-config --cmd S17 +~~~ + +**Author:** https://github.com/igorpecovnik + +**Status:** Preview + + + +*** + +## Change shell system wide to ZSH +**Command:** +~~~ +armbian-config --cmd S18 +~~~ + +**Author:** https://github.com/igorpecovnik + +**Status:** Preview + + + +*** + +## Switch to rolling release +This will switch to rolling releases + +would you like to continue? + +**Command:** +~~~ +armbian-config --cmd S19 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + +## Switch to stable release +This will switch to stable releases + +would you like to continue? + +**Command:** +~~~ +armbian-config --cmd S20 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + +## Enable read only filesystem +This will enable Armbian read-only filesystem. Reboot is mandatory? + + +**Command:** +~~~ +armbian-config --cmd S21 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + +## Disable read only filesystem +This will disable Armbian read-only filesystem. Reboot is mandatory? + + +**Command:** +~~~ +armbian-config --cmd S22 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + +## Adjust welcome screen (motd) +**Command:** +~~~ +armbian-config --cmd S23 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Install alternative kernels +Switching between kernels might change functionality of your device. + +It might fail to boot! + +**Command:** +~~~ +armbian-config --cmd S24 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + +## Distribution upgrades + + +*** + +### Upgrade to latest stable / LTS +Release upgrade is irriversible operation which upgrades all packages. + +Resoulted upgrade might break your build beyond repair! + +**Command:** +~~~ +armbian-config --cmd S26 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Active + + + +*** + +### Upgrade to rolling unstable +Release upgrade is irriversible operation which upgrades all packages. + +Resoulted upgrade might break your build beyond repair! + +**Command:** +~~~ +armbian-config --cmd S27 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Active + + + +*** + +## Manage device tree overlays +**Command:** +~~~ +armbian-config --cmd S28 +~~~ + +**Author:** Gunjan Gupta + +**Status:** Active + + + +*** + diff --git a/docs/User-Guide_Armbian-Software/Containers.md b/docs/User-Guide_Armbian-Software/Containers.md new file mode 100644 index 00000000..20fb4bb5 --- /dev/null +++ b/docs/User-Guide_Armbian-Software/Containers.md @@ -0,0 +1,69 @@ +# Containerlization and Virtual Machines + + +*** + +## Install Docker Minimal +This operation will install Docker Minimal. + +**Command:** +~~~ +armbian-config --cmd SW25 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Install Docker Engine +This operation will install Docker Engine. + +**Command:** +~~~ +armbian-config --cmd SW26 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Remove Docker +This operation will purge Docker. + +**Command:** +~~~ +armbian-config --cmd SW27 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Purge all Docker images, containers, and volumes +This operation will delete all Docker images, containers, and volumes. + +**Command:** +~~~ +armbian-config --cmd SW28 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Software/Desktops.md b/docs/User-Guide_Armbian-Software/Desktops.md new file mode 100644 index 00000000..29e43932 --- /dev/null +++ b/docs/User-Guide_Armbian-Software/Desktops.md @@ -0,0 +1,341 @@ +# Desktop Environments + + +*** + +## XFCE desktop + + +*** + +### XFCE desktop Install +Install XFCE: +Xfce is a lightweight desktop environment for UNIX-like operating systems. It aims to be fast and low on system resources, while still being visually appealing and user friendly. + +**Command:** +~~~ +armbian-config --cmd DE01 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +### Uninstall +**Command:** +~~~ +armbian-config --cmd DE02 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +### Enable autologin +**Command:** +~~~ +armbian-config --cmd DE03 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +### Disable autologin +**Command:** +~~~ +armbian-config --cmd DE04 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +## Gnome desktop + + +*** + +### Gnome desktop Install +**Command:** +~~~ +armbian-config --cmd DE11 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +### Uninstall +**Command:** +~~~ +armbian-config --cmd DE12 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +### Enable autologin +**Command:** +~~~ +armbian-config --cmd DE13 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +### Disable autologin +**Command:** +~~~ +armbian-config --cmd DE14 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +## i3-wm desktop +**Status:** Disabled + + + +*** + +### i3 desktop Install +**Command:** +~~~ +armbian-config --cmd DE21 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +### i3 desktop uninstall +**Command:** +~~~ +armbian-config --cmd DE22 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +### Enable autologin +**Command:** +~~~ +armbian-config --cmd DE23 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +### Disable autologin +**Command:** +~~~ +armbian-config --cmd DE24 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +## Cinnamon desktop + + +*** + +### Cinnamon desktop Install + + +[![Cinnamon desktop Install](images/DE31.png)](#) + + +**Command:** +~~~ +armbian-config --cmd DE31 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +Cinnamon is a Linux desktop that provides advanced innovative features and a traditional user experience.The desktop layout is similar to Gnome 2 with underlying technology forked from Gnome Shell. Cinnamon makes users feel at home with an easy-to-use and comfortable desktop experience. + + + + +*** + +### Cinnamon desktop uninstall +**Command:** +~~~ +armbian-config --cmd DE32 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +### Enable autologin +**Command:** +~~~ +armbian-config --cmd DE33 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +### Disable autologin +**Command:** +~~~ +armbian-config --cmd DE34 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +## Kde-neon desktop +**Status:** Disabled + + + +*** + +### Kde-neon desktop Install +**Command:** +~~~ +armbian-config --cmd DE41 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +### Uninstall +**Command:** +~~~ +armbian-config --cmd DE42 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +### Enable autologin +**Command:** +~~~ +armbian-config --cmd DE43 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +### Disable autologin +**Command:** +~~~ +armbian-config --cmd DE44 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + +## Improve application search speed +**Command:** +~~~ +armbian-config --cmd DE99 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + diff --git a/docs/User-Guide_Armbian-Software/Management.md b/docs/User-Guide_Armbian-Software/Management.md new file mode 100644 index 00000000..efdb0211 --- /dev/null +++ b/docs/User-Guide_Armbian-Software/Management.md @@ -0,0 +1,66 @@ +# Remote Management tools + + +*** + +## Install Cockpit web-based management tool +This operation will install Cockpit. +cockpit cockpit-ws cockpit-system cockpit-storaged + +**Command:** +~~~ +armbian-config --cmd M00 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Purge Cockpit web-based management tool +This operation will purge Cockpit. + +**Command:** +~~~ +armbian-config --cmd M01 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Start Cockpit Service +**Command:** +~~~ +armbian-config --cmd M02 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Stop Cockpit Service +**Command:** +~~~ +armbian-config --cmd M03 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Software/Media.md b/docs/User-Guide_Armbian-Software/Media.md new file mode 100644 index 00000000..63d03917 --- /dev/null +++ b/docs/User-Guide_Armbian-Software/Media.md @@ -0,0 +1,69 @@ +# Media Servers and Editors + + +*** + +## Install Plex Media server +This operation will install Plex Media server. + +**Command:** +~~~ +armbian-config --cmd SW21 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Remove Plex Media server +This operation will purge Plex Media server. + +**Command:** +~~~ +armbian-config --cmd SW22 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Install Emby server +This operation will install Emby server. + +**Command:** +~~~ +armbian-config --cmd SW23 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Remove Emby server +This operation will purge Emby server. + +**Command:** +~~~ +armbian-config --cmd SW24 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Software/Netconfig.md b/docs/User-Guide_Armbian-Software/Netconfig.md new file mode 100644 index 00000000..d57a80c8 --- /dev/null +++ b/docs/User-Guide_Armbian-Software/Netconfig.md @@ -0,0 +1,117 @@ +# Network tools + + +*** + +## Install realtime console network usage monitor (nload) +**Command:** +~~~ +armbian-config --cmd SW08 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Remove realtime console network usage monitor (nload) +**Command:** +~~~ +armbian-config --cmd SW09 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Install bandwidth measuring tool (iperf3) +**Command:** +~~~ +armbian-config --cmd SW10 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Remove bandwidth measuring tool (iperf3) +**Command:** +~~~ +armbian-config --cmd SW11 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Install IP LAN monitor (iptraf-ng) +**Command:** +~~~ +armbian-config --cmd SW12 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Remove IP LAN monitor (iptraf-ng) +**Command:** +~~~ +armbian-config --cmd SW13 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Install hostname broadcast via mDNS (avahi-daemon) +**Command:** +~~~ +armbian-config --cmd SW14 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + +## Remove hostname broadcast via mDNS (avahi-daemon) +**Command:** +~~~ +armbian-config --cmd SW15 +~~~ + +**Author:** + +**Status:** Preview + + + +*** +