diff --git a/.github/workflows/pull-from-armbian-config.yml b/.github/workflows/pull-from-armbian-config.yml index 41bdbb08..7c610849 100644 --- a/.github/workflows/pull-from-armbian-config.yml +++ b/.github/workflows/pull-from-armbian-config.yml @@ -30,8 +30,14 @@ jobs: run: | cd config - bin/armbian-configng --doc - cp DOCUMENTATION.md ../documentation/docs/User-Guide_Armbian-Config.md + tools/config-markdown.py -u + rsync --delete -avr docs/. ../documentation/docs/User-Guide_Armbian-Config/ + # make links + cd ../documentation + ln -fs System/System.user.md docs/User-Guide_Armbian-Config/System.md + ln -fs Network/Network.user.md docs/User-Guide_Armbian-Config/Network.md + ln -fs Localisation/Localisation.user.md docs/User-Guide_Armbian-Config/Localisation.md + ln -fs Software/Software.user.md docs/User-Guide_Armbian-Config/Software.md - name: Create Pull Request to documentation uses: peter-evans/create-pull-request@v7 @@ -45,9 +51,9 @@ jobs: title: '`Automatic` documentation update' body: | Generate documentation. - + labels: | Needs review #assignees: igorpecovnik #reviewers: Must be org collaborator - draft: false \ No newline at end of file + draft: false diff --git a/docs/User-Guide_Armbian-Config.md b/docs/User-Guide_Armbian-Config.md index 1f3b2495..d205c35b 100644 --- a/docs/User-Guide_Armbian-Config.md +++ b/docs/User-Guide_Armbian-Config.md @@ -1,10 +1,10 @@ -# Important! +Important! Following instructions are valid for next generation of Armbian config utility which is due for integration in **Armbian v24.11**. Until then please follow this installation instructions to test it out: -# Armbian Configuration Utility (Next Generation) +# Armbian Configuration Utility @@ -13,707 +13,4 @@ Utility for configuring your board, adjusting services, and installing applicati To start the Armbian configuration utility, use the following command: ~~~ sudo armbian-config -~~~ - -- ## **System** - - **S01** - Enable Armbian kernel/firmware upgrades - - **S02** - Disable Armbian kernel upgrades - - **S03** - Edit the boot environment - - **S04** - Install Linux headers - - **S05** - Remove Linux headers - - **S06** - Install to internal storage - - **S07.1** - Manage SSH login options - - **S17** - Change shell system wide to BASH - - **S18** - Change shell system wide to ZSH - - **S19** - Switch to rolling release - - **S20** - Switch to stable release - - **S21** - Enable read only filesystem - - **S22** - Disable read only filesystem - - **S23** - Adjust welcome screen (motd) - - **S24** - Install alternative kernels - - **S25** - Distribution upgrades - - **S28** - Manage device tree overlays - - -- ## **Network** - - **N01** - Configure network interfaces - - **N15** - Install Bluetooth support - - **N16** - Remove Bluetooth support - - **N17** - Bluetooth Discover - - **N18** - Toggle system IPv6/IPv4 internet protocol - - -- ## **Localisation** - - **L00** - Change Global timezone (WIP) - - **L01** - Change Locales reconfigure the language and character set - - **L02** - Change Keyboard layout - - **L03** - Change APT mirrors - - **L04** - Change System Hostname - - -- ## **Software** - - **Desktops** - Install Desktop Environments - - **Netconfig** - Network tools - - **DevTools** - Development - - **Benchy** - System benchmaking and diagnostics - - **Containers** - Containerlization and Virtual Machines - - **Media** - Media Servers and Editors - - **Management** - Remote Management tools - - -- ## **Help** - - **H00** - About This system. (WIP) - - **H02** - List of Config function(WIP) - -## Install -Armbian installation -~~~ -sudo apt install armbian-config -~~~ - -3rd party Debian based distributions -~~~ -{ - sudo wget https://apt.armbian.com/armbian.key -O key - sudo gpg --dearmor < key | sudo tee /usr/share/keyrings/armbian.gpg > /dev/null - sudo chmod go+r /usr/share/keyrings/armbian.gpg - sudo echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/armbian.gpg] http://apt.armbian.com $(lsb_release -cs) main $(lsb_release -cs)-utils $(lsb_release -cs)-desktop" | sudo tee /etc/apt/sources.list.d/armbian.list - sudo apt update - sudo apt install armbian-config -} -~~~ - -*** - -## CLI options -Command line options. - -Use: -~~~ -armbian-config --help -~~~ - -Outputs: -~~~ - - System - System wide and admin settings (x86_64) - --cmd S01 - Enable Armbian kernel/firmware upgrades - --cmd S02 - Disable Armbian kernel upgrades - --cmd S03 - Edit the boot environment - --cmd S04 - Install Linux headers - --cmd S05 - Remove Linux headers - --cmd S06 - Install to internal storage - S07.1 - Manage SSH login options - --cmd S07 - Disable root login - --cmd S08 - Enable root login - --cmd S09 - Disable password login - --cmd S10 - Enable password login - --cmd S11 - Disable Public key authentication login - --cmd S12 - Enable Public key authentication login - --cmd S13 - Disable OTP authentication - --cmd S14 - Enable OTP authentication - --cmd S15 - Generate new OTP authentication QR code - --cmd S16 - Show OTP authentication QR code - --cmd S30 - Disable last login banner - --cmd S31 - Enable last login banner - --cmd S17 - Change shell system wide to BASH - --cmd S18 - Change shell system wide to ZSH - --cmd S19 - Switch to rolling release - --cmd S20 - Switch to stable release - --cmd S21 - Enable read only filesystem - --cmd S22 - Disable read only filesystem - --cmd S23 - Adjust welcome screen (motd) - --cmd S24 - Install alternative kernels - S25 - Distribution upgrades - --cmd S26 - Upgrade to latest stable / LTS - --cmd S27 - Upgrade to rolling unstable - --cmd S28 - Manage device tree overlays - - Network - Fixed and wireless network settings (eth0) - N01 - Configure network interfaces - --cmd N02 - Add / change interface - --cmd N03 - Revert to Armbian defaults - --cmd N04 - Show configuration - --cmd N06 - Show active status - --cmd N15 - Install Bluetooth support - --cmd N16 - Remove Bluetooth support - --cmd N17 - Bluetooth Discover - --cmd N18 - Toggle system IPv6/IPv4 internet protocol - - Localisation - Localisation (C.UTF-8) - --cmd L00 - Change Global timezone (WIP) - --cmd L01 - Change Locales reconfigure the language and character set - --cmd L02 - Change Keyboard layout - --cmd L03 - Change APT mirrors - --cmd L04 - Change System Hostname - - Software - Run/Install 3rd party applications (Update the package lists.) - Desktops - Install Desktop Environments - --cmd SW02 - Install XFCE desktop - --cmd SW03 - Install Gnome desktop - --cmd SW04 - Install i3-wm desktop - --cmd SW05 - Install Cinnamon desktop - --cmd SW06 - Install kde-neon desktop - Netconfig - Network tools - --cmd SW08 - Install realtime console network usage monitor (nload) - --cmd SW09 - Remove realtime console network usage monitor (nload) - --cmd SW10 - Install bandwidth measuring tool (iperf3) - --cmd SW11 - Remove bandwidth measuring tool (iperf3) - --cmd SW12 - Install IP LAN monitor (iptraf-ng) - --cmd SW13 - Remove IP LAN monitor (iptraf-ng) - --cmd SW14 - Install hostname broadcast via mDNS (avahi-daemon) - --cmd SW15 - Remove hostname broadcast via mDNS (avahi-daemon) - DevTools - Development - --cmd SW17 - Install tools for cloning and managing repositories (git) - --cmd SW18 - Remove tools for cloning and managing repositories (git) - --cmd Benchy - System benchmaking and diagnostics - Containers - Containerlization and Virtual Machines - --cmd SW25 - Install Docker Minimal - --cmd SW26 - Install Docker Engine - --cmd SW27 - Remove Docker - --cmd SW28 - Purge all Docker images, containers, and volumes - Media - Media Servers and Editors - --cmd SW21 - Install Plex Media server - --cmd SW22 - Remove Plex Media server - --cmd SW23 - Install Emby server - --cmd SW24 - Remove Emby server - Management - Remote Management tools - --cmd M00 - Install Cockpit web-based management tool - --cmd M01 - Purge Cockpit web-based management tool - --cmd M02 - Start Cockpit Service - --cmd M03 - Stop Cockpit Service - - Help - About this app - --cmd H00 - About This system. (WIP) - --cmd H02 - List of Config function(WIP) -~~~ - -## Legacy options -Backward Compatible options. - -Use: -~~~ -armbian-config main=Help -~~~ - -Outputs: -~~~ -Legacy Options (Backward Compatible) -Please use 'armbian-config --help' for more information. - -Usage: armbian-configng main=[arguments] selection=[options] - - armbian-configng main=System selection=Headers - Install headers: - armbian-configng main=System selection=Headers_remove - Remove headers: -~~~ - -*** - -## Development - -Development is divided into three sections: - -Click for more info: - -
-Jobs / JSON Object - -A list of the jobs defined in the Jobs file. -~~~ -### S01 - -Enable Armbian kernel/firmware upgrades - -Jobs: - -~~~ -armbian_fw_manipulate unhold -~~~ - -### S02 - -Disable Armbian kernel upgrades - -Jobs: - -~~~ -armbian_fw_manipulate hold -~~~ - -### S03 - -Edit the boot environment - -Jobs: - -~~~ -nano /boot/armbianEnv.txt -~~~ - -### S04 - -Install Linux headers - -Jobs: - -~~~ -Headers_install -~~~ - -### S05 - -Remove Linux headers - -Jobs: - -~~~ -Headers_remove -~~~ - -### S06 - -Install to internal storage - -Jobs: - -~~~ -armbian-install -~~~ - -### S07.1 - -Manage SSH login options - -Jobs: - -~~~ -No commands available -~~~ - -### S17 - -Change shell system wide to BASH - -Jobs: - -~~~ -export BASHLOCATION=$(grep /bash$ /etc/shells | tail -1) -sed -i "s|^SHELL=.*|SHELL=${BASHLOCATION}|" /etc/default/useradd -sed -i "s|^DSHELL=.*|DSHELL=${BASHLOCATION}|" /etc/adduser.conf -apt_install_wrapper apt-get -y purge armbian-zsh zsh-common zsh tmux -update_skel -awk -F'[/:]' '{if ($3 >= 1000 && $3 != 65534 || $3 == 0) print $1}' /etc/passwd | xargs -L1 chsh -s $(grep /bash$ /etc/shells | tail -1) -~~~ - -### S18 - -Change shell system wide to ZSH - -Jobs: - -~~~ -export ZSHLOCATION=$(grep /zsh$ /etc/shells | tail -1) -sed -i "s|^SHELL=.*|SHELL=${ZSHLOCATION}|" /etc/default/useradd -sed -i "s|^DSHELL=.*|DSHELL=${ZSHLOCATION}|" /etc/adduser.conf -apt_install_wrapper apt-get -y install armbian-zsh zsh-common zsh tmux -update_skel -awk -F'[/:]' '{if ($3 >= 1000 && $3 != 65534 || $3 == 0) print $1}' /etc/passwd | xargs -L1 chsh -s $(grep /zsh$ /etc/shells | tail -1) -~~~ - -### S19 - -Switch to rolling release - -Jobs: - -~~~ -set_rolling -~~~ - -### S20 - -Switch to stable release - -Jobs: - -~~~ -set_stable -~~~ - -### S21 - -Enable read only filesystem - -Jobs: - -~~~ -manage_overlayfs enable -~~~ - -### S22 - -Disable read only filesystem - -Jobs: - -~~~ -manage_overlayfs disable -~~~ - -### S23 - -Adjust welcome screen (motd) - -Jobs: - -~~~ -adjust_motd -~~~ - -### S24 - -Install alternative kernels - -Jobs: - -~~~ -switch_kernels -~~~ - -### S25 - -Distribution upgrades - -Jobs: - -~~~ -No commands available -~~~ - -### S28 - -Manage device tree overlays - -Jobs: - -~~~ -manage_dtoverlays -~~~ - -### N01 - -Configure network interfaces - -Jobs: - -~~~ -No commands available -~~~ - -### N15 - -Install Bluetooth support - -Jobs: - -~~~ -see_current_apt -debconf-apt-progress -- apt-get -y install bluetooth bluez bluez-tools -check_if_installed xserver-xorg && debconf-apt-progress -- apt-get -y --no-install-recommends install pulseaudio-module-bluetooth blueman -~~~ - -### N16 - -Remove Bluetooth support - -Jobs: - -~~~ -see_current_apt -debconf-apt-progress -- apt-get -y remove bluetooth bluez bluez-tools -check_if_installed xserver-xorg && debconf-apt-progress -- apt-get -y remove pulseaudio-module-bluetooth blueman -debconf-apt-progress -- apt -y -qq autoremove -~~~ - -### N17 - -Bluetooth Discover - -Jobs: - -~~~ -connect_bt_interface -~~~ - -### N18 - -Toggle system IPv6/IPv4 internet protocol - -Jobs: - -~~~ -toggle_ipv6 | show_infobox -~~~ - -### L00 - -Change Global timezone (WIP) - -Jobs: - -~~~ -dpkg-reconfigure tzdata -~~~ - -### L01 - -Change Locales reconfigure the language and character set - -Jobs: - -~~~ -dpkg-reconfigure locales -source /etc/default/locale ; sed -i "s/^LANGUAGE=.*/LANGUAGE=$LANG/" /etc/default/locale -export LANGUAGE=$LANG -~~~ - -### L02 - -Change Keyboard layout - -Jobs: - -~~~ -dpkg-reconfigure keyboard-configuration ; setupcon -update-initramfs -u -~~~ - -### L03 - -Change APT mirrors - -Jobs: - -~~~ -get_user_continue "This is only a frontend test" process_input -~~~ - -### L04 - -Change System Hostname - -Jobs: - -~~~ -change_system_hostname -~~~ - -### Desktops - -Install Desktop Environments - -Jobs: - -~~~ -No commands available -~~~ - -### Netconfig - -Network tools - -Jobs: - -~~~ -No commands available -~~~ - -### DevTools - -Development - -Jobs: - -~~~ -No commands available -~~~ - -### Benchy - -System benchmaking and diagnostics - -Jobs: - -~~~ -see_monitoring -~~~ - -### Containers - -Containerlization and Virtual Machines - -Jobs: - -~~~ -No commands available -~~~ - -### Media - -Media Servers and Editors - -Jobs: - -~~~ -No commands available -~~~ - -### Management - -Remote Management tools - -Jobs: - -~~~ -No commands available -~~~ - -### H00 - -About This system. (WIP) - -Jobs: - -~~~ -show_message <<< "This app is to help execute procedures to configure your system - -Some options may not work on manually modified systems" -~~~ - -### H02 - -List of Config function(WIP) - -Jobs: - -~~~ -show_message <<< see_use -~~~ -~~~ -
- - -
-Jobs API / Helper Functions - -These helper functions facilitate various operations related to job management, such as creation, updating, deletion, and listing of jobs, acting as a practical API for developers. - -| Description | Example | Credit | -|:----------- | ------- |:------:| -| Generate a Help message legacy cli commands. | see_cli_legacy | Joey Turner -| Run time variables Migrated procedures from Armbian config. | set_runtime_variables | Igor Pecovnik -| Toggle SSH lastlog | toggle_ssh_lastlog | tearran -| Set Armbian to rolling release | set_rolling | Tearran -| Generate this markdown table of all module_options | see_function_table_md | Joey Turner -| Switching to alternative kernels | | Igor -| Set Armbian root filesystem to read only | manage_overlayfs enable|disable | igorpecovnik -| Display a menu from pipe | show_menu <<< armbianmonitor -h ; | Joey Turner -| Build the main menu from a object | generate_top_menu 'json_data' | Joey Turner -| Migrated procedures from Armbian config. | is_package_manager_running | Igor Pecovnik -| Migrated procedures from Armbian config. | check_desktop | Igor Pecovnik -| Generate Document files. | generate_readme | Joey Turner -| | | Igor Pecovnik -| Needed by generate_menu | | Joey Turner -| Display a Yes/No dialog box and process continue/exit | get_user_continue 'Do you wish to continue?' process_input | Joey Turner -| Display a message box | show_message <<< 'hello world' | Joey Turner -| Migrated procedures from Armbian config. | connect_bt_interface | Igor Pecovnik -| Menu for armbianmonitor features | see_monitoring | Joey Turner -| Enable/disable device tree overlays | manage_dtoverlays | Gunjan Gupta -| Show or generate QR code for Google OTP | qr_code generate | Igor Pecovnik -| Check if kernel headers are installed | are_headers_installed | Gunjan Gupta -| Check when apt list was last updated and suggest updating or update | see_current_apt || see_current_apt update | Joey Turner -| Migrated procedures from Armbian config. | check_if_installed nano | Igor Pecovnik -| Generate 'Armbian CPU logo' SVG for document file. | generate_svg | Joey Turner -| Remove Linux headers | Headers_remove | Joey Turner -| Update submenu descriptions based on conditions | update_submenu_data | Joey Turner -| sanitize input cli | sanitize_input | -| Check if a domain is reachable via IPv4 and IPv6 | check_ip_version google.com | Joey Turner -| Migrated procedures from Armbian config. | set_header_remove | Igor Pecovnik -| Generate a submenu from a parent_id | generate_menu 'parent_id' | Tearran -| Generate a markdown list json objects using jq. | see_jq_menu_list | Joey Turner -| Generate jobs from JSON file. | generate_jobs_from_json | Joey Turner -| Install kernel headers | is_package_manager_running | Joey Turner -| Toggle IPv6 on or off | toggle_ipv6 | Joey Turner -| Adjust welcome screen (motd) | | igorpecovnik -| Generate JSON-like object file. | generate_json | Joey Turner -| Install DE | install_de | Igor Pecovnik -| Install wrapper | apt_install_wrapper apt-get -y purge armbian-zsh | igorpecovnik -| Netplan wrapper | network_config | Igor Pecovnik -| Change the background color of the terminal or dialog box | set_colors 0-7 | Joey Turner -| Serve the edit and debug server. | serve_doc | Joey Turner -| Update JSON data with system information | update_json_data | Joey Turner -| pipeline strings to an infobox | show_infobox <<< 'hello world' ; | Joey Turner -| Stop hostapd, clean config | default_wireless_network_config | Igor Pecovnik -| Parse json to get list of desired menu or submenu items | parse_menu_items 'menu_options_array' | Gunjan Gupta -| Show the usage of the functions. | see_use | Joey Turner -| Generate a Help message for cli commands. | see_cmd_list [catagory] | Joey Turner -| Revert network config back to Armbian defaults | default_network_config | Igor Pecovnik -| freeze/unhold/reinstall armbian related packages. | armbian_fw_manipulate unhold|freeze|reinstall | Igor Pecovnik -| Check the internet connection with fallback DNS | see_ping | Joey Turner -| Upgrade to next stable or rolling release | release_upgrade stable verify | Igor Pecovnik -| Install docker from a repo using apt | install_docker engine | Kat Schwarz -| change_system_hostname | change_system_hostname | igorpecovnik -| Set Armbian to stable release | set_stable | Tearran -| Secure version of get_user_continue | get_user_continue_secure 'Do you wish to continue?' process_input | Joey Turner - - -
- - -
-Runtime / Board Statuses - -(WIP) - -This section outlines the runtime environment to check configurations and statuses for dynamically managing jobs based on JSON data. - -(WIP) - -
- - -## Testing and contributing - -
-Get Development - -Install the dependencies: -~~~ -sudo apt install git jq whiptail -~~~ - -Get Development and contribute: -~~~ -{ -git clone https://github.com/armbian/configng -cd configng -./armbian-configng --help -} -~~~ - -Install and test Development deb: -~~~ -{ - sudo apt install whiptail - latest_release=$(curl -s https://api.github.com/repos/armbian/configng/releases/latest) - deb_url=$(echo "$latest_release" | jq -r '.assets[] | select(.name | endswith(".deb")) | .browser_download_url') - curl -LO "$deb_url" - deb_file=$(echo "$deb_url" | awk -F"/" '{print $NF}') - sudo dpkg -i "$deb_file" - sudo dpkg --configure -a - sudo apt --fix-broken install -} -~~~ - -
- +~~~ \ No newline at end of file diff --git a/docs/User-Guide_Armbian-Config/Help/H02.user.md b/docs/User-Guide_Armbian-Config/Help/H02.user.md new file mode 100644 index 00000000..098b81d8 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Help/H02.user.md @@ -0,0 +1,17 @@ +- [Contribute](#h02) + + +# Contribute +**Command:** +~~~ +--cmd H02 +~~~ + +**Author:** + +**Status:** Stable + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Help/H03.user.md b/docs/User-Guide_Armbian-Config/Help/H03.user.md new file mode 100644 index 00000000..8cd9917e --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Help/H03.user.md @@ -0,0 +1,17 @@ +- [List of Config function(WIP)](#h03) + + +# List of Config function(WIP) +**Command:** +~~~ +--cmd H03 +~~~ + +**Author:** + +**Status:** Disabled + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Help/Help.user.md b/docs/User-Guide_Armbian-Config/Help/Help.user.md new file mode 100644 index 00000000..dfa2cbd7 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Help/Help.user.md @@ -0,0 +1,40 @@ +- [About this tool](#help) + - [Contribute](#h02) + - [List of Config function(WIP)](#h03) + + +# About this tool + + +*** + + +# Contribute +**Command:** +~~~ +--cmd H02 +~~~ + +**Author:** + +**Status:** Stable + + + +*** + + +# List of Config function(WIP) +**Command:** +~~~ +--cmd H03 +~~~ + +**Author:** + +**Status:** Disabled + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Localisation.md b/docs/User-Guide_Armbian-Config/Localisation.md new file mode 120000 index 00000000..469aed51 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Localisation.md @@ -0,0 +1 @@ +Localisation/Localisation.user.md \ No newline at end of file diff --git a/docs/User-Guide_Armbian-Config/Localisation/L00.user.md b/docs/User-Guide_Armbian-Config/Localisation/L00.user.md new file mode 100644 index 00000000..0f26cd54 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Localisation/L00.user.md @@ -0,0 +1,17 @@ +- [Change Global timezone (WIP)](#l00) + + +# Change Global timezone (WIP) +**Command:** +~~~ +--cmd L00 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Localisation/L01.user.md b/docs/User-Guide_Armbian-Config/Localisation/L01.user.md new file mode 100644 index 00000000..5548eac0 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Localisation/L01.user.md @@ -0,0 +1,17 @@ +- [Change Locales reconfigure the language and character set](#l01) + + +# Change Locales reconfigure the language and character set +**Command:** +~~~ +--cmd L01 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Localisation/L02.user.md b/docs/User-Guide_Armbian-Config/Localisation/L02.user.md new file mode 100644 index 00000000..63e13562 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Localisation/L02.user.md @@ -0,0 +1,17 @@ +- [Change Keyboard layout](#l02) + + +# Change Keyboard layout +**Command:** +~~~ +--cmd L02 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Localisation/L03.user.md b/docs/User-Guide_Armbian-Config/Localisation/L03.user.md new file mode 100644 index 00000000..06fa738b --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Localisation/L03.user.md @@ -0,0 +1,19 @@ +- [Change APT mirrors](#l03) + + +# Change APT mirrors +This will change the APT mirrors + +**Command:** +~~~ +--cmd L03 +~~~ + +**Author:** + +**Status:** Disabled + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Localisation/L04.user.md b/docs/User-Guide_Armbian-Config/Localisation/L04.user.md new file mode 100644 index 00000000..b28ca2bb --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Localisation/L04.user.md @@ -0,0 +1,17 @@ +- [Change System Hostname](#l04) + + +# Change System Hostname +**Command:** +~~~ +--cmd L04 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Localisation/Localisation.user.md b/docs/User-Guide_Armbian-Config/Localisation/Localisation.user.md new file mode 100644 index 00000000..1cc36e6d --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Localisation/Localisation.user.md @@ -0,0 +1,82 @@ +# Localisation + + +*** + + +## Change Global timezone (WIP) +**Command:** +~~~ +--cmd L00 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Change Locales reconfigure the language and character set +**Command:** +~~~ +--cmd L01 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Change Keyboard layout +**Command:** +~~~ +--cmd L02 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Change APT mirrors +This will change the APT mirrors + +**Command:** +~~~ +--cmd L03 +~~~ + +**Author:** + +**Status:** Disabled + + + +*** + + +## Change System Hostname +**Command:** +~~~ +--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 120000 index 00000000..a01f64a4 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Network.md @@ -0,0 +1 @@ +Network/Network.user.md \ No newline at end of file diff --git a/docs/User-Guide_Armbian-Config/Network/N01.user.md b/docs/User-Guide_Armbian-Config/Network/N01.user.md new file mode 100644 index 00000000..0f63d784 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Network/N01.user.md @@ -0,0 +1,72 @@ +- [Configure network interfaces](#n01) + - [Add / change interface](#n02) + - [Revert to Armbian defaults](#n03) + - [Show configuration](#n04) + - [Show active status](#n06) + + +# Configure network interfaces + + +*** + + +# Add / change interface +**Command:** +~~~ +--cmd N02 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + + +# Revert to Armbian defaults +**Command:** +~~~ +--cmd N03 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + + +# Show configuration +**Command:** +~~~ +--cmd N04 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + + +# Show active status +**Command:** +~~~ +--cmd N06 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Network/N15.user.md b/docs/User-Guide_Armbian-Config/Network/N15.user.md new file mode 100644 index 00000000..fa678135 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Network/N15.user.md @@ -0,0 +1,17 @@ +- [Install Bluetooth support](#n15) + + +# Install Bluetooth support +**Command:** +~~~ +--cmd N15 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Network/N16.user.md b/docs/User-Guide_Armbian-Config/Network/N16.user.md new file mode 100644 index 00000000..89e1abba --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Network/N16.user.md @@ -0,0 +1,17 @@ +- [Remove Bluetooth support](#n16) + + +# Remove Bluetooth support +**Command:** +~~~ +--cmd N16 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Network/N17.user.md b/docs/User-Guide_Armbian-Config/Network/N17.user.md new file mode 100644 index 00000000..2e9607ad --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Network/N17.user.md @@ -0,0 +1,20 @@ +- [Bluetooth Discover](#n17) + + +# Bluetooth Discover +This will enable bluetooth and discover devices + + +**Command:** +~~~ +--cmd N17 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Network/N18.user.md b/docs/User-Guide_Armbian-Config/Network/N18.user.md new file mode 100644 index 00000000..c7930a60 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Network/N18.user.md @@ -0,0 +1,19 @@ +- [Toggle system IPv6/IPv4 internet protocol](#n18) + + +# Toggle system IPv6/IPv4 internet protocol +This will toggle your internet protocol + +**Command:** +~~~ +--cmd N18 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Network/Network.user.md b/docs/User-Guide_Armbian-Config/Network/Network.user.md new file mode 100644 index 00000000..c16b198f --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Network/Network.user.md @@ -0,0 +1,136 @@ +# Fixed and wireless network settings + + +*** + + +## Configure network interfaces + + +*** + + +## Add / change interface +**Command:** +~~~ +--cmd N02 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + + +## Revert to Armbian defaults +**Command:** +~~~ +--cmd N03 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + + +## Show configuration +**Command:** +~~~ +--cmd N04 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + + +## Show active status +**Command:** +~~~ +--cmd N06 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + + +## Install Bluetooth support +**Command:** +~~~ +--cmd N15 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Remove Bluetooth support +**Command:** +~~~ +--cmd N16 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Bluetooth Discover +This will enable bluetooth and discover devices + + +**Command:** +~~~ +--cmd N17 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Toggle system IPv6/IPv4 internet protocol +This will toggle your internet protocol + +**Command:** +~~~ +--cmd N18 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Software.md b/docs/User-Guide_Armbian-Config/Software.md new file mode 120000 index 00000000..d189abc7 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Software.md @@ -0,0 +1 @@ +Software/Software.user.md \ No newline at end of file diff --git a/docs/User-Guide_Armbian-Config/Software/Benchy.user.md b/docs/User-Guide_Armbian-Config/Software/Benchy.user.md new file mode 100644 index 00000000..2359fa57 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Software/Benchy.user.md @@ -0,0 +1,17 @@ +- [System benchmaking and diagnostics](#benchy) + + +# System benchmaking and diagnostics +**Command:** +~~~ +--cmd Benchy +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Software/Containers.user.md b/docs/User-Guide_Armbian-Config/Software/Containers.user.md new file mode 100644 index 00000000..fe96159f --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Software/Containers.user.md @@ -0,0 +1,80 @@ +- [Containerlization and Virtual Machines](#containers) + - [Install Docker Minimal](#sw25) + - [Install Docker Engine](#sw26) + - [Remove Docker](#sw27) + - [Purge all Docker images, containers, and volumes](#sw28) + + +# Containerlization and Virtual Machines + + +*** + + +# Install Docker Minimal +This operation will install Docker Minimal. + +**Command:** +~~~ +--cmd SW25 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Install Docker Engine +This operation will install Docker Engine. + +**Command:** +~~~ +--cmd SW26 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Remove Docker +This operation will purge Docker. + +**Command:** +~~~ +--cmd SW27 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Purge all Docker images, containers, and volumes +This operation will delete all Docker images, containers, and volumes. + +**Command:** +~~~ +--cmd SW28 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Software/Desktops.user.md b/docs/User-Guide_Armbian-Config/Software/Desktops.user.md new file mode 100644 index 00000000..92b0e1dc --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Software/Desktops.user.md @@ -0,0 +1,386 @@ +- [Desktop Environments](#desktops) + - [XFCE desktop](#xfce) + - [XFCE desktop Install](#de01) + - [Uninstall](#de02) + - [Enable autologin](#de03) + - [Disable autologin](#de04) + - [Gnome desktop](#gnome) + - [Gnome desktop Install](#de11) + - [Uninstall](#de12) + - [Enable autologin](#de13) + - [Disable autologin](#de14) + - [i3-wm desktop](#de20) + - [i3 desktop Install](#de21) + - [i3 desktop uninstall](#de22) + - [Enable autologin](#de23) + - [Disable autologin](#de24) + - [Cinnamon desktop](#cinnamon) + - [Cinnamon desktop Install](#de31) + - [Cinnamon desktop uninstall](#de32) + - [Enable autologin](#de33) + - [Disable autologin](#de34) + - [Kde-neon desktop](#de40) + - [Kde-neon desktop Install](#de41) + - [Uninstall](#de42) + - [Enable autologin](#de43) + - [Disable autologin](#de44) + - [Improve application search speed](#de99) + + +# 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:** +~~~ +--cmd DE01 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Uninstall +**Command:** +~~~ +--cmd DE02 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Enable autologin +**Command:** +~~~ +--cmd DE03 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Disable autologin +**Command:** +~~~ +--cmd DE04 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Gnome desktop + + +*** + + +# Gnome desktop Install +**Command:** +~~~ +--cmd DE11 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Uninstall +**Command:** +~~~ +--cmd DE12 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Enable autologin +**Command:** +~~~ +--cmd DE13 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Disable autologin +**Command:** +~~~ +--cmd DE14 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# i3-wm desktop +**Status:** Disabled + + + +*** + + +# i3 desktop Install +**Command:** +~~~ +--cmd DE21 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# i3 desktop uninstall +**Command:** +~~~ +--cmd DE22 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Enable autologin +**Command:** +~~~ +--cmd DE23 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Disable autologin +**Command:** +~~~ +--cmd DE24 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Cinnamon desktop + + +*** + + +# Cinnamon desktop Install +**Command:** +~~~ +--cmd DE31 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Cinnamon desktop uninstall +**Command:** +~~~ +--cmd DE32 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Enable autologin +**Command:** +~~~ +--cmd DE33 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Disable autologin +**Command:** +~~~ +--cmd DE34 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Kde-neon desktop +**Status:** Disabled + + + +*** + + +# Kde-neon desktop Install +**Command:** +~~~ +--cmd DE41 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Uninstall +**Command:** +~~~ +--cmd DE42 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Enable autologin +**Command:** +~~~ +--cmd DE43 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Disable autologin +**Command:** +~~~ +--cmd DE44 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +# Improve application search speed +**Command:** +~~~ +--cmd DE99 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Software/DevTools.user.md b/docs/User-Guide_Armbian-Config/Software/DevTools.user.md new file mode 100644 index 00000000..4f708598 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Software/DevTools.user.md @@ -0,0 +1,40 @@ +- [Development](#devtools) + - [Install tools for cloning and managing repositories (git)](#sw17) + - [Remove tools for cloning and managing repositories (git)](#sw18) + + +# Development + + +*** + + +# Install tools for cloning and managing repositories (git) +**Command:** +~~~ +--cmd SW17 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Remove tools for cloning and managing repositories (git) +**Command:** +~~~ +--cmd SW18 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Software/Management.user.md b/docs/User-Guide_Armbian-Config/Software/Management.user.md new file mode 100644 index 00000000..82d3cf5a --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Software/Management.user.md @@ -0,0 +1,77 @@ +- [Remote Management tools](#management) + - [Install Cockpit web-based management tool](#m00) + - [Purge Cockpit web-based management tool](#m01) + - [Start Cockpit Service](#m02) + - [Stop Cockpit Service](#m03) + + +# Remote Management tools + + +*** + + +# Install Cockpit web-based management tool +This operation will install Cockpit. +cockpit cockpit-ws cockpit-system cockpit-storaged + +**Command:** +~~~ +--cmd M00 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Purge Cockpit web-based management tool +This operation will purge Cockpit. + +**Command:** +~~~ +--cmd M01 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Start Cockpit Service +**Command:** +~~~ +--cmd M02 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Stop Cockpit Service +**Command:** +~~~ +--cmd M03 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Software/Media.user.md b/docs/User-Guide_Armbian-Config/Software/Media.user.md new file mode 100644 index 00000000..22227fc8 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Software/Media.user.md @@ -0,0 +1,80 @@ +- [Media Servers and Editors](#media) + - [Install Plex Media server](#sw21) + - [Remove Plex Media server](#sw22) + - [Install Emby server](#sw23) + - [Remove Emby server](#sw24) + + +# Media Servers and Editors + + +*** + + +# Install Plex Media server +This operation will install Plex Media server. + +**Command:** +~~~ +--cmd SW21 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Remove Plex Media server +This operation will purge Plex Media server. + +**Command:** +~~~ +--cmd SW22 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Install Emby server +This operation will install Emby server. + +**Command:** +~~~ +--cmd SW23 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Remove Emby server +This operation will purge Emby server. + +**Command:** +~~~ +--cmd SW24 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Software/Netconfig.user.md b/docs/User-Guide_Armbian-Config/Software/Netconfig.user.md new file mode 100644 index 00000000..5411aeb1 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Software/Netconfig.user.md @@ -0,0 +1,136 @@ +- [Network tools](#netconfig) + - [Install realtime console network usage monitor (nload)](#sw08) + - [Remove realtime console network usage monitor (nload)](#sw09) + - [Install bandwidth measuring tool (iperf3)](#sw10) + - [Remove bandwidth measuring tool (iperf3)](#sw11) + - [Install IP LAN monitor (iptraf-ng)](#sw12) + - [Remove IP LAN monitor (iptraf-ng)](#sw13) + - [Install hostname broadcast via mDNS (avahi-daemon)](#sw14) + - [Remove hostname broadcast via mDNS (avahi-daemon)](#sw15) + + +# Network tools + + +*** + + +# Install realtime console network usage monitor (nload) +**Command:** +~~~ +--cmd SW08 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Remove realtime console network usage monitor (nload) +**Command:** +~~~ +--cmd SW09 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Install bandwidth measuring tool (iperf3) +**Command:** +~~~ +--cmd SW10 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Remove bandwidth measuring tool (iperf3) +**Command:** +~~~ +--cmd SW11 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Install IP LAN monitor (iptraf-ng) +**Command:** +~~~ +--cmd SW12 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Remove IP LAN monitor (iptraf-ng) +**Command:** +~~~ +--cmd SW13 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Install hostname broadcast via mDNS (avahi-daemon) +**Command:** +~~~ +--cmd SW14 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Remove hostname broadcast via mDNS (avahi-daemon) +**Command:** +~~~ +--cmd SW15 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/Software/Software.user.md b/docs/User-Guide_Armbian-Config/Software/Software.user.md new file mode 100644 index 00000000..560310c4 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/Software/Software.user.md @@ -0,0 +1,759 @@ +# Run/Install 3rd party applications + + +*** + + +## 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:** +~~~ +--cmd DE01 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Uninstall +**Command:** +~~~ +--cmd DE02 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Enable autologin +**Command:** +~~~ +--cmd DE03 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Disable autologin +**Command:** +~~~ +--cmd DE04 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Gnome desktop + + +*** + + +## Gnome desktop Install +**Command:** +~~~ +--cmd DE11 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Uninstall +**Command:** +~~~ +--cmd DE12 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Enable autologin +**Command:** +~~~ +--cmd DE13 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Disable autologin +**Command:** +~~~ +--cmd DE14 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## i3-wm desktop +**Status:** Disabled + + + +*** + + +## i3 desktop Install +**Command:** +~~~ +--cmd DE21 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## i3 desktop uninstall +**Command:** +~~~ +--cmd DE22 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Enable autologin +**Command:** +~~~ +--cmd DE23 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Disable autologin +**Command:** +~~~ +--cmd DE24 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Cinnamon desktop + + +*** + + +## Cinnamon desktop Install +**Command:** +~~~ +--cmd DE31 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Cinnamon desktop uninstall +**Command:** +~~~ +--cmd DE32 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Enable autologin +**Command:** +~~~ +--cmd DE33 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Disable autologin +**Command:** +~~~ +--cmd DE34 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Kde-neon desktop +**Status:** Disabled + + + +*** + + +## Kde-neon desktop Install +**Command:** +~~~ +--cmd DE41 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Uninstall +**Command:** +~~~ +--cmd DE42 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Enable autologin +**Command:** +~~~ +--cmd DE43 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Disable autologin +**Command:** +~~~ +--cmd DE44 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Improve application search speed +**Command:** +~~~ +--cmd DE99 +~~~ + +**Author:** @igorpecovnik + +**Status:** Stable + + + +*** + + +## Network tools + + +*** + + +## Install realtime console network usage monitor (nload) +**Command:** +~~~ +--cmd SW08 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Remove realtime console network usage monitor (nload) +**Command:** +~~~ +--cmd SW09 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Install bandwidth measuring tool (iperf3) +**Command:** +~~~ +--cmd SW10 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Remove bandwidth measuring tool (iperf3) +**Command:** +~~~ +--cmd SW11 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Install IP LAN monitor (iptraf-ng) +**Command:** +~~~ +--cmd SW12 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Remove IP LAN monitor (iptraf-ng) +**Command:** +~~~ +--cmd SW13 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Install hostname broadcast via mDNS (avahi-daemon) +**Command:** +~~~ +--cmd SW14 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Remove hostname broadcast via mDNS (avahi-daemon) +**Command:** +~~~ +--cmd SW15 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Development + + +*** + + +## Install tools for cloning and managing repositories (git) +**Command:** +~~~ +--cmd SW17 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Remove tools for cloning and managing repositories (git) +**Command:** +~~~ +--cmd SW18 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## System benchmaking and diagnostics +**Command:** +~~~ +--cmd Benchy +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Containerlization and Virtual Machines + + +*** + + +## Install Docker Minimal +This operation will install Docker Minimal. + +**Command:** +~~~ +--cmd SW25 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Install Docker Engine +This operation will install Docker Engine. + +**Command:** +~~~ +--cmd SW26 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Remove Docker +This operation will purge Docker. + +**Command:** +~~~ +--cmd SW27 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Purge all Docker images, containers, and volumes +This operation will delete all Docker images, containers, and volumes. + +**Command:** +~~~ +--cmd SW28 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Media Servers and Editors + + +*** + + +## Install Plex Media server +This operation will install Plex Media server. + +**Command:** +~~~ +--cmd SW21 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Remove Plex Media server +This operation will purge Plex Media server. + +**Command:** +~~~ +--cmd SW22 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Install Emby server +This operation will install Emby server. + +**Command:** +~~~ +--cmd SW23 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Remove Emby server +This operation will purge Emby server. + +**Command:** +~~~ +--cmd SW24 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Remote Management tools + + +*** + + +## Install Cockpit web-based management tool +This operation will install Cockpit. +cockpit cockpit-ws cockpit-system cockpit-storaged + +**Command:** +~~~ +--cmd M00 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Purge Cockpit web-based management tool +This operation will purge Cockpit. + +**Command:** +~~~ +--cmd M01 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Start Cockpit Service +**Command:** +~~~ +--cmd M02 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Stop Cockpit Service +**Command:** +~~~ +--cmd M03 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System.md b/docs/User-Guide_Armbian-Config/System.md new file mode 120000 index 00000000..eed9de27 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System.md @@ -0,0 +1 @@ +System/System.user.md \ No newline at end of file diff --git a/docs/User-Guide_Armbian-Config/System/S01.user.md b/docs/User-Guide_Armbian-Config/System/S01.user.md new file mode 100644 index 00000000..f1915ae6 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S01.user.md @@ -0,0 +1,19 @@ +- [Enable Armbian kernel/firmware upgrades](#s01) + + +# Enable Armbian kernel/firmware upgrades +This will enable Armbian kernel upgrades. + +**Command:** +~~~ +--cmd S01 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/S02.user.md b/docs/User-Guide_Armbian-Config/System/S02.user.md new file mode 100644 index 00000000..4b39067c --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S02.user.md @@ -0,0 +1,19 @@ +- [Disable Armbian kernel upgrades](#s02) + + +# Disable Armbian kernel upgrades +Disable Armbian kernel/firmware upgrades + +**Command:** +~~~ +--cmd S02 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/S03.user.md b/docs/User-Guide_Armbian-Config/System/S03.user.md new file mode 100644 index 00000000..b5139cb2 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S03.user.md @@ -0,0 +1,22 @@ +- [Edit the boot environment](#s03) + + +# 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:** +~~~ +--cmd S03 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/S04.user.md b/docs/User-Guide_Armbian-Config/System/S04.user.md new file mode 100644 index 00000000..a402567c --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S04.user.md @@ -0,0 +1,17 @@ +- [Install Linux headers](#s04) + + +# Install Linux headers +**Command:** +~~~ +--cmd S04 +~~~ + +**Author:** @Tearran + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/S05.user.md b/docs/User-Guide_Armbian-Config/System/S05.user.md new file mode 100644 index 00000000..d63cd3b2 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S05.user.md @@ -0,0 +1,17 @@ +- [Remove Linux headers](#s05) + + +# Remove Linux headers +**Command:** +~~~ +--cmd S05 +~~~ + +**Author:** @Tearran + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/S06.user.md b/docs/User-Guide_Armbian-Config/System/S06.user.md new file mode 100644 index 00000000..0c6c6281 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S06.user.md @@ -0,0 +1,17 @@ +- [Install to internal storage](#s06) + + +# Install to internal storage +**Command:** +~~~ +--cmd S06 +~~~ + +**Author:** https://github.com/igorpecovnik + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/S17.user.md b/docs/User-Guide_Armbian-Config/System/S17.user.md new file mode 100644 index 00000000..06b52b37 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S17.user.md @@ -0,0 +1,17 @@ +- [Change shell system wide to BASH](#s17) + + +# Change shell system wide to BASH +**Command:** +~~~ +--cmd S17 +~~~ + +**Author:** https://github.com/igorpecovnik + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/S18.user.md b/docs/User-Guide_Armbian-Config/System/S18.user.md new file mode 100644 index 00000000..16dd9c73 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S18.user.md @@ -0,0 +1,17 @@ +- [Change shell system wide to ZSH](#s18) + + +# Change shell system wide to ZSH +**Command:** +~~~ +--cmd S18 +~~~ + +**Author:** https://github.com/igorpecovnik + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/S19.user.md b/docs/User-Guide_Armbian-Config/System/S19.user.md new file mode 100644 index 00000000..fa7c1528 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S19.user.md @@ -0,0 +1,21 @@ +- [Switch to rolling release](#s19) + + +# Switch to rolling release +This will switch to rolling releases + +would you like to continue? + +**Command:** +~~~ +--cmd S19 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/S20.user.md b/docs/User-Guide_Armbian-Config/System/S20.user.md new file mode 100644 index 00000000..501f1143 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S20.user.md @@ -0,0 +1,21 @@ +- [Switch to stable release](#s20) + + +# Switch to stable release +This will switch to stable releases + +would you like to continue? + +**Command:** +~~~ +--cmd S20 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/S21.user.md b/docs/User-Guide_Armbian-Config/System/S21.user.md new file mode 100644 index 00000000..bd736303 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S21.user.md @@ -0,0 +1,20 @@ +- [Enable read only filesystem](#s21) + + +# Enable read only filesystem +This will enable Armbian read-only filesystem. Reboot is mandatory? + + +**Command:** +~~~ +--cmd S21 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/S22.user.md b/docs/User-Guide_Armbian-Config/System/S22.user.md new file mode 100644 index 00000000..94cbe875 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S22.user.md @@ -0,0 +1,20 @@ +- [Disable read only filesystem](#s22) + + +# Disable read only filesystem +This will disable Armbian read-only filesystem. Reboot is mandatory? + + +**Command:** +~~~ +--cmd S22 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/S23.user.md b/docs/User-Guide_Armbian-Config/System/S23.user.md new file mode 100644 index 00000000..6836ea4f --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S23.user.md @@ -0,0 +1,17 @@ +- [Adjust welcome screen (motd)](#s23) + + +# Adjust welcome screen (motd) +**Command:** +~~~ +--cmd S23 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/S24.user.md b/docs/User-Guide_Armbian-Config/System/S24.user.md new file mode 100644 index 00000000..f2eb01dc --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S24.user.md @@ -0,0 +1,21 @@ +- [Install alternative kernels](#s24) + + +# Install alternative kernels +Switching between kernels might change functionality of your device. + +It might fail to boot! + +**Command:** +~~~ +--cmd S24 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/S25.user.md b/docs/User-Guide_Armbian-Config/System/S25.user.md new file mode 100644 index 00000000..54028ae1 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S25.user.md @@ -0,0 +1,48 @@ +- [Distribution upgrades](#s25) + - [Upgrade to latest stable / LTS](#s26) + - [Upgrade to rolling unstable](#s27) + + +# 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:** +~~~ +--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:** +~~~ +--cmd S27 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Active + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/S28.user.md b/docs/User-Guide_Armbian-Config/System/S28.user.md new file mode 100644 index 00000000..3a0c8a49 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/S28.user.md @@ -0,0 +1,17 @@ +- [Manage device tree overlays](#s28) + + +# Manage device tree overlays +**Command:** +~~~ +--cmd S28 +~~~ + +**Author:** Gunjan Gupta + +**Status:** Active + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/SSH.user.md b/docs/User-Guide_Armbian-Config/System/SSH.user.md new file mode 100644 index 00000000..576fa031 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/SSH.user.md @@ -0,0 +1,200 @@ +- [Manage SSH login options](#ssh) + - [Disable root login](#s07) + - [Enable root login](#s08) + - [Disable password login](#s09) + - [Enable password login](#s10) + - [Disable Public key authentication login](#s11) + - [Enable Public key authentication login](#s12) + - [Disable OTP authentication](#s13) + - [Enable OTP authentication](#s14) + - [Generate new OTP authentication QR code](#s15) + - [Show OTP authentication QR code](#s16) + - [Disable last login banner](#s30) + - [Enable last login banner](#s31) + + +# Manage SSH login options + + +*** + + +# Disable root login +**Command:** +~~~ +--cmd S07 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Enable root login +**Command:** +~~~ +--cmd S08 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Disable password login +**Command:** +~~~ +--cmd S09 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Enable password login +**Command:** +~~~ +--cmd S10 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Disable Public key authentication login +**Command:** +~~~ +--cmd S11 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Enable Public key authentication login +**Command:** +~~~ +--cmd S12 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Disable OTP authentication +**Command:** +~~~ +--cmd S13 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Enable OTP authentication +**Command:** +~~~ +--cmd S14 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Generate new OTP authentication QR code +**Command:** +~~~ +--cmd S15 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Show OTP authentication QR code +**Command:** +~~~ +--cmd S16 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + + +# Disable last login banner +**Command:** +~~~ +--cmd S30 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +# Enable last login banner +**Command:** +~~~ +--cmd S31 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + diff --git a/docs/User-Guide_Armbian-Config/System/System.user.md b/docs/User-Guide_Armbian-Config/System/System.user.md new file mode 100644 index 00000000..aa79ed14 --- /dev/null +++ b/docs/User-Guide_Armbian-Config/System/System.user.md @@ -0,0 +1,487 @@ +# System wide and admin settings + + +*** + + +## Enable Armbian kernel/firmware upgrades +This will enable Armbian kernel upgrades. + +**Command:** +~~~ +--cmd S01 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Disable Armbian kernel upgrades +Disable Armbian kernel/firmware upgrades + +**Command:** +~~~ +--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:** +~~~ +--cmd S03 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Install Linux headers +**Command:** +~~~ +--cmd S04 +~~~ + +**Author:** @Tearran + +**Status:** Preview + + + +*** + + +## Remove Linux headers +**Command:** +~~~ +--cmd S05 +~~~ + +**Author:** @Tearran + +**Status:** Preview + + + +*** + + +## Install to internal storage +**Command:** +~~~ +--cmd S06 +~~~ + +**Author:** https://github.com/igorpecovnik + +**Status:** Preview + + + +*** + + +## Manage SSH login options + + +*** + + +### Disable root login +**Command:** +~~~ +--cmd S07 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +### Enable root login +**Command:** +~~~ +--cmd S08 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +### Disable password login +**Command:** +~~~ +--cmd S09 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +### Enable password login +**Command:** +~~~ +--cmd S10 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +### Disable Public key authentication login +**Command:** +~~~ +--cmd S11 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +### Enable Public key authentication login +**Command:** +~~~ +--cmd S12 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +### Disable OTP authentication +**Command:** +~~~ +--cmd S13 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +### Enable OTP authentication +**Command:** +~~~ +--cmd S14 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +### Generate new OTP authentication QR code +**Command:** +~~~ +--cmd S15 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +### Show OTP authentication QR code +**Command:** +~~~ +--cmd S16 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + + +## Disable last login banner +**Command:** +~~~ +--cmd S30 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Enable last login banner +**Command:** +~~~ +--cmd S31 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Change shell system wide to BASH +**Command:** +~~~ +--cmd S17 +~~~ + +**Author:** https://github.com/igorpecovnik + +**Status:** Preview + + + +*** + + +## Change shell system wide to ZSH +**Command:** +~~~ +--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:** +~~~ +--cmd S19 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + + +## Switch to stable release +This will switch to stable releases + +would you like to continue? + +**Command:** +~~~ +--cmd S20 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + + +## Enable read only filesystem +This will enable Armbian read-only filesystem. Reboot is mandatory? + + +**Command:** +~~~ +--cmd S21 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + + +## Disable read only filesystem +This will disable Armbian read-only filesystem. Reboot is mandatory? + + +**Command:** +~~~ +--cmd S22 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Preview + + + +*** + + +## Adjust welcome screen (motd) +**Command:** +~~~ +--cmd S23 +~~~ + +**Author:** + +**Status:** Preview + + + +*** + + +## Install alternative kernels +Switching between kernels might change functionality of your device. + +It might fail to boot! + +**Command:** +~~~ +--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:** +~~~ +--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:** +~~~ +--cmd S27 +~~~ + +**Author:** Igor Pecovnik + +**Status:** Active + + + +*** + + +## Manage device tree overlays +**Command:** +~~~ +--cmd S28 +~~~ + +**Author:** Gunjan Gupta + +**Status:** Active + + + +*** + diff --git a/mkdocs.yml b/mkdocs.yml index 369c5afa..f438286a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -104,7 +104,6 @@ nav: - 'ARMBIAN OS': - 'Overview': 'index.md' - 'Getting Started' : 'User-Guide_Getting-Started.md' - - 'Armbian Config' : 'User-Guide_Armbian-Config.md' - 'Networking' : 'User-Guide_Networking.md' - 'Fine Tuning' : 'User-Guide_Fine-Tuning.md' - 'Basic Troubleshooting' : 'User-Guide_Basic-Troubleshooting.md' @@ -115,6 +114,12 @@ nav: - 'FAQ' : 'User-Guide_FAQ.md' - 'Release Model' : 'Process_Release-Model.md' - 'Changelog' : 'Release_Changelog.md' + - 'ARMBIAN CONFIG': + - 'Overview': 'User-Guide_Armbian-Config.md' + - 'System': 'User-Guide_Armbian-Config/System.md' + - 'Network': 'User-Guide_Armbian-Config/Network.md' + - 'Localisation': 'User-Guide_Armbian-Config/Localisation.md' + - 'Software': 'User-Guide_Armbian-Config/Software.md' - 'ARMBIAN BUILD FRAMEWORK' : - 'Overview' : 'Developer-Guide_Welcome.md' - 'Getting Started' : 'Developer-Guide_Build-Preparation.md'