diff --git a/docs/User-Guide_Armbian-Config/Localisation.md b/docs/User-Guide_Armbian-Config/Localisation.md index c76ebd65..183f6517 100644 --- a/docs/User-Guide_Armbian-Config/Localisation.md +++ b/docs/User-Guide_Armbian-Config/Localisation.md @@ -1,66 +1,40 @@ +--- +comments: true +--- + # Localisation - -*** - ## Change Global timezone + [![Change Global timezone](/images/LO001.png)](#) -**Command:** -~~~ +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash armbian-config --cmd LO001 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Change Locales reconfigure the language and character set -**Command:** -~~~ +~~~ bash title="Change Locales reconfigure the language and character set:" armbian-config --cmd LO002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Change Keyboard layout -**Command:** -~~~ +~~~ bash title="Change Keyboard layout:" armbian-config --cmd LO003 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Change System Hostname -**Command:** -~~~ +~~~ bash title="Change System Hostname:" armbian-config --cmd LO005 ~~~ -**Author:** @armbian - -**Status:** Stable -*** - diff --git a/docs/User-Guide_Armbian-Config/Network.md b/docs/User-Guide_Armbian-Config/Network.md index 2e6c8212..1f9fb7c1 100644 --- a/docs/User-Guide_Armbian-Config/Network.md +++ b/docs/User-Guide_Armbian-Config/Network.md @@ -1,12 +1,17 @@ +--- +comments: true +--- + # Fixed and wireless network settings +## Basic setup -*** -## Basic Network Setup +Basic network setup + -[![Basic Network Setup](/images/BNS001.png)](#) +[![Basic setup](/images/BNS001.png)](#) @@ -24,91 +29,96 @@ graph LR -**Command:** -~~~ +**Author:** @igorpecovnik + +**Status:** Stable + + +~~~ custombash armbian-config --cmd BNS001 ~~~ -**Author:** @igorpecovnik - -**Status:** Stable - -1. **Select Interface:** - - Launch the `armbian-config` utility: - ```bash - sudo armbian-config - ``` - - Navigate to `Network` and choose the desired network interface (e.g., `eth0` for wired or `wlan0` for wireless). +**Select Interface:** +Choose the desired network interface, such as: -2. **Wireless Interface Configuration:** - - If configuring a wireless interface: - - A list of available Access Points (APs) will be displayed. - - Select your preferred AP and enter the password when prompted. Leave the password field empty for open networks. +- `eth0` for wired Ethernet +- `wlan0` for wireless connections -3. **IP Address Configuration:** - - Choose between: - - **DHCP (Dynamic Host Configuration Protocol):** Automatically assigns an IP address. - - **Static IP:** Manually enter details: - - **MAC Address (optional):** Specify if you want spoofing MAC address. - - **IP Address:** Use CIDR notation (e.g., `192.168.1.10/24`). - - **Route:** Default is `0.0.0.0/0`. - - **Gateway:** Typically the router's IP, e.g., `192.168.1.1`. - - **DNS:** Default is `9.9.9.9`, but can be changed. +If selecting a **wireless interface**: + +- A list of available Access Points (APs) will be displayed. +- Select your preferred AP and enter the password when prompted. +- Leave the password field empty for open networks. + +**IP Address Configuration:** +Choose between: + +- **DHCP (Dynamic Host Configuration Protocol):** + Automatically assigns an IP address. + +- **Static IP:** + Manually enter the following details: + - **MAC Address (optional):** Specify if you want to spoof the MAC address. + - **IP Address:** Use CIDR notation (e.g., `192.168.1.10/24`). + - **Route:** Default is `0.0.0.0/0`. + - **Gateway:** Typically the router’s IP (e.g., `192.168.1.1`). + - **DNS:** Default is `9.9.9.9`, but you can specify another. + +**Finalize Configuration:** + +- Review and confirm your settings. +- The system will apply the configurations. +- Your network connection should then be fully established. -4. **Finalize Configuration:** - - Review and confirm your settings. - - The system applies the configurations, and your network should be set up. - -*** - -## Remove Fallback DHCP Configuration -Drop preinstalled automatic DHCP on all wired interfaces after your configuration is setup. - -**Command:** -~~~ +~~~ bash title="Remove Fallback DHCP Configuration:" armbian-config --cmd BNS002 ~~~ + + +## View configuration + + +View Network Configuration + + + +[![View configuration](/images/VNS001.png)](#) + + + + +View Network Configuration allows you to display the system’s active network settings as a Netplan YAML configuration. This shows interfaces, IP addresses, gateways, DNS servers, and other networking details in a clean, human-readable format. Useful for verifying, troubleshooting, or manually editing network setup on systems that use Netplan for managing network interfaces. + + + **Author:** @igorpecovnik **Status:** Stable - -*** - -## View Network Settings - - -[![View Network Settings](/images/VNS001.png)](#) - - -**Command:** -~~~ +~~~ custombash armbian-config --cmd VNS001 ~~~ -**Author:** @igorpecovnik -**Status:** Stable +## Advanced +Advanced bridged network configuration -*** - -## Advanced bridged network configuration +#### Add or Change -*** +Add / change interface -### Add / change interface - + ``` mermaid graph LR A[Network] --> B[Add / Change interface]; @@ -123,19 +133,19 @@ graph LR F -->W[Access point]; ``` - - -**Command:** -~~~ -armbian-config --cmd NE002 -~~~ + **Author:** @igorpecovnik **Status:** Stable - +~~~ custombash +armbian-config --cmd NEA001 +~~~ + + + === "Wired device check" In order to configure your network devices, they need to be supported the kernel. @@ -160,58 +170,35 @@ armbian-config --cmd NE002 It is usually something like `wlan0`, `wlo1` or `wlx12334c47dec3`. If you get blank response, it means your WiFi device / dongle is not supported by the kernel. - + - -*** - -### Revert to Armbian defaults -**Command:** -~~~ -armbian-config --cmd NE003 +~~~ bash title="Revert to Armbian defaults:" +armbian-config --cmd NEA002 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -### Show configuration -**Command:** -~~~ -armbian-config --cmd NE004 +~~~ bash title="Show configuration:" +armbian-config --cmd NEA003 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -### Show active status -**Command:** -~~~ -armbian-config --cmd NE005 +~~~ bash title="Show active status:" +armbian-config --cmd NEA004 ~~~ -**Author:** @igorpecovnik - -**Status:** Stable -*** -## WireGuard VPN client / server +## WireGuard + + +WireGuard VPN client / server + -[![WireGuard VPN client / server](/images/WG001.png)](#) +[![WireGuard](/images/WG001.png)](#) @@ -219,16 +206,16 @@ armbian-config --cmd NE005 WireGuard is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner, and more useful than IPsec, while avoiding the massive headache. It intends to be considerably more performant than OpenVPN. WireGuard is designed as a general purpose VPN for running on embedded interfaces and super computers alike, fit for many different circumstances. Initially released for the Linux kernel, it is now cross-platform (Windows, macOS, BSD, iOS, Android) and widely deployable. Regarded as the most secure, easiest to use, and simplest VPN solution in the industry. -**Command:** -~~~ -armbian-config --cmd WG001 -~~~ - **Author:** @armbian **Status:** Enabled +~~~ custombash +armbian-config --cmd WG001 +~~~ + + === "Access to the server from internet" @@ -259,67 +246,20 @@ More informations: - -*** - -## WireGuard remove - - -[![WireGuard remove](/images/WG002.png)](#) - - -This operation will remove WireGuard - -**Command:** -~~~ +~~~ bash title="WireGuard remove:" armbian-config --cmd WG002 ~~~ -**Author:** @armbian -**Status:** Enabled - - - -*** - -## WireGuard clients QR codes - - -[![WireGuard clients QR codes](/images/WG003.png)](#) - - -**Command:** -~~~ +~~~ bash title="WireGuard clients QR codes:" armbian-config --cmd WG003 ~~~ -**Author:** @armbian -**Status:** Enabled - - - -*** - -## WireGuard purge with data folder - - -[![WireGuard purge with data folder](/images/WG004.png)](#) - - -This operation will purge WireGuard with data folder - -**Command:** -~~~ +~~~ bash title="WireGuard purge with data folder:" armbian-config --cmd WG004 ~~~ -**Author:** @armbian - -**Status:** Enabled -*** - diff --git a/docs/User-Guide_Armbian-Config/System.md b/docs/User-Guide_Armbian-Config/System.md index ca114a76..d1149911 100644 --- a/docs/User-Guide_Armbian-Config/System.md +++ b/docs/User-Guide_Armbian-Config/System.md @@ -1,590 +1,463 @@ +--- +comments: true +--- + # System wide and admin settings - -*** - -## Alternative kernels, headers, rolling updates, overlays +## Hardware -*** +Alternative kernels, headers, overlays, bootenv -### Install alternative kernels - - -[![Install alternative kernels](/images/SY201.png)](#) - +#### Alternative kernels - -## Kernel Switching Warning +Use alternative kernels -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. -### ⚠️ Important Warning: Kernel changes carry inherent risks! -- A mismatched or incompatible kernel may result in **boot failures**, rendering the system unresponsive. -- Certain peripherals or hardware components (e.g., Wi-Fi, GPU acceleration, or power management) may no longer function correctly. -- Custom configurations or third-party modules might need to be recompiled or adjusted to work with the new kernel. + +[![Alternative kernels](/images/KER001.png)](#) + -### ✅ Precautions Before Switching Kernels -Before switching kernels, it is **strongly recommended** to: -1. **Back up your system** to prevent data loss. -2. **Verify compatibility** of your hardware and essential drivers with the target kernel version. -3. **Keep a rescue method available**, such as a bootable SD card / USB drive or serial console access, to recover the system if necessary. -### 🛠️ Recovery Steps if Boot Fails -If your device fails to boot after a kernel change, you may need to: -- **Revert to a previous working kernel** using recovery options. -- **Use a serial console or debug mode** to diagnose the issue. -- **Reinstall the system** if no recovery options are available. + +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. -**⚡ Exercise caution when switching kernels, especially on production systems or devices with limited recovery options.** +!!! danger "Kernel changes carry inherent risks!" - + - A mismatched or incompatible kernel may result in **boot failures**, rendering the system unresponsive. + - Certain peripherals or hardware components (e.g., Wi-Fi, GPU acceleration, or power management) may no longer function correctly. + - Custom configurations or third-party modules might need to be recompiled or adjusted to work with the new kernel. -Switching between kernels might change functionality of your device. + Precautions Before Switching Kernels + Before switching kernels, it is **strongly recommended** to: -It might fail to boot! + 1. **Back up your system** to prevent data loss. + 2. **Verify compatibility** of your hardware and essential drivers with the target kernel version. + 3. **Keep a rescue method available**, such as a bootable SD card / USB drive or serial console access, to recover the system if necessary. -**Command:** -~~~ -armbian-config --cmd SY201 -~~~ + Recovery Steps if Boot Fails + If your device fails to boot after a kernel change, you may need to: + + - **Revert to a previous working kernel** using recovery options. + - **Use a serial console or debug mode** to diagnose the issue. + - **Reinstall the system** if no recovery options are available. + + **Exercise caution when switching kernels, especially on production systems or devices with limited recovery options.** + + **Author:** @igorpecovnik **Status:** Stable - -*** - -### Install Linux headers - - -[![Install Linux headers](/images/SY204.png)](#) - - - - -Linux headers are essential for compiling kernel modules and ensuring compatibility with software that interacts with the kernel. - - - -**Command:** -~~~ -armbian-config --cmd SY204 +~~~ custombash +armbian-config --cmd KER001 ~~~ + +#### Kernel Headers + + +Install Linux headers + + + +[![Kernel Headers](/images/HEAD01.png)](#) + + + + +Kernel headers are files required to build modules (drivers) or software that interfaces directly with the Linux kernel. Installing headers ensures compatibility when compiling custom drivers, DKMS modules (like ZFS, WireGuard), or updating third-party software that requires access to kernel internals. The installed headers match your running kernel version and are critical for system extensions and hardware support. + + + **Author:** @igorpecovnik **Status:** Stable - -*** - -### Remove Linux headers -**Command:** -~~~ -armbian-config --cmd SY205 +~~~ custombash +armbian-config --cmd HEAD01 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -### Manage device tree overlays - - -[![Manage device tree overlays](/images/SY210.png)](#) - - -**Command:** -~~~ -armbian-config --cmd SY210 +~~~ bash title="Remove Linux headers:" +armbian-config --cmd HEAD02 ~~~ + + +#### Device Tree Overlays + + +Manage device tree overlays + + + +[![Device Tree Overlays](/images/DTO001.png)](#) + + + + +Device Tree Overlays allow you to dynamically modify the Linux device tree at runtime, without rebuilding the kernel. They are used to enable or configure specific hardware features (like GPIO pins, I²C, SPI, sensors, displays) on single-board computers. Overlays are small snippets that can add, change, or remove parts of the hardware description, making it flexible to adapt the system for different peripherals without recompiling the full device tree. + + + **Author:** @viraniac @igorpecovnik **Status:** Stable - -*** - -### Select Odroid board configuration -**Command:** -~~~ -armbian-config --cmd SY300 +~~~ custombash +armbian-config --cmd DTO001 ~~~ -**Author:** + +#### Odroid Boards Config + + +Select Odroid board configuration **Status:** Preview - -*** - -### Edit the boot environment - - -[![Edit the boot environment](/images/SY010.png)](#) - - -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 SY010 +~~~ custombash +armbian-config --cmd ODR001 ~~~ + +#### Boot Environment + + +Edit the boot environment + + + +[![Boot Environment](/images/BOOT01.png)](#) + + + + +Edit the boot environment allows you to modify critical boot settings stored in `/boot/armbianEnv.txt`. You can adjust options such as root filesystem location, kernel parameters, overlays, boot targets, or enable advanced features like early serial console. This is essential for fine-tuning hardware support, troubleshooting, or optimizing system startup behavior. + + + **Author:** @igorpecovnik **Status:** Stable - -*** - -## Install to internal media, ZFS, NFS, read-only rootfs - - -*** - -### Install to internal storage - - -[![Install to internal storage](/images/SY001.png)](#) - - -**Command:** -~~~ -armbian-config --cmd SY001 +~~~ custombash +armbian-config --cmd BOOT01 ~~~ + +## Storage + + +Install to internal media, ZFS, NFS, read-only rootfs + +#### Install + + + +This section provides an option to transfer the live running Armbian system from an SD card to internal storage devices such as eMMC, SATA, NVMe, or USB drives. It prepares the target storage, copies the active system, adjusts bootloader settings, and ensures the system can boot independently without requiring reinstallation. + + + **Author:** @igorpecovnik **Status:** Preview - -*** - -### ZFS filesystem - enable support - - -# 📌 ZFS (Zettabyte File System) - -## 🔍 Overview - -**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. - -## 🛠️ Key Features - -### ✅ Data Integrity -- **Copy-on-Write (CoW):** Prevents data corruption by never overwriting live data. -- **Checksumming:** Detects and corrects silent data corruption (bit rot). - -### 📦 Storage Management -- **Pooled Storage:** Eliminates the need for traditional partitions; all storage is managed dynamically. -- **Snapshots & Clones:** Creates instant backups without using extra storage. - -### 🚀 Performance & Scalability -- **Efficient Compression & Deduplication:** Reduces storage usage without performance loss. -- **Dynamic Striping & Caching:** Distributes data across multiple disks for optimized read/write speeds. - -### 🔐 Advanced Security -- **Native Encryption:** Supports dataset-level encryption for secure data storage. -- **RAID-Z:** A superior RAID alternative that prevents write-hole issues. - - -**Command:** +~~~ custombash +armbian-config --cmd STO001 ~~~ -armbian-config --cmd SY220 + + +#### Read Only FS + + +Enable read only filesystem + + + +Read-only filesystem is enabled using overlayroot, a utility that places a temporary writable layer over the system root filesystem. Changes made during runtime are redirected into RAM or an alternative writable storage, while the underlying system remains untouched. This ensures that after a reboot, the system returns to a clean original state. It's ideal for kiosks, appliances, SD card-based systems, and scenarios where long-term filesystem durability and recovery are critical. + + + +**Author:** @igorpecovnik + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd ROO001 ~~~ + +~~~ bash title="Disable read only filesystem:" +armbian-config --cmd ROO002 +~~~ + + + +#### NFS + + +Enable Network filesystem (NFS) support + +**Author:** @igorpecovnik + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd NETF01 +~~~ + + +~~~ bash title="Disable Network filesystem (NFS) support:" +armbian-config --cmd NETF02 +~~~ + + + +###### NFS server + + +Enable network filesystem (NFS) daemon + +**Author:** @igorpecovnik + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd NETF04 +~~~ + + +~~~ bash title="Configure network filesystem (NFS) daemon:" +armbian-config --cmd NETF05 +~~~ + + +~~~ bash title="Remove network filesystem (NFS) daemon:" +armbian-config --cmd NETF06 +~~~ + + +~~~ bash title="Show network filesystem (NFS) daemon clients:" +armbian-config --cmd NETF07 +~~~ + + + + + +###### Find NFS servers + + +Find NFS servers in subnet and mount shares + +**Author:** @igorpecovnik + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd NETF09 +~~~ + + +~~~ bash title="Show and manage NFS mounts:" +armbian-config --cmd NETF10 +~~~ + + + +#### ZFS + + +ZFS filesystem - enable support + + + +[![ZFS](/images/ZFS001.png)](#) + + + + +ZFS is an advanced, high-performance file system and volume manager designed for data integrity, scalability, and ease of use. It offers features like copy-on-write snapshots, native compression, data deduplication, automatic repair, and efficient storage pooling. Originally developed by Sun Microsystems, ZFS is ideal for handling large amounts of data reliably with minimal maintenance. + +When enabling ZFS support, Armbian checks if the running kernel can support ZFS, installs matching kernel headers if necessary, and builds the ZFS DKMS (Dynamic Kernel Module Support) module automatically. + + + **Author:** @armbian **Status:** Stable - -*** - -### ZFS filesystem - remove support -**Command:** -~~~ -armbian-config --cmd SY221 +~~~ custombash +armbian-config --cmd ZFS001 ~~~ -**Author:** @armbian -**Status:** Stable + +##### Key Features + +###### Data Integrity +- **Copy-on-Write (CoW):** Prevents data corruption by never overwriting live data. +- **Checksumming:** Detects and corrects silent data corruption (bit rot). + +###### Storage Management +- **Pooled Storage:** Eliminates the need for traditional partitions; all storage is managed dynamically. +- **Snapshots & Clones:** Creates instant backups without using extra storage. + +###### Performance & Scalability +- **Efficient Compression & Deduplication:** Reduces storage usage without performance loss. +- **Dynamic Striping & Caching:** Distributes data across multiple disks for optimized read/write speeds. + +###### Advanced Security +- **Native Encryption:** Supports dataset-level encryption for secure data storage. +- **RAID-Z:** A superior RAID alternative that prevents write-hole issues. + + - -*** - -### Enable read only filesystem -**Command:** -~~~ -armbian-config --cmd SY007 +~~~ bash title="ZFS filesystem - remove support:" +armbian-config --cmd ZFS002 ~~~ + + +## SSH daemon + + +Manage SSH daemon options, enable 2FA + +#### Native + + +Disable root login + + + +[![Native](/images/ACC001.png)](#) + + + + +Manage native SSH daemon allows you to configure SSH server settings such as login security, authentication methods, and connection restrictions. It also enables setting up Two-Factor Authentication (2FA) to further secure SSH access using time-based codes (TOTP), adding an extra layer of protection beyond passwords. + + + **Author:** @igorpecovnik **Status:** Stable - -*** - -### Disable read only filesystem -**Command:** -~~~ -armbian-config --cmd SY008 +~~~ custombash +armbian-config --cmd ACC001 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -### Enable Network filesystem (NFS) support -**Command:** -~~~ -armbian-config --cmd NFS01 +~~~ bash title="Enable root login:" +armbian-config --cmd ACC002 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -### Disable Network filesystem (NFS) support -**Command:** -~~~ -armbian-config --cmd NFS02 +~~~ bash title="Disable password login:" +armbian-config --cmd ACC003 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -### Manage NFS Server - - -*** - -#### Enable network filesystem (NFS) daemon -**Command:** -~~~ -armbian-config --cmd NFS06 +~~~ bash title="Enable password login:" +armbian-config --cmd ACC004 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -#### Configure network filesystem (NFS) daemon -**Command:** -~~~ -armbian-config --cmd NFS07 +~~~ bash title="Disable Public key authentication login:" +armbian-config --cmd ACC005 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -#### Remove network filesystem (NFS) daemon -**Command:** -~~~ -armbian-config --cmd NFS08 +~~~ bash title="Enable Public key authentication login:" +armbian-config --cmd ACC006 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -#### Show network filesystem (NFS) daemon clients -**Command:** -~~~ -armbian-config --cmd NFS09 +~~~ bash title="Disable OTP authentication:" +armbian-config --cmd ACC007 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -### Manage NFS Client - - -*** - -#### Find NFS servers in subnet and mount shares -**Command:** -~~~ -armbian-config --cmd NFS21 +~~~ bash title="Enable OTP authentication:" +armbian-config --cmd ACC008 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -#### Show and manage NFS mounts -**Command:** -~~~ -armbian-config --cmd NFS22 +~~~ bash title="Generate new OTP authentication QR code:" +armbian-config --cmd ACC009 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -## Manage SSH daemon options, enable 2FA - - -*** - -### Disable root login - - -[![Disable root login](/images/SY101.png)](#) - - -**Command:** -~~~ -armbian-config --cmd SY101 +~~~ bash title="Show OTP authentication QR code:" +armbian-config --cmd ACC010 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -### Enable root login -**Command:** -~~~ -armbian-config --cmd SY102 +~~~ bash title="Disable last login banner:" +armbian-config --cmd ACC011 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -### Disable password login -**Command:** -~~~ -armbian-config --cmd SY103 +~~~ bash title="Enable last login banner:" +armbian-config --cmd ACC012 ~~~ -**Author:** @igorpecovnik - -**Status:** Stable -*** - -### Enable password login -**Command:** -~~~ -armbian-config --cmd SY104 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable -*** - -### Disable Public key authentication login -**Command:** -~~~ -armbian-config --cmd SY105 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable -*** - -### Enable Public key authentication login -**Command:** -~~~ -armbian-config --cmd SY106 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable -*** - -### Disable OTP authentication -**Command:** -~~~ -armbian-config --cmd SY107 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable +#### Containerised - -*** - -### Enable OTP authentication -**Command:** -~~~ -armbian-config --cmd SY108 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable +Sandboxed & containerised SSH server - -*** - -### Generate new OTP authentication QR code -**Command:** -~~~ -armbian-config --cmd SY109 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable + +[![Containerised](/images/SSH001.png)](#) + - -*** - -### Show OTP authentication QR code -**Command:** -~~~ -armbian-config --cmd SY110 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable - - - -*** - -### Disable last login banner -**Command:** -~~~ -armbian-config --cmd SY111 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable - - - -*** - -### Enable last login banner -**Command:** -~~~ -armbian-config --cmd SY112 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable - - - -*** - -### Sandboxed & containerised SSH server - - -[![Sandboxed & containerised SSH server](/images/SSH200.png)](#) - - - - + Sandboxed & containerised SSH server allows ssh access without giving keys to the entire server. Giving ssh access via private key often means giving full access to the server. This container creates a limited and sandboxed environment that others can ssh into. The users only have access to the folders mapped and the processes running inside this container. - - -This operation will install SSH server. - -**Command:** -~~~ -armbian-config --cmd SSH200 -~~~ + **Author:** @igorpecovnik **Status:** Stable - +~~~ custombash +armbian-config --cmd SSH001 +~~~ + + + === "Access to SSH server" - `ssh username@ -p 2222` @@ -601,278 +474,220 @@ armbian-config --cmd SSH200 docker logs -f openssh-server ``` - + - -*** - -### Remove sandboxed SSH server -This operation will remove SSH server. - -**Command:** +~~~ bash title="Remove sandboxed SSH server:" +armbian-config --cmd SSH002 ~~~ -armbian-config --cmd SSH201 + + +~~~ bash title="Purge sandboxed SSH server with data folder:" +armbian-config --cmd SSH003 ~~~ + + + +## Shell and MOTD + + +Change shell, adjust MOTD + +#### Change shell + + +Change shell system wide to ZSH + + + +[![Change shell](/images/SHELL1.png)](#) + + + + +ZSH is a powerful and customizable shell designed to be an enhanced replacement for BASH. When combined with Oh My Zsh, which is integrated in `armbian-zsh`, it offers an extensive plugin system, beautiful themes, and productivity features like autosuggestions, syntax highlighting, and easier navigation. + + + **Author:** @igorpecovnik **Status:** Stable - -*** - -### Purge sandboxed SSH server with data folder -This operation will purge SSH server with data folder. - -**Command:** +~~~ custombash +armbian-config --cmd SHELL1 ~~~ -armbian-config --cmd SSH202 + + +~~~ bash title="Change shell system wide to BASH:" +armbian-config --cmd SHELL2 ~~~ + + +#### Adjust MOTD + + +Adjust welcome screen (motd) + **Author:** @igorpecovnik **Status:** Stable - -*** - -## Change shell, adjust MOTD - - -*** - -### Change shell system wide to BASH - - -[![Change shell system wide to BASH](/images/SY005.png)](#) - - -This will switch system wide shell to BASH - -**Command:** -~~~ -armbian-config --cmd SY005 +~~~ custombash +armbian-config --cmd MOTD01 ~~~ + +## Update + + +OS updates and distribution upgrades + +#### Firmware + + +Enable Armbian firmware upgrades + + + +[![Firmware](/images/UPD001.png)](#) + + + + +**Enable Armbian firmware upgrades** manages whether the Armbian firmware (kernel + u-boot + firmware) packages are held or unheld in the package manager. By removing or setting the hold, it controls if firmware updates are applied automatically through regular `apt update` and `apt upgrade` processes. This allows users to either freeze the firmware version for stability or enable updates for improved hardware support. + + + **Author:** @igorpecovnik **Status:** Stable - -*** - -### Change shell system wide to ZSH - - -**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. - -## 🚀 Key Features - -- **Auto-suggestions & Syntax Highlighting** ✨ -- **Powerful Tab Completion & Globbing** 🔍 -- **Customizable Prompt (e.g., with Oh My Zsh)** 🎨 -- **Shared Command History Across Sessions** 📜 -- **Built-in Spelling Correction** 🛠️ - - -This will switch system wide shell to ZSH - -**Command:** +~~~ custombash +armbian-config --cmd UPD001 ~~~ -armbian-config --cmd SY006 + + +~~~ bash title="Disable Armbian kernel upgrades:" +armbian-config --cmd UPD002 ~~~ + + +#### Rolling + + +Switch system to rolling packages repository + + + +The daily rolling repository offers frequently updated packages directly from development branches. It provides access to the latest features, bug fixes, and hardware support improvements but may introduce instability or regressions. This channel is intended for testing, development, and users who need the newest updates at the cost of reduced stability. + + + **Author:** @igorpecovnik **Status:** Stable - -*** - -### Adjust welcome screen (motd) -**Command:** -~~~ -armbian-config --cmd SY009 +~~~ custombash +armbian-config --cmd ROLLIN ~~~ + +#### Stable + + +Switch system to stable packages repository + + + +The stable repository provides thoroughly tested packages intended for production use. Updates from this channel prioritize stability, long-term reliability, and minimal risk, ensuring systems remain secure and operational without unexpected changes. Only critical bug fixes and essential improvements are introduced after extensive testing. + + + **Author:** @igorpecovnik **Status:** Stable - -*** - -## OS updates and distribution upgrades -**Status:** Active - - - -*** - -### Enable Armbian firmware upgrades - - -[![Enable Armbian firmware upgrades](/images/SY202.png)](#) - - -This will enable Armbian kernel upgrades that are currently put on hold. - -**Command:** -~~~ -armbian-config --cmd SY202 +~~~ custombash +armbian-config --cmd STABLE ~~~ -**Author:** @igorpecovnik -**Status:** Stable +#### Docker images +Enable automating Docker container base images updating -*** - -### Disable Armbian kernel upgrades -Disable Armbian kernel/firmware upgrades - -**Command:** -~~~ -armbian-config --cmd SY203 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable - - - -*** - -### Switch system to rolling packages repository -This will switch OS to rolling releases. - -**Command:** -~~~ -armbian-config --cmd SY206 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable - - - -*** - -### Switch system to stable packages repository -This will switch OS to stable releases - -**Command:** -~~~ -armbian-config --cmd SY207 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable - - - -*** - -### Enable automating Docker container base images updating -[![Enable automating Docker container base images updating](/images/WTC001.png)](#) +[![Docker images](/images/WTC001.png)](#) -Watchtower is an application that will monitor your running Docker containers and watch for changes to the images that those containers were originally started from. If watchtower detects that an image has changed, it will automatically restart the container using the new image. +Watchtower is a lightweight tool that automatically monitors and updates running Docker containers whenever a new image version becomes available. +It checks remote registries for updated images, pulls them, stops the old containers, and restarts them using the updated versions — all without manual intervention. +Watchtower is fully configurable, allowing you to control update frequency, select specific containers, and manage notification settings. -**Command:** -~~~ +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash armbian-config --cmd WTC001 ~~~ -**Author:** @armbian -**Status:** Stable - - - -Every day watchtower will pull the latest images and compare it to the one that was used to run the certain container. If it sees that the image has changed it will stop/remove containers and then restart it using the new image and the same docker run options that were used to start the container initially. - - - - - -*** - -### Disable automating Docker container base images updating -**Command:** -~~~ +~~~ bash title="Disable automating Docker container base images updating:" armbian-config --cmd WTC002 ~~~ + + +#### Packages + + +Enable automatic package updates. + + + +[![Packages](/images/UNAT01.png)](#) + + + + +Unattended upgrades automatically install security updates and important package updates on your system without requiring manual intervention. It helps keep your system secure, stable, and up-to-date by silently applying patches. The behavior is fully configurable — you can control which packages are upgraded, set reboot options, and customize notifications or logging. + + + **Author:** @armbian **Status:** Stable - -*** - -### Enable automatic package updates. -**Command:** -~~~ +~~~ custombash armbian-config --cmd UNAT01 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -### Configure automatic package updates - - -[![Configure automatic package updates](/images/UNAT02.png)](#) - - -**Command:** -~~~ +~~~ bash title="Configure automatic package updates:" armbian-config --cmd UNAT02 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -### Disable automatic package updates -**Command:** -~~~ +~~~ bash title="Disable automatic package updates:" armbian-config --cmd UNAT03 ~~~ -**Author:** @armbian - -**Status:** Stable - -*** - diff --git a/docs/User-Guide_Armbian-Software/Containers.md b/docs/User-Guide_Armbian-Software/Containers.md index 31000945..8db59560 100644 --- a/docs/User-Guide_Armbian-Software/Containers.md +++ b/docs/User-Guide_Armbian-Software/Containers.md @@ -1,143 +1,97 @@ +--- +comments: true +--- + # Docker containerization and KVM virtual machines +## Docker -*** -## Docker minimal +Docker minimal + -[![Docker minimal](/images/CON001.webp)](#) +[![Docker](/images/CON001.webp)](#) -This operation will install Docker Minimal. - -**Command:** -~~~ -armbian-config --cmd CON001 -~~~ - **Author:** @schwar3kat **Status:** Stable +~~~ custombash +armbian-config --cmd CON001 +~~~ + + What is Docker? Docker helps developers build, share, run, and verify applications anywhere - without tedious environment configuration or management. - -*** - -## Docker engine -This operation will install Docker Engine. - -**Command:** -~~~ +~~~ bash title="Docker engine:" armbian-config --cmd CON002 ~~~ -**Author:** @schwar3kat -**Status:** Stable - - - -*** - -## Docker remove -This operation will purge Docker. - -**Command:** -~~~ +~~~ bash title="Docker remove:" armbian-config --cmd CON003 ~~~ -**Author:** @schwar3kat -**Status:** Stable - - - -*** - -## Docker purge with all images, containers, and volumes -This operation will delete all Docker images, containers, and volumes. - -**Command:** -~~~ +~~~ bash title="Docker purge with all images, containers, and volumes:" armbian-config --cmd CON004 ~~~ -**Author:** @schwar3kat - -**Status:** Stable -*** -## Portainer container management platform - - -[![Portainer container management platform](/images/CON005.webp)](#) - +## Portainer - +Portainer container management platform + + + +[![Portainer](/images/POR001.webp)](#) + + + + Portainer simplifies your Docker container management via Portainer web interface. It enables faster deploy of the applications and it gives real time visibility. - - -**Command:** -~~~ -armbian-config --cmd CON005 -~~~ + **Author:** @armbian **Status:** Stable - +~~~ custombash +armbian-config --cmd POR001 +~~~ + + + === "Access to the web interface" The web interface is accessible via port **9002**: - URL = `http://:9002` - + - -*** - -## Portainer remove -**Command:** -~~~ -armbian-config --cmd CON006 +~~~ bash title="Portainer remove:" +armbian-config --cmd POR002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Portainer purge with with data folder -**Command:** -~~~ -armbian-config --cmd CON007 +~~~ bash title="Portainer purge with with data folder:" +armbian-config --cmd POR003 ~~~ -**Author:** @armbian - -**Status:** Stable - -*** - diff --git a/docs/User-Guide_Armbian-Software/DNS.md b/docs/User-Guide_Armbian-Software/DNS.md index 450450a3..3098b530 100644 --- a/docs/User-Guide_Armbian-Software/DNS.md +++ b/docs/User-Guide_Armbian-Software/DNS.md @@ -1,16 +1,21 @@ +--- +comments: true +--- + # Network-wide ad blockers servers - -*** - -## Pi-hole DNS ad blocker - - -[![Pi-hole DNS ad blocker](/images/DNS001.png)](#) - +## Pi-hole - +Pi-hole DNS ad blocker + + + +[![Pi-hole](/images/PIH001.png)](#) + + + + Pi-hole is a network-wide ad blocker that acts as a DNS (Domain Name System) sinkhole. It works by blocking requests to known ad servers, trackers, and malicious websites across all devices connected to your home network. Here's how it works: - DNS-Based Filtering: Pi-hole intercepts DNS requests from devices on your network. When a device tries to connect to a website, Pi-hole checks if the website's domain is on a blocklist. If it is, Pi-hole prevents the connection from being made, effectively blocking ads, trackers, and potentially harmful sites. @@ -24,19 +29,19 @@ Pi-hole is a network-wide ad blocker that acts as a DNS (Domain Name System) sin - Privacy and Speed: By blocking unwanted content at the DNS level, Pi-hole not only improves browsing speed (since ads are not loaded), but also enhances privacy by preventing tracking scripts from running in the background. Pi-hole is typically installed on a Armbian minimal, but it can also run on other systems. It's a great way to have ad-blocking and privacy protection across your entire network without needing to install anything on individual devices. - - -**Command:** -~~~ -armbian-config --cmd DNS001 -~~~ + **Author:** @armbian **Status:** Stable - +~~~ custombash +armbian-config --cmd PIH001 +~~~ + + + === "Access the web interface" The web interface of Pi-hole can be accessed via: @@ -48,58 +53,35 @@ armbian-config --cmd DNS001 - + - -*** - -## Pi-hole remove -**Command:** -~~~ -armbian-config --cmd DNS003 +~~~ bash title="Pi-hole remove:" +armbian-config --cmd PIH003 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Pi-hole change web admin password -**Command:** -~~~ -armbian-config --cmd DNS002 +~~~ bash title="Pi-hole change web admin password:" +armbian-config --cmd PIH002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Pi-hole purge with data folder -**Command:** -~~~ -armbian-config --cmd DNS004 +~~~ bash title="Pi-hole purge with data folder:" +armbian-config --cmd PIH004 ~~~ -**Author:** @armbian - -**Status:** Stable -*** -## Unbound caching DNS resolver +## Unbound + + +Unbound caching DNS resolver + -[![Unbound caching DNS resolver](/images/UNB001.png)](#) +[![Unbound](/images/UNB001.png)](#) @@ -107,16 +89,16 @@ armbian-config --cmd DNS004 Unbound is a high-performance, open-source DNS resolver. It primarily serves to resolve domain names into IP addresses for devices on a network. Unlike regular DNS servers, Unbound performs DNS lookups directly and securely, providing features like DNSSEC validation (ensuring data integrity) and privacy protections. It's often used to improve speed, security, and privacy by resolving queries locally rather than relying on external DNS services. -**Command:** -~~~ -armbian-config --cmd UNB001 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd UNB001 +~~~ + + === "Default DNS port" @@ -136,41 +118,26 @@ armbian-config --cmd UNB001 - -*** - -## Unbound remove -**Command:** -~~~ +~~~ bash title="Unbound remove:" armbian-config --cmd UNB002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Unbound purge with data folder -**Command:** -~~~ +~~~ bash title="Unbound purge with data folder:" armbian-config --cmd UNB003 ~~~ -**Author:** @armbian - -**Status:** Stable -*** +## AdGuardHome + + +AdGuardHome DNS sinkhole -## AdGuardHome DNS sinkhole -[![AdGuardHome DNS sinkhole](/images/ADG001.png)](#) +[![AdGuardHome](/images/ADG001.png)](#) @@ -179,16 +146,16 @@ AdGuard Home is a network-wide software that functions as a DNS server and ad bl -**Command:** -~~~ -armbian-config --cmd ADG001 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd ADG001 +~~~ + + === "Access to the web interface" @@ -226,34 +193,14 @@ armbian-config --cmd ADG001 - -*** - -## AdGuardHome remove -**Command:** -~~~ +~~~ bash title="AdGuardHome remove:" armbian-config --cmd ADG002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## AdGuardHome purge with data folder -**Command:** -~~~ +~~~ bash title="AdGuardHome purge with data folder:" armbian-config --cmd ADG003 ~~~ -**Author:** @armbian - -**Status:** Stable - -*** - diff --git a/docs/User-Guide_Armbian-Software/Database.md b/docs/User-Guide_Armbian-Software/Database.md index a92c4ade..de9e3efb 100644 --- a/docs/User-Guide_Armbian-Software/Database.md +++ b/docs/User-Guide_Armbian-Software/Database.md @@ -1,12 +1,17 @@ +--- +comments: true +--- + # SQL database servers and web interface managers +## Mariadb -*** -## Mariadb SQL database server +Mariadb SQL database server + -[![Mariadb SQL database server](/images/DAT001.png)](#) +[![Mariadb](/images/DAT001.png)](#) @@ -15,16 +20,16 @@ Mariadb is one of the most popular database servers. Made by the original develo -**Command:** -~~~ -armbian-config --cmd DAT001 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd DAT001 +~~~ + + === "Configuration" @@ -50,111 +55,46 @@ armbian-config --cmd DAT001 - -*** - -## Mariadb remove -**Command:** -~~~ +~~~ bash title="Mariadb remove:" armbian-config --cmd DAT002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Mariadb purge with data folder -**Command:** -~~~ +~~~ bash title="Mariadb purge with data folder:" armbian-config --cmd DAT003 ~~~ -**Author:** @armbian - -**Status:** Stable -*** - -## phpMyAdmin web interface manager - - -[![phpMyAdmin web interface manager](/images/DAT005.png)](#) - +## phpMyAdmin - -Phpmyadmin is a free software tool written in PHP, intended to handle the administration of MySQL over the Web. phpMyAdmin supports a wide range of operations on MySQL and MariaDB. +phpMyAdmin web interface manager - -**Command:** -~~~ -armbian-config --cmd DAT005 -~~~ + +[![phpMyAdmin](/images/MYA001.png)](#) + **Author:** @armbian **Status:** Stable - -=== "Access to the web interface" - - The web interface is accessible via port **8071**: - - - URL: `https://:8071` - - Server: IP from server you are connecting to. If you have installed MariaDB via this tool, then this is `` - - Username: defined at SQL server install (MariaDb) - - Password: defined at SQL server install (MariaDb) - -=== "Directories" - - - Install directory: `/armbian/phpmyadmin` - - Site configuration directory: `/armbian/phpmyadmin/config` - -=== "View logs" - - ```sh - docker logs -f phpmyadmin - ``` - - - - - -*** - -## phpMyAdmin remove -**Command:** -~~~ -armbian-config --cmd DAT006 +~~~ custombash +armbian-config --cmd MYA001 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## phpMyAdmin purge with data folder -**Command:** -~~~ -armbian-config --cmd DAT007 +~~~ bash title="phpMyAdmin remove:" +armbian-config --cmd MYA002 ~~~ -**Author:** @armbian -**Status:** Stable +~~~ bash title="phpMyAdmin purge with data folder:" +armbian-config --cmd MYA003 +~~~ -*** - diff --git a/docs/User-Guide_Armbian-Software/DevTools.md b/docs/User-Guide_Armbian-Software/DevTools.md index 4f61e9e7..dca45b78 100644 --- a/docs/User-Guide_Armbian-Software/DevTools.md +++ b/docs/User-Guide_Armbian-Software/DevTools.md @@ -1,89 +1,65 @@ +--- +comments: true +--- + # Applications and tools for development +## Git CLI -*** -## Install tools for cloning and managing repositories (git) -**Command:** -~~~ -armbian-config --cmd DEV001 -~~~ +Install tools for cloning and managing repositories (git) **Author:** @armbian **Status:** Stable - -*** - -## Remove tools for cloning and managing repositories (git) -**Command:** -~~~ -armbian-config --cmd DEV002 +~~~ custombash +armbian-config --cmd GIT001 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Armbian router for repository mirror automation -**Command:** -~~~ -armbian-config --cmd DEV003 +~~~ bash title="Remove tools for cloning and managing repositories (git):" +armbian-config --cmd GIT002 ~~~ + + +## Armbian CDN router + + +Armbian router for repository mirror automation + **Author:** @efectn **Status:** Stable - -*** - -## Remove Armbian router -**Command:** -~~~ -armbian-config --cmd DEV004 +~~~ custombash +armbian-config --cmd ART001 ~~~ -**Author:** @efectn -**Status:** Stable +~~~ bash title="Remove Armbian router:" +armbian-config --cmd ART002 +~~~ -*** - ## Armbian rsyncd server -**Command:** -~~~ -armbian-config --cmd DEV010 -~~~ **Author:** @igorpecovnik **Status:** Stable - -*** - -## Remove Armbian rsyncd server -**Command:** -~~~ -armbian-config --cmd DEV011 +~~~ custombash +armbian-config --cmd RSD001 ~~~ -**Author:** @igorpecovnik -**Status:** Stable +~~~ bash title="Remove Armbian rsyncd server:" +armbian-config --cmd RSD002 +~~~ - -*** - diff --git a/docs/User-Guide_Armbian-Software/Downloaders.md b/docs/User-Guide_Armbian-Software/Downloaders.md index c6898a6e..b7b51bfa 100644 --- a/docs/User-Guide_Armbian-Software/Downloaders.md +++ b/docs/User-Guide_Armbian-Software/Downloaders.md @@ -1,12 +1,17 @@ +--- +comments: true +--- + # Download apps for movies, TV shows, music and subtitles +## qBittorrent -*** -## qBittorrent BitTorrent client +qBittorrent BitTorrent client + -[![qBittorrent BitTorrent client ](/images/DOW001.png)](#) +[![qBittorrent](/images/DOW001.png)](#) @@ -15,18 +20,16 @@ The Qbittorrent⁠ project aims to provide an open-source software alternative t -This operation will install qBittorrent BitTorrent client - -**Command:** -~~~ -armbian-config --cmd DOW001 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd DOW001 +~~~ + + === "Access to the web interface" @@ -50,45 +53,66 @@ armbian-config --cmd DOW001 - -*** - -## qBittorrent remove -This operation will remove qBittorrent BitTorrent client - -**Command:** -~~~ +~~~ bash title="qBittorrent remove:" armbian-config --cmd DOW002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## qBittorrent purge with data folder -This operation will remove qBittorrent BitTorrent data folder - -**Command:** -~~~ +~~~ bash title="qBittorrent purge with data folder:" armbian-config --cmd DOW003 ~~~ -**Author:** @armbian -**Status:** Stable +~~~ bash title="Prowlarr:" +armbian-config --cmd DOW025 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **9696**: + + - URL: `https://:9696` + - Username/Password: admin / generate at first web interface login + +=== "Directories" + + - Install directory: `/armbian/prowlarr` + - Site configuration directory: `/armbian/prowlarr/config` + +=== "View logs" + + ```sh + docker logs -f prowlarr + ``` + + + + +~~~ bash title="Prowlarr remove:" +armbian-config --cmd DOW026 +~~~ + + +~~~ bash title="Prowlarr purge with data folder:" +armbian-config --cmd DOW027 +~~~ -*** -## Deluge BitTorrent client + + + +## Deluge + + +Deluge BitTorrent client + -[![Deluge BitTorrent client](/images/DEL001.png)](#) +[![Deluge](/images/DEL001.png)](#) @@ -97,18 +121,16 @@ Deluge⁠ is a lightweight, Free Software, cross-platform BitTorrent client. -This operation will install BitTorrent client - -**Command:** -~~~ -armbian-config --cmd DEL001 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd DEL001 +~~~ + + === "Access to the web interface" @@ -132,45 +154,26 @@ armbian-config --cmd DEL001 - -*** - -## Deluge remove -This operation will remove Deluge BitTorrent client - -**Command:** -~~~ +~~~ bash title="Deluge remove:" armbian-config --cmd DEL002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Deluge purge with data folder -This operation will remove Deluge BitTorrent client data folder - -**Command:** -~~~ +~~~ bash title="Deluge purge with data folder:" armbian-config --cmd DEL003 ~~~ -**Author:** @armbian - -**Status:** Stable -*** +## Transmission + + +Transmission BitTorrent client -## Transmission BitTorrent client -[![Transmission BitTorrent client](/images/TRA001.png)](#) +[![Transmission](/images/TRA001.png)](#) @@ -179,18 +182,16 @@ Transmission⁠ is designed for easy, powerful use. Transmission has the feature -This operation will install Transmission BitTorrent client - -**Command:** -~~~ -armbian-config --cmd TRA001 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd TRA001 +~~~ + + === "Access to the web interface" @@ -215,45 +216,26 @@ armbian-config --cmd TRA001 - -*** - -## Transmission remove -This operation will remove Transmission BitTorrent client - -**Command:** -~~~ +~~~ bash title="Transmission remove:" armbian-config --cmd TRA002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Transmission purge with data folder -This operation will remove Transmission BitTorrent client data folder - -**Command:** -~~~ +~~~ bash title="Transmission purge with data folder:" armbian-config --cmd TRA003 ~~~ -**Author:** @armbian - -**Status:** Stable -*** +## SABnzbd + + +SABnzbd newsgroup downloader -## SABnzbd newsgroup downloader -[![SABnzbd newsgroup downloader](/images/SABN01.png)](#) +[![SABnzbd](/images/SABN01.png)](#) @@ -262,18 +244,16 @@ Sabnzbd⁠ makes Usenet as simple and streamlined as possible by automating ever -This operation will install SABnzbd newsgroup downloader - -**Command:** -~~~ -armbian-config --cmd SABN01 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd SABN01 +~~~ + + === "Access to the web interface" @@ -298,60 +278,39 @@ armbian-config --cmd SABN01 - -*** - -## SABnzbd remove -This operation will remove SABnzbd newsgroup downloader - -**Command:** -~~~ +~~~ bash title="SABnzbd remove:" armbian-config --cmd SABN02 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## SABnzbd purge with data folder -This operation will purge SABnzbd newsgroup data folder - -**Command:** -~~~ +~~~ bash title="SABnzbd purge with data folder:" armbian-config --cmd SABN03 ~~~ -**Author:** @armbian - -**Status:** Stable -*** +## Medusa + + +Medusa automatic downloader for TV shows -## Medusa automatic downloader for TV shows Medusa is an automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic. -This operation will install Medusa TV shows downloader - -**Command:** -~~~ -armbian-config --cmd MDS001 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd MDS001 +~~~ + + === "Access to the web interface" @@ -375,45 +334,26 @@ armbian-config --cmd MDS001 - -*** - -## Medusa TV shows downloader remove -This operation will remove Medusa TV shows downloader - -**Command:** -~~~ +~~~ bash title="Medusa TV shows downloader remove:" armbian-config --cmd MDS002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Medusa TV shows downloader purge -This operation will purge Medusa TV shows data folder - -**Command:** -~~~ +~~~ bash title="Medusa TV shows downloader purge:" armbian-config --cmd MDS003 ~~~ -**Author:** @armbian - -**Status:** Stable -*** +## Sonarr + + +Sonarr automatic downloader for TV shows -## Sonarr automatic downloader for TV shows -[![Sonarr automatic downloader for TV shows](/images/SON001.png)](#) +[![Sonarr](/images/SON001.png)](#) @@ -422,18 +362,16 @@ Sonarr (formerly NZBdrone) is a PVR for usenet and bittorrent users. It can moni -This operation will install Sonarr PVR for Usenet and BitTorrent - -**Command:** -~~~ -armbian-config --cmd SON001 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd SON001 +~~~ + + === "Access to the web interface" @@ -457,45 +395,26 @@ armbian-config --cmd SON001 - -*** - -## Sonarr remove -This operation will remove Sonarr PVR for Usenet and BitTorrent - -**Command:** -~~~ +~~~ bash title="Sonarr remove:" armbian-config --cmd SON002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Sonarr purge with data folder -This operation will purge Sonarr PVR for Usenet and BitTorrent purge data folder - -**Command:** -~~~ +~~~ bash title="Sonarr purge with data folder:" armbian-config --cmd SON003 ~~~ -**Author:** @armbian - -**Status:** Stable -*** +## Radarr + + +Radarr automatic downloader for movies -## Radarr automatic downloader for movies -[![Radarr automatic downloader for movies](/images/RAD001.png)](#) +[![Radarr](/images/RAD001.png)](#) @@ -504,18 +423,16 @@ Radarr - A fork of Sonarr to work with movies à la Couchpotato. -This operation will install Radarr movie collection manager - -**Command:** -~~~ -armbian-config --cmd RAD001 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd RAD001 +~~~ + + === "Access to the web interface" @@ -540,45 +457,26 @@ armbian-config --cmd RAD001 - -*** - -## Radarr remove -This operation will remove Radarr movie collection manager - -**Command:** -~~~ +~~~ bash title="Radarr remove:" armbian-config --cmd RAD002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Radarr purge with data folder -This operation will purge Radarr movie collection manager data folder - -**Command:** -~~~ +~~~ bash title="Radarr purge with data folder:" armbian-config --cmd RAD003 ~~~ -**Author:** @armbian - -**Status:** Stable -*** +## Bazarr + + +Bazarr automatic subtitles downloader for Sonarr and Radarr -## Bazarr automatic subtitles downloader for Sonarr and Radarr -[![Bazarr automatic subtitles downloader for Sonarr and Radarr](/images/BAZ001.png)](#) +[![Bazarr](/images/BAZ001.png)](#) @@ -587,18 +485,16 @@ Bazarr is a companion application to Sonarr and Radarr. It can manage and downlo -This operation will install Bazarr subtitles manager for Sonarr and Radarr - -**Command:** -~~~ -armbian-config --cmd BAZ001 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd BAZ001 +~~~ + + === "Access to the web interface" @@ -622,45 +518,26 @@ armbian-config --cmd BAZ001 - -*** - -## Bazarr remove -This operation will remove Bazarr subtitles manager for Sonarr and Radarr - -**Command:** -~~~ +~~~ bash title="Bazarr remove:" armbian-config --cmd BAZ002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Bazarr purge with data folder -This operation will purge Bazarr subtitles manager with data folder - -**Command:** -~~~ +~~~ bash title="Bazarr purge with data folder:" armbian-config --cmd BAZ003 ~~~ -**Author:** @armbian - -**Status:** Stable -*** +## Lidarr + + +Lidarr automatic music downloader -## Lidarr automatic music downloader -[![Lidarr automatic music downloader](/images/LID001.png)](#) +[![Lidarr](/images/LID001.png)](#) @@ -669,18 +546,16 @@ Lidarr is a music collection manager for Usenet and BitTorrent users. It can mon -This operation will install Lidarr music collection manager for Usenet and BitTorrent users - -**Command:** -~~~ -armbian-config --cmd LID001 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd LID001 +~~~ + + === "Access to the web interface" @@ -704,45 +579,26 @@ armbian-config --cmd LID001 - -*** - -## Lidarr remove -This operation will remove Lidarr - -**Command:** -~~~ +~~~ bash title="Lidarr remove:" armbian-config --cmd LID002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Lidarr purge with data folder -This operation will purge Lidarr with data folder - -**Command:** -~~~ +~~~ bash title="Lidarr purge with data folder:" armbian-config --cmd LID003 ~~~ -**Author:** @armbian - -**Status:** Stable -*** +## Readarr + + +Readarr automatic downloader for Ebooks -## Readarr automatic downloader for Ebooks -[![Readarr automatic downloader for Ebooks](/images/RDR001.png)](#) +[![Readarr](/images/RDR001.png)](#) @@ -751,18 +607,16 @@ Readarr - Book Manager and Automation (Sonarr for Ebooks) -This operation will install Readarr - -**Command:** -~~~ -armbian-config --cmd RDR001 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd RDR001 +~~~ + + === "Access to the web interface" @@ -786,126 +640,26 @@ armbian-config --cmd RDR001 - -*** - -## Readarr remove -This operation will remove Readarr - -**Command:** -~~~ +~~~ bash title="Readarr remove:" armbian-config --cmd RDR002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Readarr purge with data folder -This operation will purge Readarr with data folder - -**Command:** -~~~ +~~~ bash title="Readarr purge with data folder:" armbian-config --cmd RDR003 ~~~ -**Author:** @armbian - -**Status:** Stable -*** - -## Prowlarr index manager and proxy for PVR - - -[![Prowlarr index manager and proxy for PVR](/images/DOW025.png)](#) - +## Jellyseerr - -Prowlarr is a indexer manager/proxy built on the popular arr .net/reactjs base stack to integrate with your various PVR apps. Prowlarr supports both Torrent Trackers and Usenet Indexers. It integrates seamlessly with Sonarr, Radarr, Lidarr, and Readarr offering complete management of your indexers with no per app Indexer setup required (we do it all). +Jellyseerr Jellyfin/Emby/Plex integration install - - -This operation will install Prowlarr - -**Command:** -~~~ -armbian-config --cmd DOW025 -~~~ - -**Author:** @armbian - -**Status:** Stable - - - -=== "Access to the web interface" - - The web interface is accessible via port **9696**: - - - URL: `https://:9696` - - Username/Password: admin / generate at first web interface login - -=== "Directories" - - - Install directory: `/armbian/prowlarr` - - Site configuration directory: `/armbian/prowlarr/config` - -=== "View logs" - - ```sh - docker logs -f prowlarr - ``` - - - - - -*** - -## Prowlarr remove -This operation will remove Prowlarr - -**Command:** -~~~ -armbian-config --cmd DOW026 -~~~ - -**Author:** @armbian - -**Status:** Stable - - - -*** - -## Prowlarr purge with data folder -This operation will purge Prowlarr with data folder - -**Command:** -~~~ -armbian-config --cmd DOW027 -~~~ - -**Author:** @armbian - -**Status:** Stable - - - -*** - -## Jellyseerr Jellyfin/Emby/Plex integration install -[![Jellyseerr Jellyfin/Emby/Plex integration install](/images/JEL001.png)](#) +[![Jellyseerr](/images/JEL001.png)](#) @@ -914,50 +668,24 @@ Jellyseerr is a free and open source software application for managing requests -This operation will install Jellyseerr +**Author:** @armbian -**Command:** -~~~ +**Status:** Stable + + +~~~ custombash armbian-config --cmd JEL001 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Jellyseerr remove -This operation will remove Jellyseerr - -**Command:** -~~~ +~~~ bash title="Jellyseerr remove:" armbian-config --cmd JEL002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Jellyseerr purge with data folder -This operation will purge Jellyseerr with data folder - -**Command:** -~~~ +~~~ bash title="Jellyseerr purge with data folder:" armbian-config --cmd JEL003 ~~~ -**Author:** @armbian - -**Status:** Stable - -*** - diff --git a/docs/User-Guide_Armbian-Software/HomeAutomation.md b/docs/User-Guide_Armbian-Software/HomeAutomation.md index 71bb31fd..84eb05ed 100644 --- a/docs/User-Guide_Armbian-Software/HomeAutomation.md +++ b/docs/User-Guide_Armbian-Software/HomeAutomation.md @@ -1,65 +1,49 @@ +--- +comments: true +--- + # Home Automation for control home appliances +## openHAB -*** -## openHAB empowering the smart home +openHAB empowering the smart home + -[![openHAB empowering the smart home](/images/HAB001.png)](#) +[![openHAB](/images/HAB001.png)](#) -This operation will install openHAB. +**Author:** @armbian -**Command:** -~~~ +**Status:** Stable + + +~~~ custombash armbian-config --cmd HAB001 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## openHAB remove -This operation will purge openHAB. - -**Command:** -~~~ +~~~ bash title="openHAB remove:" armbian-config --cmd HAB002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## openHAB purge with data folder -This operation will purge openHAB. - -**Command:** -~~~ +~~~ bash title="openHAB purge with data folder:" armbian-config --cmd HAB003 ~~~ -**Author:** @armbian - -**Status:** Stable -*** +## Home Assistant + + +Home Assistant open source home automation -## Home Assistant open source home automation -[![Home Assistant open source home automation](/images/HAS001.png)](#) +[![Home Assistant](/images/HAS001.png)](#) @@ -68,6 +52,19 @@ Home Assistant is an open source smart home platform that allows you to connect Perfect to run on any single board computer with 4 cores and at least 512Mb of memory. Armbian installation is optimised to run from SD/eMMC media, but it is recommended to use SSD. + + +**Author:** @igorpecovnik + +**Status:** Preview + + +~~~ custombash +armbian-config --cmd HAS001 +~~~ + + + === "Access to the web interface" The web interface is accessible via port **8123**: @@ -81,73 +78,42 @@ Perfect to run on any single board computer with 4 cores and at least 512Mb of m - Config directory: `/armbian/haos` - +=== "Armbian advantages" -This operation will install Home Assistant. + |Functionality|HAOS|Armbian with HA| + |:--|:--:|:--:| + |Automations|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| + |Dashboards|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| + |Integrations|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| + |Add-ons|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| + |One-click updates|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| + |Backups|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| + |General purpose server|:x:|:white_check_mark:| + |Running on exotic hardware|:x:|:white_check_mark:| -**Command:** -~~~ -armbian-config --cmd HAS001 -~~~ - -**Author:** @igorpecovnik - -**Status:** Preview - - - -|Functionality|HAOS|Armbian with HA| -|:--|:--:|:--:| -|Automations|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| -|Dashboards|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| -|Integrations|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| -|Add-ons|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| -|One-click updates|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| -|Backups|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| -|General purpose server|:x:|:white_check_mark:| -|Running on exotic hardware|:x:|:white_check_mark:| - -*** - -## Home Assistant remove -This operation will remove Home Assistant. - -**Command:** -~~~ +~~~ bash title="Home Assistant remove:" armbian-config --cmd HAS002 ~~~ -**Author:** @igorpecovnik -**Status:** Preview - - - -*** - -## Home Assistant purge with data folder -This operation will purge Home Assistant. - -**Command:** -~~~ +~~~ bash title="Home Assistant purge with data folder:" armbian-config --cmd HAS003 ~~~ -**Author:** @igorpecovnik - -**Status:** Preview -*** +## Domoticz + + +Domoticz open source home automation -## Domoticz open source home automation -[![Domoticz open source home automation](/images/DOM001.png)](#) +[![Domoticz](/images/DOM001.png)](#) @@ -172,57 +138,36 @@ Domoticz is an open-source home automation platform that allows you to control a -This operation will install Domoticz. +**Author:** @igorpecovnik -**Command:** -~~~ +**Status:** Preview + + +~~~ custombash armbian-config --cmd DOM001 ~~~ -**Author:** @igorpecovnik -**Status:** Preview - - - -*** - -## Domoticz remove -This operation will remove Domoticz. - -**Command:** -~~~ +~~~ bash title="Domoticz remove:" armbian-config --cmd DOM002 ~~~ -**Author:** @igorpecovnik -**Status:** Preview - - - -*** - -## Domoticz purge with data folder -This operation will purge Domoticz. - -**Command:** -~~~ +~~~ bash title="Domoticz purge with data folder:" armbian-config --cmd DOM003 ~~~ -**Author:** @igorpecovnik - -**Status:** Preview -*** +## EVCC + + +EVCC - solar charging automation -## EVCC - solar charging automation -[![EVCC - solar charging automation](/images/EVCC01.png)](#) +[![EVCC](/images/EVCC01.png)](#) @@ -231,18 +176,16 @@ evcc is an energy management system with a focus on electromobility. The softwar -This operation will install solar charging automation. - -**Command:** -~~~ -armbian-config --cmd EVCC01 -~~~ - **Author:** @igorpecovnik **Status:** Preview +~~~ custombash +armbian-config --cmd EVCC01 +~~~ + + === "Access to the web interface" @@ -265,38 +208,14 @@ armbian-config --cmd EVCC01 - -*** - -## EVCC - solar charging automation remove -This operation will remove solar charging automation. - -**Command:** -~~~ +~~~ bash title="EVCC - solar charging automation remove:" armbian-config --cmd EVCC02 ~~~ -**Author:** @igorpecovnik -**Status:** Preview - - - -*** - -## EVCC purge with data folder -This operation will purge solar charging automation with data folder. - -**Command:** -~~~ +~~~ bash title="EVCC purge with data folder:" armbian-config --cmd EVCC03 ~~~ -**Author:** @igorpecovnik - -**Status:** Preview - -*** - diff --git a/docs/User-Guide_Armbian-Software/Management.md b/docs/User-Guide_Armbian-Software/Management.md index 28b44d51..1a927d0e 100644 --- a/docs/User-Guide_Armbian-Software/Management.md +++ b/docs/User-Guide_Armbian-Software/Management.md @@ -1,25 +1,21 @@ -# Remote Management tools +--- +comments: true +--- + +# Remote File & Management tools + +## Cockpit -*** - -## Cockpit web-based management tool - - -[![Cockpit web-based management tool](/images/MAN001.png)](#) - - -**Command:** -~~~ -armbian-config --cmd MAN001 -~~~ - -**Author:** @Tearran - -**Status:** Stable +Cockpit web-based management tool - + +[![Cockpit](/images/CPT001.png)](#) + + + + Introducing Cockpit Cockpit is a web-based graphical interface for servers, intended for everyone, especially those who are: @@ -31,29 +27,87 @@ and want an easy, graphical way to administer servers who mainly use other tools but want an overview on individual systems Thanks to Cockpit intentionally using system APIs and commands, a whole team of admins can manage a system in the way they prefer, including the command line and utilities right alongside Cockpit. - - - - -*** - -## Webmin web-based management tool - - -[![Webmin web-based management tool](/images/MAN005.png)](#) - - -**Command:** -~~~ -armbian-config --cmd MAN005 -~~~ + **Author:** @Tearran **Status:** Stable - +~~~ custombash +armbian-config --cmd CPT001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **9090**: + + - URL: `https://:9090` + - Username/Password: your system login credentials + +=== "Video instructions" + + + + + + + +## Samba + + +SAMBA Remote File share + + + +[![Samba](/images/SMB001.png)](#) + + + + +Samba is an open-source software suite that enables seamless file and printer sharing between Linux/Unix servers and Windows clients. It allows a Linux machine to act as a domain controller, file server, or print server within a Windows network environment, supporting cross-platform interoperability. + + + +**Author:** @Tearran + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd SMB001 +~~~ + + +## Webmin + + +Webmin web-based management tool + + + +[![Webmin](/images/WBM001.png)](#) + + + + +Webmin is a web-based system administration tool for Unix-like servers. It provides an easy-to-use browser interface to manage users, configure services, edit files, monitor system performance, and control almost every aspect of your server — without needing to touch the command line. + + + +**Author:** @Tearran + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd WBM001 +~~~ + + + === "Access to the web interface" The web interface is accessible via port **10000**: @@ -62,9 +116,5 @@ armbian-config --cmd MAN005 - Username/Password: your system login credentials - - - - -*** + diff --git a/docs/User-Guide_Armbian-Software/Media.md b/docs/User-Guide_Armbian-Software/Media.md index fc074bb9..0293159b 100644 --- a/docs/User-Guide_Armbian-Software/Media.md +++ b/docs/User-Guide_Armbian-Software/Media.md @@ -1,33 +1,36 @@ +--- +comments: true +--- + # Media servers, organizers and editors - -*** - -## Emby organizes video, music, live TV, and photos - - -[![Emby organizes video, music, live TV, and photos](/images/MED003.png)](#) - +## Emby - +Emby organizes video, music, live TV, and photos + + + +[![Emby](/images/EMB001.png)](#) + + + + Emby organizes video, music, live TV, and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone emby Media Server. - - -This operation will install Emby server. - -**Command:** -~~~ -armbian-config --cmd MED003 -~~~ + **Author:** @schwar3kat **Status:** Stable - +~~~ custombash +armbian-config --cmd EMB001 +~~~ + + + === "Access to the web interface" The web interface is accessible via port **8096**: @@ -46,67 +49,48 @@ armbian-config --cmd MED003 docker logs -f emby ``` - + - -*** - -## Emby server remove -This operation will remove Emby server - -**Command:** -~~~ -armbian-config --cmd MED004 +~~~ bash title="Emby server remove:" +armbian-config --cmd EMB002 ~~~ -**Author:** @schwar3kat -**Status:** Stable - - - -*** - -## Emby server purge with data folder -**Command:** -~~~ -armbian-config --cmd MED005 +~~~ bash title="Emby server purge with data folder:" +armbian-config --cmd EMB003 ~~~ -**Author:** @schwar3kat - -**Status:** Stable -*** - -## Stirling PDF tools for viewing and editing PDF files - - -[![Stirling PDF tools for viewing and editing PDF files](/images/MED010.png)](#) - +## Stirling - +Stirling PDF tools for viewing and editing PDF files + + + +[![Stirling](/images/STR001.png)](#) + + + + Stirling-PDF is a robust, locally hosted web-based PDF manipulation tool using Docker. It enables you to carry out various operations on PDF files, including splitting, merging, converting, reorganizing, adding images, rotating, compressing, and more. This locally hosted web application has evolved to encompass a comprehensive set of features, addressing all your PDF requirements. - - -This operation will install Stirling-PDF tools. - -**Command:** -~~~ -armbian-config --cmd MED010 -~~~ + **Author:** @igorpecovnik **Status:** Stable - +~~~ custombash +armbian-config --cmd STR001 +~~~ + + + === "Access to the web interface" The web interface is accessible via port **8077**: @@ -123,145 +107,80 @@ armbian-config --cmd MED010 docker logs -f stirling-pdf ``` - + - -*** - -## Stirling PDF remove -This operation will remove Stirling-PDF tools. - -**Command:** +~~~ bash title="Stirling PDF remove:" +armbian-config --cmd STR002 ~~~ -armbian-config --cmd MED011 + + +~~~ bash title="Stirling PDF purge with data folder:" +armbian-config --cmd STR003 ~~~ + + + +## Syncthing + + +Syncthing continuous file synchronization + + + +[![Syncthing](/images/STC001.png)](#) + + **Author:** @igorpecovnik **Status:** Stable - -*** - -## Stirling PDF purge with data folder -This operation will purge Stirling-PDF tools with data folder. - -**Command:** +~~~ custombash +armbian-config --cmd STC001 ~~~ -armbian-config --cmd MED012 + + +~~~ bash title="Syncthing remove:" +armbian-config --cmd STC002 ~~~ + +~~~ bash title="Syncthing purge with data folder:" +armbian-config --cmd STC003 +~~~ + + + + +## Nextcloud + + +Nextcloud content collaboration platform + + + +[![Nextcloud](/images/NCT001.png)](#) + + + + +Nextcloud gives you access to all your files wherever you are. Where are your photos and documents? With Nextcloud you pick a server of your choice, at home, in a data center or at a provider. And that is where your files will be. Nextcloud runs on that server, protecting your data and giving you access from your desktop or mobile devices. Through Nextcloud you also access, sync and share your existing data on that FTP drive at the office, a Dropbox or a NAS you have at home. + + + **Author:** @igorpecovnik **Status:** Stable - -*** - -## Syncthing continuous file synchronization - - -[![Syncthing continuous file synchronization](/images/MED015.png)](#) - - - - -Syncthing replaces proprietary sync and cloud services with something open, trustworthy and decentralized. Your data is your data alone and you deserve to choose where it is stored, if it is shared with some third party and how it's transmitted over the Internet. - - - -**Command:** -~~~ -armbian-config --cmd MED015 +~~~ custombash +armbian-config --cmd NCT001 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -=== "Access to the web interface" - - The web interface is accessible via port **8884**: - - - URL: `https://:8884` - - Username/Password: There is none, but it is highly suggested setting a password for this container. To do this go to Actions -> Settings -> set user/password for the webUI. - -=== "Directories" - - - Install directory: `/armbian/syncthing` - - Site configuration directory: `/armbian/syncthing/config` - - Data directory: `/armbian/syncthing/data1` `/armbian/syncthing/data2` - -=== "View logs" - - ```sh - docker logs -f syncthing - ``` - - - - - -*** - -## Syncthing remove -**Command:** -~~~ -armbian-config --cmd MED016 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable - - - -*** - -## Syncthing purge with data folder -**Command:** -~~~ -armbian-config --cmd MED017 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable - - - -*** - -## Nextcloud content collaboration platform - - -[![Nextcloud content collaboration platform](/images/MED020.png)](#) - - - - -Nextcloud gives you access to all your files wherever you are. -
-Where are your photos and documents? With Nextcloud you pick a server of your choice, at home, in a data center or at a provider. And that is where your files will be. Nextcloud runs on that server, protecting your data and giving you access from your desktop or mobile devices. Through Nextcloud you also access, sync and share your existing data on that FTP drive at the office, a Dropbox or a NAS you have at home. - - - -**Command:** -~~~ -armbian-config --cmd MED020 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable - - - + === "Access to the web interface" The web interface is accessible via port **443**: @@ -281,86 +200,48 @@ armbian-config --cmd MED020 docker logs -f nextcloud ``` - + - -*** - -## Nextcloud remove -**Command:** -~~~ -armbian-config --cmd MED021 +~~~ bash title="Nextcloud remove:" +armbian-config --cmd NCT002 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -## Nextcloud purge with data folder -**Command:** -~~~ -armbian-config --cmd MED022 +~~~ bash title="Nextcloud purge with data folder:" +armbian-config --cmd NCT003 ~~~ -**Author:** @igorpecovnik - -**Status:** Stable -*** - -## Owncloud share files and folders, easy and secure -**Command:** -~~~ -armbian-config --cmd MED025 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable +## Owncloud - -*** - -## Owncloud remove -**Command:** -~~~ -armbian-config --cmd MED026 -~~~ - -**Author:** @igorpecovnik - -**Status:** Stable +Owncloud share files and folders, easy and secure + +[![Owncloud](/images/OWC001.png)](#) + -*** -## Owncloud purge with data folder - - + ownCloud is a free and open-source software project for content collaboration and sharing and syncing of files in distributed and federated enterprise scenarios. - - -**Command:** -~~~ -armbian-config --cmd MED027 -~~~ + **Author:** @igorpecovnik **Status:** Stable - +~~~ custombash +armbian-config --cmd OWC001 +~~~ + + + === "Access to the web interface" The web interface is accessible via port **7787**: @@ -380,35 +261,48 @@ armbian-config --cmd MED027 docker logs -f owncloud ``` - + + + +~~~ bash title="Owncloud remove:" +armbian-config --cmd OWC002 +~~~ + + +~~~ bash title="Owncloud purge with data folder:" +armbian-config --cmd OWC003 +~~~ -*** -## Jellyfin Media System - - -[![Jellyfin Media System](/images/MED030.png)](#) - +## Jellyfin - +Jellyfin Media System + + + +[![Jellyfin](/images/JMS001.png)](#) + + + + Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. - - -**Command:** -~~~ -armbian-config --cmd MED030 -~~~ + **Author:** @igorpecovnik **Status:** Preview - +~~~ custombash +armbian-config --cmd JMS001 +~~~ + + + === "Access to the web interface" The web interface is accessible via port **8096**: @@ -429,79 +323,55 @@ armbian-config --cmd MED030 docker logs -f jellyfin ``` - + - -*** - -## Jellyfin remove -**Command:** -~~~ -armbian-config --cmd MED031 +~~~ bash title="Jellyfin remove:" +armbian-config --cmd JMS002 ~~~ -**Author:** @igorpecovnik -**Status:** Preview - - - -*** - -## Jellyfin purge with data folder -**Command:** -~~~ -armbian-config --cmd MED032 +~~~ bash title="Jellyfin purge with data folder:" +armbian-config --cmd JMS003 ~~~ -**Author:** @igorpecovnik - -**Status:** Preview -*** +## Hastebin -## Hastebin Paste Server -**Command:** -~~~ -armbian-config --cmd MED033 -~~~ + +Hastebin Paste Server + + + +[![Hastebin](/images/HPS001.png)](#) + + + + +Hastebin is a fast and simple self-hosted pastebin server. It allows users to quickly share text snippets like logs, code, or notes via a web interface or API. Hastebin is lightweight, easy to deploy with Docker, and ideal for teams needing private, temporary paste storage. + + **Author:** @efectn **Status:** Stable - -*** - -## Hastebin remove -**Command:** -~~~ -armbian-config --cmd MED034 +~~~ custombash +armbian-config --cmd HPS001 ~~~ -**Author:** @efectn -**Status:** Stable - - - -*** - -## Hastebin purge with data folder -**Command:** -~~~ -armbian-config --cmd MED035 +~~~ bash title="Hastebin remove:" +armbian-config --cmd HPS002 ~~~ -**Author:** @efectn -**Status:** Stable +~~~ bash title="Hastebin purge with data folder:" +armbian-config --cmd HPS003 +~~~ -*** - diff --git a/docs/User-Guide_Armbian-Software/Monitoring.md b/docs/User-Guide_Armbian-Software/Monitoring.md index 0a3838ae..8f2c5e08 100644 --- a/docs/User-Guide_Armbian-Software/Monitoring.md +++ b/docs/User-Guide_Armbian-Software/Monitoring.md @@ -1,27 +1,39 @@ +--- +comments: true +--- + # Real-time monitoring, collecting metrics, up-time status +## Uptime Kuma -*** -## Uptime Kuma self-hosted monitoring tool +Uptime Kuma self-hosted monitoring tool - -[![Uptime Kuma self-hosted monitoring tool](/images/MON001.webp)](#) - -This operation will install Uptime Kuma + +[![Uptime Kuma](/images/UPK001.png)](#) + -**Command:** -~~~ -armbian-config --cmd MON001 -~~~ + + +[Uptime Kuma](https://github.com/louislam/uptime-kuma) is a self-hosted monitoring tool similar to \"Uptime Robot\". +It provides a beautiful, easy-to-use web dashboard to monitor HTTP(s), TCP, Ping, and more types of services. + +You can receive instant notifications when a service goes down via Telegram, Discord, Slack, email, and many other integrations. + + **Author:** @igorpecovnik **Status:** Stable - +~~~ custombash +armbian-config --cmd UPK001 +~~~ + + + === "Access to the web interface" The web interface is accessible via port **3001**: @@ -29,7 +41,7 @@ armbian-config --cmd MON001 - URL: `https://:3001` - Username/Password: Are set at first web interface login -???+ "Uptime Kuma features" +=== "Features" - Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / HTTP(s) Json Query / Ping / DNS Record / Push / Steam Game Server / Docker Containers - Fancy, Reactive, Fast UI/UX @@ -43,107 +55,67 @@ armbian-config --cmd MON001 - Proxy support - 2FA support - + - -*** - -## Uptime Kuma remove -This operation will remove Uptime Kuma - -**Command:** -~~~ -armbian-config --cmd MON002 +~~~ bash title="Uptime Kuma remove:" +armbian-config --cmd UPK002 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -## Uptime Kuma purge with data folder -This operation will remove Uptime Kuma with data folder - -**Command:** -~~~ -armbian-config --cmd MON003 +~~~ bash title="Uptime Kuma purge with data folder:" +armbian-config --cmd UPK003 ~~~ -**Author:** @igorpecovnik - -**Status:** Stable -*** - -## Netdata - monitoring real-time metrics - - -[![Netdata - monitoring real-time metrics](/images/MON005.png)](#) - +## Netdata - +Netdata - monitoring real-time metrics + + + +[![Netdata](/images/NTD001.png)](#) + + + + Netdata is a partially open source tool designed to collect real-time metrics, such as CPU usage, disk activity, bandwidth usage, website visits, etc., and then display them in live, easy-to-interpret charts. - - -This operation will install Netdata - -**Command:** -~~~ -armbian-config --cmd MON005 -~~~ + **Author:** @igorpecovnik **Status:** Stable - -*** - -## Netdata remove -This operation will remove Netdata - -**Command:** -~~~ -armbian-config --cmd MON006 +~~~ custombash +armbian-config --cmd NTD001 ~~~ -**Author:** @igorpecovnik -**Status:** Stable - - - -*** - -## Netdata purge with data folder -This operation will purge Netdata with data folder - -**Command:** -~~~ -armbian-config --cmd MON007 +~~~ bash title="Netdata remove:" +armbian-config --cmd NTD002 ~~~ -**Author:** @igorpecovnik -**Status:** Stable +~~~ bash title="Netdata purge with data folder:" +armbian-config --cmd NTD003 +~~~ -*** -## Grafana data analytics +## Grafana + + +Grafana data analytics + -[![Grafana data analytics](/images/GRA001.png)](#) +[![Grafana](/images/GRA001.png)](#) @@ -151,16 +123,16 @@ armbian-config --cmd MON007 Grafana is a multi-platform open source analytics and interactive visualization web application. It can produce charts, graphs, and alerts for the web when connected to supported data sources. -**Command:** -~~~ -armbian-config --cmd GRA001 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd GRA001 +~~~ + + === "Access to the web interface" @@ -181,43 +153,26 @@ armbian-config --cmd GRA001 - -*** - -## Grafana remove -**Command:** -~~~ +~~~ bash title="Grafana remove:" armbian-config --cmd GRA002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Grafana purge with data folder -This operation will purge Grafana with data folder - -**Command:** -~~~ +~~~ bash title="Grafana purge with data folder:" armbian-config --cmd GRA003 ~~~ -**Author:** @igorpecovnik - -**Status:** Stable -*** +## Prometheus + + +Prometheus docker image -## Prometheus docker image -[![Prometheus docker image](/images/PRO001.png)](#) +[![Prometheus](/images/PRO001.png)](#) @@ -226,16 +181,16 @@ Prometheus is an open-source monitoring and alerting toolkit designed for reliab -**Command:** -~~~ -armbian-config --cmd PRO001 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd PRO001 +~~~ + + === "Access to the web interface" @@ -256,36 +211,14 @@ armbian-config --cmd PRO001 - -*** - -## Prometheus remove -**Command:** -~~~ +~~~ bash title="Prometheus remove:" armbian-config --cmd PRO002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Prometheus purge with data folder -This operation will purge Prometheus with data folder - -**Command:** -~~~ +~~~ bash title="Prometheus purge with data folder:" armbian-config --cmd PRO003 ~~~ -**Author:** @armbian - -**Status:** Stable - -*** - diff --git a/docs/User-Guide_Armbian-Software/Music.md b/docs/User-Guide_Armbian-Software/Music.md index fd2c4074..767c3d3c 100644 --- a/docs/User-Guide_Armbian-Software/Music.md +++ b/docs/User-Guide_Armbian-Software/Music.md @@ -1,52 +1,37 @@ +--- +comments: true +--- + # Music servers and streamers +## Navidrome -*** -## Navidrome music server and streamer compatible with Subsonic/Airsonic +Navidrome music server and streamer compatible with Subsonic/Airsonic + -[![Navidrome music server and streamer compatible with Subsonic/Airsonic](/images/NAV001.png)](#) +[![Navidrome](/images/NAV001.png)](#) -**Command:** -~~~ +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash armbian-config --cmd NAV001 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Navidrome remove -**Command:** -~~~ +~~~ bash title="Navidrome remove:" armbian-config --cmd NAV002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## Navidrome purge with data folder -**Command:** -~~~ +~~~ bash title="Navidrome purge with data folder:" armbian-config --cmd NAV003 ~~~ -**Author:** @armbian - -**Status:** Stable - -*** - diff --git a/docs/User-Guide_Armbian-Software/Netconfig.md b/docs/User-Guide_Armbian-Software/Netconfig.md index 4a0b6209..7da342b8 100644 --- a/docs/User-Guide_Armbian-Software/Netconfig.md +++ b/docs/User-Guide_Armbian-Software/Netconfig.md @@ -1,127 +1,89 @@ +--- +comments: true +--- + # Console network tools for measuring load and bandwidth +## nload -*** -## nload -realtime console network usage monitor - - -[![nload -realtime console network usage monitor](/images/NET001.png)](#) - - -**Command:** -~~~ -armbian-config --cmd NET001 -~~~ +nload - realtime console network usage monitor **Author:** @armbian **Status:** Stable - -*** - -## nload - remove -**Command:** +~~~ custombash +armbian-config --cmd NLD001 ~~~ -armbian-config --cmd NET002 + + +~~~ bash title="nload - remove:" +armbian-config --cmd NLD002 ~~~ + + +## iperf3 + + +iperf3 bandwidth measuring tool + **Author:** @armbian **Status:** Stable - -*** - -## iperf3 bandwidth measuring tool - - -[![iperf3 bandwidth measuring tool](/images/NET003.png)](#) - - -**Command:** +~~~ custombash +armbian-config --cmd IPR001 ~~~ -armbian-config --cmd NET003 + + +~~~ bash title="iperf3 remove:" +armbian-config --cmd IPR002 ~~~ + + +## iptraf-ng + + +iptraf-ng IP LAN monitor + **Author:** @armbian **Status:** Stable - -*** - -## iperf3 remove -**Command:** +~~~ custombash +armbian-config --cmd IPT001 ~~~ -armbian-config --cmd NET004 + + +~~~ bash title="iptraf-ng remove:" +armbian-config --cmd IPT002 ~~~ + + +## avahi-daemon + + +avahi-daemon hostname broadcast via mDNS + **Author:** @armbian **Status:** Stable - -*** - -## iptraf-ng IP LAN monitor -**Command:** -~~~ -armbian-config --cmd NET005 +~~~ custombash +armbian-config --cmd AVH001 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## iptraf-ng remove -**Command:** -~~~ -armbian-config --cmd NET006 +~~~ bash title="avahi-daemon remove:" +armbian-config --cmd AVH002 ~~~ -**Author:** @armbian - -**Status:** Stable - - - -*** - -## avahi-daemon hostname broadcast via mDNS -**Command:** -~~~ -armbian-config --cmd NET007 -~~~ - -**Author:** @armbian - -**Status:** Stable - - - -*** - -## avahi-daemon remove -**Command:** -~~~ -armbian-config --cmd NET008 -~~~ - -**Author:** @armbian - -**Status:** Stable - - - -*** diff --git a/docs/User-Guide_Armbian-Software/Printing.md b/docs/User-Guide_Armbian-Software/Printing.md index 50aa1414..fedf7d53 100644 --- a/docs/User-Guide_Armbian-Software/Printing.md +++ b/docs/User-Guide_Armbian-Software/Printing.md @@ -1,12 +1,17 @@ +--- +comments: true +--- + # Tools for printing and 3D printing +## OctoPrint -*** -## OctoPrint web-based 3D printers management tool +OctoPrint web-based 3D printers management tool + -[![OctoPrint web-based 3D printers management tool](/images/OCT001.png)](#) +[![OctoPrint](/images/OCT001.png)](#) @@ -14,18 +19,16 @@ OctoPrint is an open source 3D printer controller application, which provides a web interface for the connected printers. It displays printers status and key parameters and allows user to schedule prints and remotely control the printer. -This operation will install OctoPrint - -**Command:** -~~~ -armbian-config --cmd OCT001 -~~~ - **Author:** @armbian **Status:** Stable +~~~ custombash +armbian-config --cmd OCT001 +~~~ + + === "Access to the web interface" @@ -46,38 +49,14 @@ armbian-config --cmd OCT001 - -*** - -## OctoPrint remove -This operation will remove OctoPrint - -**Command:** -~~~ +~~~ bash title="OctoPrint remove:" armbian-config --cmd OCT002 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## OctoPrint purge with data folder -This operation will purge OctoPrint with data folder - -**Command:** -~~~ +~~~ bash title="OctoPrint purge with data folder:" armbian-config --cmd OCT003 ~~~ -**Author:** @armbian - -**Status:** Stable - -*** - diff --git a/docs/User-Guide_Armbian-Software/Software.md b/docs/User-Guide_Armbian-Software/Software.md new file mode 100644 index 00000000..a8dcfa0d --- /dev/null +++ b/docs/User-Guide_Armbian-Software/Software.md @@ -0,0 +1,2336 @@ +--- +comments: true +--- + +# Run/Install 3rd party applications + +## Web server, LEMP, reverse proxy, Let's Encrypt SSL + +#### SWAG + + +SWAG reverse proxy + + + +[![SWAG](/images/SWAG01.png)](#) + + + + +SWAG - Secure Web Application Gateway sets up an Nginx webserver and reverse proxy with php support and a built-in certbot client that automates free SSL server certificate generation and renewal processes (Let's Encrypt). It also contains fail2ban for intrusion prevention. + +After entering required information, your server will have auto updating SSL secured website! To this website you can attach several services, for example: https://my.server.com/netdata will run [Netdata](https://www.netdata.cloud/) instance. + +=== "Requirements" + + - this computer port 80 and 443 must be open to the internet + - your domain name (myserver.mydomain.com) DNS server should point to your router WAN address + - make sure to set additional .htpasswd username and password as you don't want to expose your services without password + +=== "Directories" + + - Config directory: `/armbian/swag/config/` + - Website root folder: `/armbian/swag/config/www/` + - Reverse proxy configuration samples: `/armbian/swag/config/nginx/proxy-confs/` + +=== "Advanced setup" + + - Please follow this comprehensive guide: + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd SWAG01 +~~~ + + +~~~ bash title="SWAG reverse proxy .htpasswd set:" +armbian-config --cmd SWAG02 +~~~ + + +~~~ bash title="SWAG remove:" +armbian-config --cmd SWAG03 +~~~ + + +~~~ bash title="SWAG purge with data folder:" +armbian-config --cmd SWAG04 +~~~ + + + + + +## Home Automation for control home appliances + +#### openHAB + + +openHAB empowering the smart home + + + +[![openHAB](/images/HAB001.png)](#) + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd HAB001 +~~~ + + +~~~ bash title="openHAB remove:" +armbian-config --cmd HAB002 +~~~ + + +~~~ bash title="openHAB purge with data folder:" +armbian-config --cmd HAB003 +~~~ + + + + +#### Home Assistant + + +Home Assistant open source home automation + + + +[![Home Assistant](/images/HAS001.png)](#) + + + + +Home Assistant is an open source smart home platform that allows you to connect your smart home devices like your TV, fan, cameras, thermostats, lights, and sensors. As a user, you can build intricate automation using Home Assistant's user-friendly, unified web-based user interface. + +Perfect to run on any single board computer with 4 cores and at least 512Mb of memory. Armbian installation is optimised to run from SD/eMMC media, but it is recommended to use SSD. + + + +**Author:** @igorpecovnik + +**Status:** Preview + + +~~~ custombash +armbian-config --cmd HAS001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **8123**: + + - URL: `https://:8123` + - Username/Password: Are set at first web interface login + +=== "Directories" + + Home Assistant on Armbian runs supervised in a Docker container. This secures same functionality as stock HAOS. + + - Config directory: `/armbian/haos` + +=== "Armbian advantages" + + |Functionality|HAOS|Armbian with HA| + |:--|:--:|:--:| + |Automations|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| + |Dashboards|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| + |Integrations|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| + |Add-ons|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| + |One-click updates|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| + |Backups|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| + |General purpose server|:x:|:white_check_mark:| + |Running on exotic hardware|:x:|:white_check_mark:| + + + + +~~~ bash title="Home Assistant remove:" +armbian-config --cmd HAS002 +~~~ + + +~~~ bash title="Home Assistant purge with data folder:" +armbian-config --cmd HAS003 +~~~ + + + + +#### Domoticz + + +Domoticz open source home automation + + + +[![Domoticz](/images/DOM001.png)](#) + + + + +Domoticz is an open-source home automation platform that allows you to control and monitor smart devices in your home. It supports a wide range of devices, including lights, sensors, thermostats, and cameras. Through its web interface or mobile app, you can set up automation rules and schedules, providing greater convenience and energy efficiency. It’s customizable, flexible, and can be run on a variety of hardware platforms supported by Armbian. + +=== "Access to the web interface" + + The web interface is accessible via port **8080**: + + - URL: `https://:8080` + - Username/Password: admin / domoticz + +=== "Directories" + + - Config directory: `/armbian/domoticz` + +=== "Advanced setup" + + - Primary USB device passing through (`/dev/ttyUSB0`) to Docker container is enabled by default + - For more complex setup, please follow this comprehensive guide: + + + +**Author:** @igorpecovnik + +**Status:** Preview + + +~~~ custombash +armbian-config --cmd DOM001 +~~~ + + +~~~ bash title="Domoticz remove:" +armbian-config --cmd DOM002 +~~~ + + +~~~ bash title="Domoticz purge with data folder:" +armbian-config --cmd DOM003 +~~~ + + + + +#### EVCC + + +EVCC - solar charging automation + + + +[![EVCC](/images/EVCC01.png)](#) + + + + +evcc is an energy management system with a focus on electromobility. The software controls your EV charger or smart plug. It communicates with your vehicle, inverter or home storage to make intelligent charging decisions. The software is open source and community-driven. + + + +**Author:** @igorpecovnik + +**Status:** Preview + + +~~~ custombash +armbian-config --cmd EVCC01 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **7070**: + + - URL: `https://:7070` + - Admin password is generated at first web interface login + +=== "Directories" + + - Install directory: `/armbian/evcc` + - Site configuration directory: `/armbian/evcc/evcc.yaml` + +=== "View logs" + + ```sh + docker logs -f evcc + ``` + + + + +~~~ bash title="EVCC - solar charging automation remove:" +armbian-config --cmd EVCC02 +~~~ + + +~~~ bash title="EVCC purge with data folder:" +armbian-config --cmd EVCC03 +~~~ + + + + +## Network-wide ad blockers servers + +#### Pi-hole + + +Pi-hole DNS ad blocker + + + +[![Pi-hole](/images/PIH001.png)](#) + + + + +Pi-hole is a network-wide ad blocker that acts as a DNS (Domain Name System) sinkhole. It works by blocking requests to known ad servers, trackers, and malicious websites across all devices connected to your home network. Here's how it works: + +- DNS-Based Filtering: Pi-hole intercepts DNS requests from devices on your network. When a device tries to connect to a website, Pi-hole checks if the website's domain is on a blocklist. If it is, Pi-hole prevents the connection from being made, effectively blocking ads, trackers, and potentially harmful sites. + +- Customizable Blocklists: Pi-hole allows you to choose from a variety of community-maintained blocklists or even add your own. These blocklists contain domains known to serve ads, trackers, and other unwanted content. + +- Device and Network-Level Protection: Once set up, Pi-hole works across your entire network. This means all devices (smartphones, tablets, computers, smart TVs, etc.) that use your Pi-hole as their DNS server automatically benefit from ad-blocking without needing individual apps or browser extensions. + +- Web Interface: Pi-hole offers an intuitive web interface where you can monitor statistics, review blocked domains, and tweak settings like adding custom blocklists or whitelisting certain sites. + +- Privacy and Speed: By blocking unwanted content at the DNS level, Pi-hole not only improves browsing speed (since ads are not loaded), but also enhances privacy by preventing tracking scripts from running in the background. + +Pi-hole is typically installed on a Armbian minimal, but it can also run on other systems. It's a great way to have ad-blocking and privacy protection across your entire network without needing to install anything on individual devices. + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd PIH001 +~~~ + + + +=== "Access the web interface" + + The web interface of Pi-hole can be accessed via: + + - URL = `http:///admin` + - Password is set and adjust from `armbian-config` + +=== "Documentation" + + + + + + +~~~ bash title="Pi-hole remove:" +armbian-config --cmd PIH003 +~~~ + + +~~~ bash title="Pi-hole change web admin password:" +armbian-config --cmd PIH002 +~~~ + + +~~~ bash title="Pi-hole purge with data folder:" +armbian-config --cmd PIH004 +~~~ + + + + + +#### Unbound + + +Unbound caching DNS resolver + + + +[![Unbound](/images/UNB001.png)](#) + + + + +Unbound is a high-performance, open-source DNS resolver. It primarily serves to resolve domain names into IP addresses for devices on a network. Unlike regular DNS servers, Unbound performs DNS lookups directly and securely, providing features like DNSSEC validation (ensuring data integrity) and privacy protections. It's often used to improve speed, security, and privacy by resolving queries locally rather than relying on external DNS services. + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd UNB001 +~~~ + + + +=== "Default DNS port" + + - Default DNS port: 53 + +=== "Directories" + + - Install directory: `/armbian/unbound/` + - Configuration directory: `/armbian/unbound/` + +=== "View logs" + + ```sh + docker logs -f unbound + ``` + + + + +~~~ bash title="Unbound remove:" +armbian-config --cmd UNB002 +~~~ + + +~~~ bash title="Unbound purge with data folder:" +armbian-config --cmd UNB003 +~~~ + + + + +#### AdGuardHome + + +AdGuardHome DNS sinkhole + + + +[![AdGuardHome](/images/ADG001.png)](#) + + + + +AdGuard Home is a network-wide software that functions as a DNS server and ad blocker. It blocks ads, trackers, and malicious websites at the DNS level, meaning it filters content for all devices connected to the network. It also provides additional features like parental controls, logging, and privacy protections. Essentially, it acts as a gateway between your devices and the internet, blocking unwanted content before it even reaches your devices. + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd ADG001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **3000**: + + - URL: `https://:3000` + - Username/Password: admin / generate at first web interface login + +=== "Directories" + + - Install directory: `/armbian/adguardhome/` + - Configuration directory: `/armbian/adguardhome/confdir` + - Work directory: `/armbian/adguardhome/workdir` + +=== "Usage" + + - server where you are installing is automatically switched to this DNS + - on your desktop PC set IP address of this server as DNS + - network wide: set IP address of this server on routers DNS + +=== "Black and white lists" + + There are many sites in the web giving blocklists and whitelists for AdGuard Home. They can be used when you want to have more blocking as the standard installation gives you. Here are some examples: + + - [The Big Blocklist Collection by WaLLy3K](https://firebog.net/) + - [Phishing Army blocklist](https://phishing.army/) + - [Whitelist collection by anudeepND](https://github.com/anudeepND/whitelist) + +=== "View logs" + + ```sh + docker logs -f adguardhome + ``` + + + + +~~~ bash title="AdGuardHome remove:" +armbian-config --cmd ADG002 +~~~ + + +~~~ bash title="AdGuardHome purge with data folder:" +armbian-config --cmd ADG003 +~~~ + + + + +## Music servers and streamers + +#### Navidrome + + +Navidrome music server and streamer compatible with Subsonic/Airsonic + + + +[![Navidrome](/images/NAV001.png)](#) + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd NAV001 +~~~ + + +~~~ bash title="Navidrome remove:" +armbian-config --cmd NAV002 +~~~ + + +~~~ bash title="Navidrome purge with data folder:" +armbian-config --cmd NAV003 +~~~ + + + + +## Download apps for movies, TV shows, music and subtitles + +#### qBittorrent + + +qBittorrent BitTorrent client + + + +[![qBittorrent](/images/DOW001.png)](#) + + + + +The Qbittorrent⁠ project aims to provide an open-source software alternative to µTorrent. qBittorrent is based on the Qt toolkit and libtorrent-rasterbar library. + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd DOW001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **8090**: + + - URL: `https://:8090` + - Username/Password: admin / generate at first web interface login + +=== "Directories" + + - Install directory: `/armbian/qbittorrent` + - Site configuration directory: `/armbian/qbittorrent/config` + - Download directory: `/armbian/qbittorrent/downloads` + +=== "View logs" + + ```sh + docker logs -f qbittorrent + ``` + + + + +~~~ bash title="qBittorrent remove:" +armbian-config --cmd DOW002 +~~~ + + +~~~ bash title="qBittorrent purge with data folder:" +armbian-config --cmd DOW003 +~~~ + + +~~~ bash title="Prowlarr:" +armbian-config --cmd DOW025 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **9696**: + + - URL: `https://:9696` + - Username/Password: admin / generate at first web interface login + +=== "Directories" + + - Install directory: `/armbian/prowlarr` + - Site configuration directory: `/armbian/prowlarr/config` + +=== "View logs" + + ```sh + docker logs -f prowlarr + ``` + + + + +~~~ bash title="Prowlarr remove:" +armbian-config --cmd DOW026 +~~~ + + +~~~ bash title="Prowlarr purge with data folder:" +armbian-config --cmd DOW027 +~~~ + + + + + + + +#### Deluge + + +Deluge BitTorrent client + + + +[![Deluge](/images/DEL001.png)](#) + + + + +Deluge⁠ is a lightweight, Free Software, cross-platform BitTorrent client. + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd DEL001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **8112**: + + - URL: `https://:8112` + - Username/Password: default user/password of admin/deluge + +=== "Directories" + + - Install directory: `/armbian/deluge` + - Site configuration directory: `/armbian/deluge/config` + - Download directory: `/armbian/deluge/downloads` + +=== "View logs" + + ```sh + docker logs -f deluge + ``` + + + + +~~~ bash title="Deluge remove:" +armbian-config --cmd DEL002 +~~~ + + +~~~ bash title="Deluge purge with data folder:" +armbian-config --cmd DEL003 +~~~ + + + + +#### Transmission + + +Transmission BitTorrent client + + + +[![Transmission](/images/TRA001.png)](#) + + + + +Transmission⁠ is designed for easy, powerful use. Transmission has the features you want from a BitTorrent client: encryption, a web interface, peer exchange, magnet links, DHT, µTP, UPnP and NAT-PMP port forwarding, webseed support, watch directories, tracker editing, global and per-torrent speed limits, and more. + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd TRA001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **9091**: + + - URL: `https://:9091` + - Username/Password: admin / generate at first web interface login + +=== "Directories" + + - Install directory: `/armbian/transmission` + - Site configuration directory: `/armbian/transmission/config` + - Download directory: `/armbian/transmission/downloads` + - Watch directory: `/armbian/transmission/watch` + +=== "View logs" + + ```sh + docker logs -f transmission + ``` + + + + +~~~ bash title="Transmission remove:" +armbian-config --cmd TRA002 +~~~ + + +~~~ bash title="Transmission purge with data folder:" +armbian-config --cmd TRA003 +~~~ + + + + +#### SABnzbd + + +SABnzbd newsgroup downloader + + + +[![SABnzbd](/images/SABN01.png)](#) + + + + +Sabnzbd⁠ makes Usenet as simple and streamlined as possible by automating everything we can. All you have to do is add an .nzb. SABnzbd takes over from there, where it will be automatically downloaded, verified, repaired, extracted and filed away with zero human interaction. + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd SABN01 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **8080**: + + - URL: `https://:8080` + - Username/Password: admin / generate at first web interface login + +=== "Directories" + + - Install directory: `/armbian/sabnzbd` + - Site configuration directory: `/armbian/sabnzbd/config` + - Download directory: `/armbian/sabnzbd/downloads` + - Incomplete downloads: `/armbian/sabnzbd/incomplete` + +=== "View logs" + + ```sh + docker logs -f sabnzbd + ``` + + + + +~~~ bash title="SABnzbd remove:" +armbian-config --cmd SABN02 +~~~ + + +~~~ bash title="SABnzbd purge with data folder:" +armbian-config --cmd SABN03 +~~~ + + + + +#### Medusa + + +Medusa automatic downloader for TV shows + + + +Medusa is an automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic. + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd MDS001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **8081**: + + - URL: `https://:8081` + +=== "Directories" + + - Install directory: `/armbian/medusa` + - Site configuration directory: `/armbian/medusa/config` + - Download directory: `/armbian/medusa/downloads` + - Download directory TV shows: `/armbian/medusa/downloads/tv` + +=== "View logs" + + ```sh + docker logs -f medusa + ``` + + + + +~~~ bash title="Medusa TV shows downloader remove:" +armbian-config --cmd MDS002 +~~~ + + +~~~ bash title="Medusa TV shows downloader purge:" +armbian-config --cmd MDS003 +~~~ + + + + +#### Sonarr + + +Sonarr automatic downloader for TV shows + + + +[![Sonarr](/images/SON001.png)](#) + + + + +Sonarr (formerly NZBdrone) is a PVR for usenet and bittorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available. + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd SON001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **8989**: + + - URL: `https://:8989` + +=== "Directories" + + - Install directory: `/armbian/sonarr` + - Site configuration directory: `/armbian/sonarr/config` + - Download directory: `/armbian/sonarr/tvseries` + - Client download directory: `/armbian/sonarr/client` + +=== "View logs" + + ```sh + docker logs -f sonarr + ``` + + + + +~~~ bash title="Sonarr remove:" +armbian-config --cmd SON002 +~~~ + + +~~~ bash title="Sonarr purge with data folder:" +armbian-config --cmd SON003 +~~~ + + + + +#### Radarr + + +Radarr automatic downloader for movies + + + +[![Radarr](/images/RAD001.png)](#) + + + + +Radarr - A fork of Sonarr to work with movies à la Couchpotato. + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd RAD001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **7878**: + + - URL: `https://:7878` + - Username/Password: admin / generate at first web interface login + +=== "Directories" + + - Install directory: `/armbian/radarr` + - Site configuration directory: `/armbian/radarr/config` + - Download directory: `/armbian/radarr/movies` + - Client download directory: `/armbian/radarr/client` + +=== "View logs" + + ```sh + docker logs -f radarr + ``` + + + + +~~~ bash title="Radarr remove:" +armbian-config --cmd RAD002 +~~~ + + +~~~ bash title="Radarr purge with data folder:" +armbian-config --cmd RAD003 +~~~ + + + + +#### Bazarr + + +Bazarr automatic subtitles downloader for Sonarr and Radarr + + + +[![Bazarr](/images/BAZ001.png)](#) + + + + +Bazarr is a companion application to Sonarr and Radarr. It can manage and download subtitles based on your requirements. You define your preferences by TV show or movie and Bazarr takes care of everything for you. + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd BAZ001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **6767**: + + - URL: `https://:6767` + - Username/Password: admin / generate at first web interface login + +=== "Directories" + + - Install directory: `/armbian/bazarr` + - Site configuration directory: `/armbian/bazarr/config` + - Download directory: `/armbian/bazarr/movies` `/armbian/bazarr/tv` + +=== "View logs" + + ```sh + docker logs -f bazarr + ``` + + + + +~~~ bash title="Bazarr remove:" +armbian-config --cmd BAZ002 +~~~ + + +~~~ bash title="Bazarr purge with data folder:" +armbian-config --cmd BAZ003 +~~~ + + + + +#### Lidarr + + +Lidarr automatic music downloader + + + +[![Lidarr](/images/LID001.png)](#) + + + + +Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available. + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd LID001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **8686**: + + - URL: `https://:8686` + - Username/Password: admin / generate at first web interface login + +=== "Directories" + + - Install directory: `/armbian/lidarr` + - Site configuration directory: `/armbian/lidarr/config` + - Download directory: `/armbian/lidarr/downloads` `/armbian/lidarr/music` + +=== "View logs" + + ```sh + docker logs -f lidarr + ``` + + + + +~~~ bash title="Lidarr remove:" +armbian-config --cmd LID002 +~~~ + + +~~~ bash title="Lidarr purge with data folder:" +armbian-config --cmd LID003 +~~~ + + + + +#### Readarr + + +Readarr automatic downloader for Ebooks + + + +[![Readarr](/images/RDR001.png)](#) + + + + +Readarr - Book Manager and Automation (Sonarr for Ebooks) + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd RDR001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **8787**: + + - URL: `https://:8787` + - Username/Password: admin / generate at first web interface login + +=== "Directories" + + - Install directory: `/armbian/readarr` + - Site configuration directory: `/armbian/readarr/config` + - Download directory: `/armbian/readarr/books` `/armbian/readarr/client` + +=== "View logs" + + ```sh + docker logs -f readarr + ``` + + + + +~~~ bash title="Readarr remove:" +armbian-config --cmd RDR002 +~~~ + + +~~~ bash title="Readarr purge with data folder:" +armbian-config --cmd RDR003 +~~~ + + + + +#### Jellyseerr + + +Jellyseerr Jellyfin/Emby/Plex integration install + + + +[![Jellyseerr](/images/JEL001.png)](#) + + + + +Jellyseerr is a free and open source software application for managing requests for your media library. It is a fork of Overseerr built to bring support for Jellyfin & Emby media servers! + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd JEL001 +~~~ + + +~~~ bash title="Jellyseerr remove:" +armbian-config --cmd JEL002 +~~~ + + +~~~ bash title="Jellyseerr purge with data folder:" +armbian-config --cmd JEL003 +~~~ + + + + +## SQL database servers and web interface managers + +#### Mariadb + + +Mariadb SQL database server + + + +[![Mariadb](/images/DAT001.png)](#) + + + + +Mariadb is one of the most popular database servers. Made by the original developers of MySQL. + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd DAT001 +~~~ + + + +=== "Configuration" + + Database access configuration is done at first install: + - create root password + - create database + - create normal user + - create password for normal user + + - Database host: `` + +=== "Directories" + + - Install directory: `/armbian/mariadb` + - Site configuration directory: `/armbian/mariadb/config` + +=== "View logs" + + ```sh + docker logs -f mariadb + ``` + + + + +~~~ bash title="Mariadb remove:" +armbian-config --cmd DAT002 +~~~ + + +~~~ bash title="Mariadb purge with data folder:" +armbian-config --cmd DAT003 +~~~ + + + + +#### phpMyAdmin + + +phpMyAdmin web interface manager + + + +[![phpMyAdmin](/images/MYA001.png)](#) + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd MYA001 +~~~ + + +~~~ bash title="phpMyAdmin remove:" +armbian-config --cmd MYA002 +~~~ + + +~~~ bash title="phpMyAdmin purge with data folder:" +armbian-config --cmd MYA003 +~~~ + + + + +## Applications and tools for development + +#### Git CLI + + +Install tools for cloning and managing repositories (git) + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd GIT001 +~~~ + + +~~~ bash title="Remove tools for cloning and managing repositories (git):" +armbian-config --cmd GIT002 +~~~ + + + +#### Armbian CDN router + + +Armbian router for repository mirror automation + +**Author:** @efectn + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd ART001 +~~~ + + +~~~ bash title="Remove Armbian router:" +armbian-config --cmd ART002 +~~~ + + + +#### Armbian rsyncd server + +**Author:** @igorpecovnik + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd RSD001 +~~~ + + +~~~ bash title="Remove Armbian rsyncd server:" +armbian-config --cmd RSD002 +~~~ + + + +## Docker containerization and KVM virtual machines + +#### Docker + + +Docker minimal + + + +[![Docker](/images/CON001.webp)](#) + + +**Author:** @schwar3kat + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd CON001 +~~~ + + + +What is Docker? Docker helps developers build, share, run, and verify applications anywhere - without tedious environment configuration or management. + + + + +~~~ bash title="Docker engine:" +armbian-config --cmd CON002 +~~~ + + +~~~ bash title="Docker remove:" +armbian-config --cmd CON003 +~~~ + + +~~~ bash title="Docker purge with all images, containers, and volumes:" +armbian-config --cmd CON004 +~~~ + + + + + +#### Portainer + + +Portainer container management platform + + + +[![Portainer](/images/POR001.webp)](#) + + + + +Portainer simplifies your Docker container management via Portainer web interface. It enables faster deploy of the applications and it gives real time visibility. + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd POR001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **9002**: + + - URL = `http://:9002` + + + + +~~~ bash title="Portainer remove:" +armbian-config --cmd POR002 +~~~ + + +~~~ bash title="Portainer purge with with data folder:" +armbian-config --cmd POR003 +~~~ + + + + +## Media servers, organizers and editors + +#### Emby + + +Emby organizes video, music, live TV, and photos + + + +[![Emby](/images/EMB001.png)](#) + + + + +Emby organizes video, music, live TV, and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone emby Media Server. + + + +**Author:** @schwar3kat + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd EMB001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **8096**: + + - URL: `https://:8096` + +=== "Directories" + + - Install directory: `/armbian/emby` + - Site configuration directory: `/armbian/emby/config` + - Data directory: `/armbian/emby/tvshows` `/armbian/emby/movies` + +=== "View logs" + + ```sh + docker logs -f emby + ``` + + + + +~~~ bash title="Emby server remove:" +armbian-config --cmd EMB002 +~~~ + + +~~~ bash title="Emby server purge with data folder:" +armbian-config --cmd EMB003 +~~~ + + + + +#### Stirling + + +Stirling PDF tools for viewing and editing PDF files + + + +[![Stirling](/images/STR001.png)](#) + + + + +Stirling-PDF is a robust, locally hosted web-based PDF manipulation tool using Docker. It enables you to carry out various operations on PDF files, including splitting, merging, converting, reorganizing, adding images, rotating, compressing, and more. This locally hosted web application has evolved to encompass a comprehensive set of features, addressing all your PDF requirements. + + + +**Author:** @igorpecovnik + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd STR001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **8077**: + + - URL: `https://:8077` + +=== "Directories" + + - Install directory: `/armbian/stirling` + +=== "View logs" + + ```sh + docker logs -f stirling-pdf + ``` + + + + +~~~ bash title="Stirling PDF remove:" +armbian-config --cmd STR002 +~~~ + + +~~~ bash title="Stirling PDF purge with data folder:" +armbian-config --cmd STR003 +~~~ + + + + +#### Syncthing + + +Syncthing continuous file synchronization + + + +[![Syncthing](/images/STC001.png)](#) + + +**Author:** @igorpecovnik + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd STC001 +~~~ + + +~~~ bash title="Syncthing remove:" +armbian-config --cmd STC002 +~~~ + + +~~~ bash title="Syncthing purge with data folder:" +armbian-config --cmd STC003 +~~~ + + + + +#### Nextcloud + + +Nextcloud content collaboration platform + + + +[![Nextcloud](/images/NCT001.png)](#) + + + + +Nextcloud gives you access to all your files wherever you are. Where are your photos and documents? With Nextcloud you pick a server of your choice, at home, in a data center or at a provider. And that is where your files will be. Nextcloud runs on that server, protecting your data and giving you access from your desktop or mobile devices. Through Nextcloud you also access, sync and share your existing data on that FTP drive at the office, a Dropbox or a NAS you have at home. + + + +**Author:** @igorpecovnik + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd NCT001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **443**: + + - URL: `https://:443` + - Username/Password: admin / generate at first web interface login + +=== "Directories" + + - Install directory: `/armbian/nextcloud` + - Site configuration directory: `/armbian/nextcloud/config` + - Data directory: `/armbian/nextcloud/data` + +=== "View logs" + + ```sh + docker logs -f nextcloud + ``` + + + + +~~~ bash title="Nextcloud remove:" +armbian-config --cmd NCT002 +~~~ + + +~~~ bash title="Nextcloud purge with data folder:" +armbian-config --cmd NCT003 +~~~ + + + + +#### Owncloud + + +Owncloud share files and folders, easy and secure + + + +[![Owncloud](/images/OWC001.png)](#) + + + + +ownCloud is a free and open-source software project for content collaboration and sharing and syncing of files in distributed and federated enterprise scenarios. + + + +**Author:** @igorpecovnik + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd OWC001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **7787**: + + - URL: `http://:7787` + - Username/Password: admin / admin + +=== "Directories" + + - Install directory: `/armbian/owncloud` + - Site configuration directory: `/armbian/owncloud/config` + - Data directory: `/armbian/owncloud/data` + +=== "View logs" + + ```sh + docker logs -f owncloud + ``` + + + + +~~~ bash title="Owncloud remove:" +armbian-config --cmd OWC002 +~~~ + + +~~~ bash title="Owncloud purge with data folder:" +armbian-config --cmd OWC003 +~~~ + + + + +#### Jellyfin + + +Jellyfin Media System + + + +[![Jellyfin](/images/JMS001.png)](#) + + + + +Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. + + + +**Author:** @igorpecovnik + +**Status:** Preview + + +~~~ custombash +armbian-config --cmd JMS001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **8096**: + + - URL: `http://:8096` + - Username and password are set at first login + +=== "Directories" + + - Install directory: `/armbian/jellyfin` + - Site configuration directory: `/armbian/jellyfin/config` + - TV shows directory: `/armbian/jellyfin/tvseries` + - Movies directory: `/armbian/jellyfin/movies` + +=== "View logs" + + ```sh + docker logs -f jellyfin + ``` + + + + +~~~ bash title="Jellyfin remove:" +armbian-config --cmd JMS002 +~~~ + + +~~~ bash title="Jellyfin purge with data folder:" +armbian-config --cmd JMS003 +~~~ + + + + +#### Hastebin + + +Hastebin Paste Server + + + +[![Hastebin](/images/HPS001.png)](#) + + + + +Hastebin is a fast and simple self-hosted pastebin server. It allows users to quickly share text snippets like logs, code, or notes via a web interface or API. Hastebin is lightweight, easy to deploy with Docker, and ideal for teams needing private, temporary paste storage. + + + +**Author:** @efectn + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd HPS001 +~~~ + + +~~~ bash title="Hastebin remove:" +armbian-config --cmd HPS002 +~~~ + + +~~~ bash title="Hastebin purge with data folder:" +armbian-config --cmd HPS003 +~~~ + + + + +## Real-time monitoring, collecting metrics, up-time status + +#### Uptime Kuma + + +Uptime Kuma self-hosted monitoring tool + + + +[![Uptime Kuma](/images/UPK001.png)](#) + + + + +[Uptime Kuma](https://github.com/louislam/uptime-kuma) is a self-hosted monitoring tool similar to \"Uptime Robot\". +It provides a beautiful, easy-to-use web dashboard to monitor HTTP(s), TCP, Ping, and more types of services. + +You can receive instant notifications when a service goes down via Telegram, Discord, Slack, email, and many other integrations. + + + +**Author:** @igorpecovnik + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd UPK001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **3001**: + + - URL: `https://:3001` + - Username/Password: Are set at first web interface login + +=== "Features" + + - Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / HTTP(s) Json Query / Ping / DNS Record / Push / Steam Game Server / Docker Containers + - Fancy, Reactive, Fast UI/UX + - Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and 90+ notification services, click here for the full list + - 20-second intervals + - Multi Languages + - Multiple status pages + - Map status pages to specific domains + - Ping chart + - Certificate info + - Proxy support + - 2FA support + + + + +~~~ bash title="Uptime Kuma remove:" +armbian-config --cmd UPK002 +~~~ + + +~~~ bash title="Uptime Kuma purge with data folder:" +armbian-config --cmd UPK003 +~~~ + + + + +#### Netdata + + +Netdata - monitoring real-time metrics + + + +[![Netdata](/images/NTD001.png)](#) + + + + +Netdata is a partially open source tool designed to collect real-time metrics, such as CPU usage, disk activity, bandwidth usage, website visits, etc., and then display them in live, easy-to-interpret charts. + + + +**Author:** @igorpecovnik + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd NTD001 +~~~ + + +~~~ bash title="Netdata remove:" +armbian-config --cmd NTD002 +~~~ + + +~~~ bash title="Netdata purge with data folder:" +armbian-config --cmd NTD003 +~~~ + + + + +#### Grafana + + +Grafana data analytics + + + +[![Grafana](/images/GRA001.png)](#) + + + + +Grafana is a multi-platform open source analytics and interactive visualization web application. It can produce charts, graphs, and alerts for the web when connected to supported data sources. + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd GRA001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **3000**: + + - URL: `https://:3000` + +=== "Directories" + + - Install directory: `/armbian/grafana` + +=== "View logs" + + ```sh + docker logs -f grafana + ``` + + + + +~~~ bash title="Grafana remove:" +armbian-config --cmd GRA002 +~~~ + + +~~~ bash title="Grafana purge with data folder:" +armbian-config --cmd GRA003 +~~~ + + + + +#### Prometheus + + +Prometheus docker image + + + +[![Prometheus](/images/PRO001.png)](#) + + + + +Prometheus is an open-source monitoring and alerting toolkit designed for reliability and scalability. It collects and stores time-series data, provides powerful query capabilities, and enables real-time alerts based on defined conditions. Commonly used in cloud and containerized environments, Prometheus integrates seamlessly with Kubernetes and other modern infrastructure. + + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd PRO001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **9090**: + + - URL: `https://:9090` + +=== "Directories" + + - Config directory: `/armbian/prometheus` + +=== "View logs" + + ```sh + docker logs -f prometheus + ``` + + + + +~~~ bash title="Prometheus remove:" +armbian-config --cmd PRO002 +~~~ + + +~~~ bash title="Prometheus purge with data folder:" +armbian-config --cmd PRO003 +~~~ + + + + +## Remote File & Management tools + +#### Cockpit + + +Cockpit web-based management tool + + + +[![Cockpit](/images/CPT001.png)](#) + + + + +Introducing Cockpit +Cockpit is a web-based graphical interface for servers, intended for everyone, especially those who are: + +- new to Linux +(including Windows admins) +- familiar with Linux +and want an easy, graphical way to administer servers +- expert admins +who mainly use other tools but want an overview on individual systems + +Thanks to Cockpit intentionally using system APIs and commands, a whole team of admins can manage a system in the way they prefer, including the command line and utilities right alongside Cockpit. + + +**Author:** @Tearran + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd CPT001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **9090**: + + - URL: `https://:9090` + - Username/Password: your system login credentials + +=== "Video instructions" + + + + + + + +#### Samba + + +SAMBA Remote File share + + + +[![Samba](/images/SMB001.png)](#) + + + + +Samba is an open-source software suite that enables seamless file and printer sharing between Linux/Unix servers and Windows clients. It allows a Linux machine to act as a domain controller, file server, or print server within a Windows network environment, supporting cross-platform interoperability. + + + +**Author:** @Tearran + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd SMB001 +~~~ + + +#### Webmin + + +Webmin web-based management tool + + + +[![Webmin](/images/WBM001.png)](#) + + + + +Webmin is a web-based system administration tool for Unix-like servers. It provides an easy-to-use browser interface to manage users, configure services, edit files, monitor system performance, and control almost every aspect of your server — without needing to touch the command line. + + + +**Author:** @Tearran + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd WBM001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **10000**: + + - URL: `https://:10000` + - Username/Password: your system login credentials + + + + + +## Tools for printing and 3D printing + +#### OctoPrint + + +OctoPrint web-based 3D printers management tool + + + +[![OctoPrint](/images/OCT001.png)](#) + + + + +OctoPrint is an open source 3D printer controller application, which provides a web interface for the connected printers. It displays printers status and key parameters and allows user to schedule prints and remotely control the printer. + + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd OCT001 +~~~ + + + +=== "Access to the web interface" + + The web interface is accessible via port **7981**: + + - URL: `https://:7981` + +=== "Directories" + + - Install directory: `/armbian/octoprint` + +=== "View logs" + + ```sh + docker logs -f octoprint + ``` + + + + +~~~ bash title="OctoPrint remove:" +armbian-config --cmd OCT002 +~~~ + + +~~~ bash title="OctoPrint purge with data folder:" +armbian-config --cmd OCT003 +~~~ + + + + +## Console network tools for measuring load and bandwidth + +#### nload + + +nload - realtime console network usage monitor + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd NLD001 +~~~ + + +~~~ bash title="nload - remove:" +armbian-config --cmd NLD002 +~~~ + + + +#### iperf3 + + +iperf3 bandwidth measuring tool + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd IPR001 +~~~ + + +~~~ bash title="iperf3 remove:" +armbian-config --cmd IPR002 +~~~ + + + +#### iptraf-ng + + +iptraf-ng IP LAN monitor + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd IPT001 +~~~ + + +~~~ bash title="iptraf-ng remove:" +armbian-config --cmd IPT002 +~~~ + + + +#### avahi-daemon + + +avahi-daemon hostname broadcast via mDNS + +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd AVH001 +~~~ + + +~~~ bash title="avahi-daemon remove:" +armbian-config --cmd AVH002 +~~~ + + + +## VPN tools + +#### ZeroTier connect devices over your own private network in the world. + +**Author:** @jnovos + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd VPN001 +~~~ + diff --git a/docs/User-Guide_Armbian-Software/VPN.md b/docs/User-Guide_Armbian-Software/VPN.md new file mode 100644 index 00000000..71754c25 --- /dev/null +++ b/docs/User-Guide_Armbian-Software/VPN.md @@ -0,0 +1,17 @@ +--- +comments: true +--- + +# VPN tools + +## ZeroTier connect devices over your own private network in the world. + +**Author:** @jnovos + +**Status:** Stable + + +~~~ custombash +armbian-config --cmd VPN001 +~~~ + diff --git a/docs/User-Guide_Armbian-Software/WebHosting.md b/docs/User-Guide_Armbian-Software/WebHosting.md index 977b3436..fef3beea 100644 --- a/docs/User-Guide_Armbian-Software/WebHosting.md +++ b/docs/User-Guide_Armbian-Software/WebHosting.md @@ -1,14 +1,17 @@ +--- +comments: true +--- + # Web server, LEMP, reverse proxy, Let's Encrypt SSL -**Status:** Stable + +## SWAG +SWAG reverse proxy -*** - -## SWAG reverse proxy -[![SWAG reverse proxy](/images/SWAG01.png)](#) +[![SWAG](/images/SWAG01.png)](#) @@ -35,58 +38,30 @@ After entering required information, your server will have auto updating SSL sec -**Command:** -~~~ +**Author:** @armbian + +**Status:** Stable + + +~~~ custombash armbian-config --cmd SWAG01 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## SWAG reverse proxy .htpasswd set -**Command:** -~~~ +~~~ bash title="SWAG reverse proxy .htpasswd set:" armbian-config --cmd SWAG02 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## SWAG remove -**Command:** -~~~ +~~~ bash title="SWAG remove:" armbian-config --cmd SWAG03 ~~~ -**Author:** @armbian -**Status:** Stable - - - -*** - -## SWAG purge with data folder -**Command:** -~~~ +~~~ bash title="SWAG purge with data folder:" armbian-config --cmd SWAG04 ~~~ -**Author:** @igorpecovnik - -**Status:** Stable -*** - diff --git a/docs/images/ACC001.png b/docs/images/ACC001.png new file mode 100644 index 00000000..ce27fd1a Binary files /dev/null and b/docs/images/ACC001.png differ diff --git a/docs/images/ADG001.png b/docs/images/ADG001.png index c4ef3c7f..2961e81e 100644 Binary files a/docs/images/ADG001.png and b/docs/images/ADG001.png differ diff --git a/docs/images/BOOT01.png b/docs/images/BOOT01.png new file mode 100644 index 00000000..46184f0c Binary files /dev/null and b/docs/images/BOOT01.png differ diff --git a/docs/images/CPT001.png b/docs/images/CPT001.png new file mode 100644 index 00000000..ece01606 Binary files /dev/null and b/docs/images/CPT001.png differ diff --git a/docs/images/DTO001.png b/docs/images/DTO001.png new file mode 100644 index 00000000..f1ba1e59 Binary files /dev/null and b/docs/images/DTO001.png differ diff --git a/docs/images/EMB001.png b/docs/images/EMB001.png new file mode 100644 index 00000000..b9888d48 Binary files /dev/null and b/docs/images/EMB001.png differ diff --git a/docs/images/GRA001.png b/docs/images/GRA001.png index 537d0b73..9ec0d6a6 100644 Binary files a/docs/images/GRA001.png and b/docs/images/GRA001.png differ diff --git a/docs/images/HEAD01.png b/docs/images/HEAD01.png new file mode 100644 index 00000000..a482d2a9 Binary files /dev/null and b/docs/images/HEAD01.png differ diff --git a/docs/images/HPS001.png b/docs/images/HPS001.png new file mode 100644 index 00000000..8620f344 Binary files /dev/null and b/docs/images/HPS001.png differ diff --git a/docs/images/JEL001.png b/docs/images/JEL001.png index 6bda23de..2a871b58 100644 Binary files a/docs/images/JEL001.png and b/docs/images/JEL001.png differ diff --git a/docs/images/JMS001.png b/docs/images/JMS001.png new file mode 100644 index 00000000..17f24cee Binary files /dev/null and b/docs/images/JMS001.png differ diff --git a/docs/images/KER001.png b/docs/images/KER001.png new file mode 100644 index 00000000..bbffc161 Binary files /dev/null and b/docs/images/KER001.png differ diff --git a/docs/images/LID001.png b/docs/images/LID001.png index 33bed87e..538c82ba 100644 Binary files a/docs/images/LID001.png and b/docs/images/LID001.png differ diff --git a/docs/images/MYA001.png b/docs/images/MYA001.png new file mode 100644 index 00000000..10d5269d Binary files /dev/null and b/docs/images/MYA001.png differ diff --git a/docs/images/NCT001.png b/docs/images/NCT001.png new file mode 100644 index 00000000..8678490e Binary files /dev/null and b/docs/images/NCT001.png differ diff --git a/docs/images/NTD001.png b/docs/images/NTD001.png new file mode 100644 index 00000000..40bdd0fa Binary files /dev/null and b/docs/images/NTD001.png differ diff --git a/docs/images/OCT001.png b/docs/images/OCT001.png index a8ce6fb4..427ba518 100644 Binary files a/docs/images/OCT001.png and b/docs/images/OCT001.png differ diff --git a/docs/images/OWC001.png b/docs/images/OWC001.png new file mode 100644 index 00000000..7d78ba15 Binary files /dev/null and b/docs/images/OWC001.png differ diff --git a/docs/images/PIH001.png b/docs/images/PIH001.png new file mode 100644 index 00000000..81909453 Binary files /dev/null and b/docs/images/PIH001.png differ diff --git a/docs/images/POR001.webp b/docs/images/POR001.webp new file mode 100644 index 00000000..b8836079 Binary files /dev/null and b/docs/images/POR001.webp differ diff --git a/docs/images/PRO001.png b/docs/images/PRO001.png index 017a3c75..0d5aceb2 100644 Binary files a/docs/images/PRO001.png and b/docs/images/PRO001.png differ diff --git a/docs/images/SHELL1.png b/docs/images/SHELL1.png new file mode 100644 index 00000000..ba4e7e6c Binary files /dev/null and b/docs/images/SHELL1.png differ diff --git a/docs/images/SMB001.png b/docs/images/SMB001.png new file mode 100644 index 00000000..40d4c650 Binary files /dev/null and b/docs/images/SMB001.png differ diff --git a/docs/images/SSH001.png b/docs/images/SSH001.png new file mode 100644 index 00000000..75560664 Binary files /dev/null and b/docs/images/SSH001.png differ diff --git a/docs/images/STC001.png b/docs/images/STC001.png new file mode 100644 index 00000000..a5e60b02 Binary files /dev/null and b/docs/images/STC001.png differ diff --git a/docs/images/STOR001.png b/docs/images/STOR001.png new file mode 100644 index 00000000..ed1bbfbb Binary files /dev/null and b/docs/images/STOR001.png differ diff --git a/docs/images/STR001.png b/docs/images/STR001.png new file mode 100644 index 00000000..e5eacfb6 Binary files /dev/null and b/docs/images/STR001.png differ diff --git a/docs/images/UNAT01.png b/docs/images/UNAT01.png new file mode 100644 index 00000000..959d458a Binary files /dev/null and b/docs/images/UNAT01.png differ diff --git a/docs/images/UNB001.png b/docs/images/UNB001.png index 69913c24..1c1e41a3 100644 Binary files a/docs/images/UNB001.png and b/docs/images/UNB001.png differ diff --git a/docs/images/UPD001.png b/docs/images/UPD001.png new file mode 100644 index 00000000..9ba40a5a Binary files /dev/null and b/docs/images/UPD001.png differ diff --git a/docs/images/UPK001.png b/docs/images/UPK001.png new file mode 100644 index 00000000..f2475216 Binary files /dev/null and b/docs/images/UPK001.png differ diff --git a/docs/images/UPK001.webp b/docs/images/UPK001.webp new file mode 100644 index 00000000..c809a007 Binary files /dev/null and b/docs/images/UPK001.webp differ diff --git a/docs/images/USR001.png b/docs/images/USR001.png new file mode 100644 index 00000000..d4a2833a Binary files /dev/null and b/docs/images/USR001.png differ diff --git a/docs/images/WBM001.png b/docs/images/WBM001.png new file mode 100644 index 00000000..1fe686d3 Binary files /dev/null and b/docs/images/WBM001.png differ diff --git a/docs/images/WG001.png b/docs/images/WG001.png index 9ff2d50e..a60dc836 100644 Binary files a/docs/images/WG001.png and b/docs/images/WG001.png differ diff --git a/docs/images/WTC001.png b/docs/images/WTC001.png index 30495268..79e6da38 100644 Binary files a/docs/images/WTC001.png and b/docs/images/WTC001.png differ diff --git a/docs/images/ZFS001.png b/docs/images/ZFS001.png new file mode 100644 index 00000000..fdd965dc Binary files /dev/null and b/docs/images/ZFS001.png differ