armbian/documentation
0
0
Fork 0
mirror of https://github.com/armbian/documentation.git synced 2026-01-06 10:13:36 -08:00
Code Issues Packages Projects Releases Wiki Activity

Automatic documentation update

Browse Source
This commit is contained in:
igorpecovnik
2024-12-24 21:21:53 +00:00
committed by Igor
parent 11c98b0dcc
commit 54bffcbdfc
22 changed files with 573 additions and 322 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/User-Guide_Armbian-Config/System.md
View File

@@ -583,5 +583,33 @@ armbian-config --cmd SY207
***
### Enable automating Docker container base images updating
**Command:**
~~~
armbian-config --cmd WTC001
~~~
**Author:** @armbian
**Status:** Stable
***
### Disable automating Docker container base images updating
**Command:**
~~~
armbian-config --cmd WTC002
~~~
**Author:** @armbian
**Status:** Stable
***

36
docs/User-Guide_Armbian-Software/Containers.md
View File

@@ -1,12 +1,12 @@
# Containerlization and Virtual Machines
# Docker containerization and KVM virtual machines
***
## Install Docker Minimal
## Docker Minimal Install
<!--- section image START from tools/include/images/CON001.webp --->
[![Install Docker Minimal](/images/CON001.webp)](#)
[![Docker Minimal Install](/images/CON001.webp)](#)
<!--- section image STOP from tools/include/images/CON001.webp --->
This operation will install Docker Minimal.
@@ -30,7 +30,7 @@ What is Docker? Docker helps developers build, share, run, and verify applicatio
***
## Install Docker Engine
## Docker Engine Install
This operation will install Docker Engine.
**Command:**
@@ -46,7 +46,7 @@ armbian-config --cmd CON002
***
## Remove Docker
## Docker Remove
This operation will purge Docker.
**Command:**
@@ -62,7 +62,7 @@ armbian-config --cmd CON003
***
## Purge all Docker images, containers, and volumes
## Docker Purge all images, containers, and volumes
This operation will delete all Docker images, containers, and volumes.
**Command:**
@@ -78,10 +78,10 @@ armbian-config --cmd CON004
***
## Install Portainer
## Portainer container management platform
<!--- section image START from tools/include/images/CON005.webp --->
[![Install Portainer](/images/CON005.webp)](#)
[![Portainer container management platform](/images/CON005.webp)](#)
<!--- section image STOP from tools/include/images/CON005.webp --->
@@ -113,7 +113,7 @@ armbian-config --cmd CON005
***
## Remove Portainer
## Portainer remove
**Command:**
~~~
armbian-config --cmd CON006
@@ -127,10 +127,10 @@ armbian-config --cmd CON006
***
## Watchtower install
## Portainer purge with with data folder
<!--- section image START from tools/include/images/CON007.png --->
[![Watchtower install](/images/CON007.png)](#)
[![Portainer purge with with data folder](/images/CON007.png)](#)
<!--- section image STOP from tools/include/images/CON007.png --->
@@ -156,19 +156,5 @@ Every day watchtower will pull the latest images and compare it to the one that
***
## Watchtower remove
**Command:**
~~~
armbian-config --cmd CON008
~~~
**Author:** @armbian
**Status:** Stable
***

50
docs/User-Guide_Armbian-Software/DNS.md
View File

@@ -1,12 +1,12 @@
# DNS blockers
# Network-wide ad blockers servers
***
## Install Pi-hole DNS ad blocker
## Pi-hole DNS ad blocker install
<!--- section image START from tools/include/images/DNS001.png --->
[![Install Pi-hole DNS ad blocker](/images/DNS001.png)](#)
[![Pi-hole DNS ad blocker install](/images/DNS001.png)](#)
<!--- section image STOP from tools/include/images/DNS001.png --->
@@ -44,21 +44,7 @@ armbian-config --cmd DNS001
***
## Set Pi-hole web admin password
**Command:**
~~~
armbian-config --cmd DNS002
~~~
**Author:** @armbian
**Status:** Stable
***
## Remove Pi-hole DNS ad blocker
## Pi-hole remove
**Command:**
~~~
armbian-config --cmd DNS003
@@ -70,5 +56,33 @@ armbian-config --cmd DNS003
***
## Pi-hole change web admin password
**Command:**
~~~
armbian-config --cmd DNS002
~~~
**Author:** @armbian
**Status:** Stable
***
## Pi-hole purge
**Command:**
~~~
armbian-config --cmd DNS004
~~~
**Author:** @armbian
**Status:** Stable
***

2
docs/User-Guide_Armbian-Software/Database.md
View File

@@ -1,4 +1,4 @@
# Database
# SQL database servers and web interface managers
***

2
docs/User-Guide_Armbian-Software/DevTools.md
View File

@@ -1,4 +1,4 @@
# Development
# Applications and tools for development
***

463
docs/User-Guide_Armbian-Software/Downloaders.md
View File

File diff suppressed because it is too large Load Diff

153
docs/User-Guide_Armbian-Software/HomeAutomation.md
View File

@@ -1,57 +1,14 @@
# Home Automation
# Home Automation for monitoring and/or control home appliances
***
## Install openHAB
<!--- section image START from tools/include/images/HA001.png --->
[![Install openHAB](/images/HA001.png)](#)
<!--- section image STOP from tools/include/images/HA001.png --->
## openHAB empowering the smart home
This operation will install openHAB.
**Command:**
~~~
armbian-config --cmd HA001
~~~
**Author:** @armbian
**Status:** Stable
<!--- footer START from tools/include/markdown/HA001-footer.md --->
=== "Access to the web interface"
The web interface is accessible via port **8444**:
- URL: `https://<your.IP>:8444`
- Username/Password: Are set at first web interface login
=== "Directories"
- Install directory: `/usr/share/openhab`
- Site configuration directory: `/etc/openhab`
- Config file: `/etc/default/openhab`
- Data directory: `/var/lib/openhab`
See also [openHAB file locations](https://www.openhab.org/docs/installation/linux.html#file-locations).
=== "View logs"
```sh
journalctl -u openhab
```
<!--- footer STOP from tools/include/markdown/HA001-footer.md --->
***
## Remove openHAB
**Command:**
~~~
armbian-config --cmd HA002
armbian-config --cmd HAB001
~~~
**Author:** @armbian
@@ -62,64 +19,76 @@ armbian-config --cmd HA002
***
## Install Home Assistant
<!--- section image START from tools/include/images/HA003.png --->
[![Install Home Assistant](/images/HA003.png)](#)
<!--- section image STOP from tools/include/images/HA003.png --->
<!--- header START from tools/include/markdown/HA003-header.md --->
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.
=== "Access to the web interface"
The web interface is accessible via port **8123**:
- URL: `https://<your.IP>: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: `/usr/share/haos`
<!--- header STOP from tools/include/markdown/HA003-header.md --->
## openHAB remove
This operation will purge openHAB.
**Command:**
~~~
armbian-config --cmd HA003
armbian-config --cmd HAB002
~~~
**Author:** @igorpecovnik
**Author:** @armbian
**Status:** Preview
<!--- footer START from tools/include/markdown/HA003-footer.md --->
|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:|
<!--- footer STOP from tools/include/markdown/HA003-footer.md --->
**Status:** Stable
***
## Remove Home Assistant
## openHAB purge with data folder
This operation will purge openHAB.
**Command:**
~~~
armbian-config --cmd HA004
armbian-config --cmd HAB003
~~~
**Author:** @armbian
**Status:** Stable
***
## Home Assistant open source home automation
This operation will install Home Assistant.
**Command:**
~~~
armbian-config --cmd HAS001
~~~
**Author:** @igorpecovnik
**Status:** Preview
***
## Home Assistant remove
This operation will remove Home Assistant.
**Command:**
~~~
armbian-config --cmd HAS002
~~~
**Author:** @igorpecovnik
**Status:** Preview
***
## Home Assistant purge with data folder
This operation will purge Home Assistant.
**Command:**
~~~
armbian-config --cmd HAS003
~~~
**Author:** @igorpecovnik

113
docs/User-Guide_Armbian-Software/Media.md
View File

@@ -1,41 +1,20 @@
# Media Servers and Editors
# Media servers, organizers and editors
***
## Install Plex Media server
This operation will install Plex Media server.
## Emby organizes video, music, live TV, and photos
**Command:**
~~~
armbian-config --cmd MED001
~~~
**Author:** @schwar3kat
**Status:** Stable
<!--- section image START from tools/include/images/MED003.png --->
[![Emby organizes video, music, live TV, and photos](/images/MED003.png)](#)
<!--- section image STOP from tools/include/images/MED003.png --->
<!--- header START from tools/include/markdown/MED003-header.md --->
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.
***
<!--- header STOP from tools/include/markdown/MED003-header.md --->
## Remove Plex Media server
This operation will purge Plex Media server.
**Command:**
~~~
armbian-config --cmd MED002
~~~
**Author:** @schwar3kat
**Status:** Stable
***
## Install Emby server
This operation will install Emby server.
**Command:**
@@ -48,11 +27,33 @@ armbian-config --cmd MED003
**Status:** Stable
<!--- footer START from tools/include/markdown/MED003-footer.md --->
=== "Access to the web interface"
The web interface is accessible via port **8096**:
- URL: `https://<your.IP>: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
```
<!--- footer STOP from tools/include/markdown/MED003-footer.md --->
***
## Remove Emby server
This operation will purge Emby server.
## Emby server remove
This operation will remove Emby server
**Command:**
~~~
@@ -67,10 +68,24 @@ armbian-config --cmd MED004
***
## Stirling-PDF Install
## Emby server purge with data folder
**Command:**
~~~
armbian-config --cmd MED005
~~~
**Author:** @schwar3kat
**Status:** Stable
***
## Stirling PDF tools for viewing and editing PDF files
<!--- section image START from tools/include/images/MED010.png --->
[![Stirling-PDF Install](/images/MED010.png)](#)
[![Stirling PDF tools for viewing and editing PDF files](/images/MED010.png)](#)
<!--- section image STOP from tools/include/images/MED010.png --->
@@ -79,6 +94,8 @@ Stirling-PDF is a robust, locally hosted web-based PDF manipulation tool using D
<!--- header STOP from tools/include/markdown/MED010-header.md --->
This operation will install Stirling-PDF tools.
**Command:**
~~~
armbian-config --cmd MED010
@@ -112,7 +129,9 @@ armbian-config --cmd MED010
***
## Stirling-PDF Remove
## Stirling PDF remove
This operation will remove Stirling-PDF tools.
**Command:**
~~~
armbian-config --cmd MED011
@@ -126,7 +145,9 @@ armbian-config --cmd MED011
***
## Stirling-PDF Purge data folder
## Stirling PDF purge with data folder
This operation will purge Stirling-PDF tools with data folder.
**Command:**
~~~
armbian-config --cmd MED012
@@ -140,10 +161,10 @@ armbian-config --cmd MED012
***
## Syncthing Install
## Syncthing continuous file synchronization
<!--- section image START from tools/include/images/MED015.png --->
[![Syncthing Install](/images/MED015.png)](#)
[![Syncthing continuous file synchronization](/images/MED015.png)](#)
<!--- section image STOP from tools/include/images/MED015.png --->
@@ -188,7 +209,7 @@ armbian-config --cmd MED015
***
## Syncthing Remove
## Syncthing remove
**Command:**
~~~
armbian-config --cmd MED016
@@ -202,7 +223,7 @@ armbian-config --cmd MED016
***
## Syncthing Purge data folder
## Syncthing purge with data folder
**Command:**
~~~
armbian-config --cmd MED017
@@ -216,10 +237,10 @@ armbian-config --cmd MED017
***
## Nextcloud Install
## Nextcloud content collaboration platform
<!--- section image START from tools/include/images/MED020.png --->
[![Nextcloud Install](/images/MED020.png)](#)
[![Nextcloud content collaboration platform](/images/MED020.png)](#)
<!--- section image STOP from tools/include/images/MED020.png --->
@@ -266,7 +287,7 @@ armbian-config --cmd MED020
***
## Nextcloud Remove
## Nextcloud remove
**Command:**
~~~
armbian-config --cmd MED021
@@ -280,7 +301,7 @@ armbian-config --cmd MED021
***
## Nextcloud Purge data folder
## Nextcloud purge with data folder
**Command:**
~~~
armbian-config --cmd MED022
@@ -294,7 +315,7 @@ armbian-config --cmd MED022
***
## Owncloud Install
## Owncloud share files and folders, easy and secure
**Command:**
~~~
armbian-config --cmd MED025
@@ -308,7 +329,7 @@ armbian-config --cmd MED025
***
## Owncloud Remove
## Owncloud remove
**Command:**
~~~
armbian-config --cmd MED026
@@ -322,7 +343,7 @@ armbian-config --cmd MED026
***
## Owncloud Purge data folder
## Owncloud purge with data folder
<!--- header START from tools/include/markdown/MED027-header.md --->
ownCloud is a free and open-source software project for content collaboration and sharing and syncing of files in distributed and federated enterprise scenarios.

24
docs/User-Guide_Armbian-Software/Monitoring.md
View File

@@ -1,9 +1,11 @@
# Monitoring
# Real-time monitoring, collecting metrics, up-time status
***
## Uptime Kuma install
## Uptime Kuma self-hosted monitoring tool
This operation will install Uptime Kuma
**Command:**
~~~
armbian-config --cmd MON001
@@ -43,6 +45,8 @@ armbian-config --cmd MON001
***
## Uptime Kuma remove
This operation will remove Uptime Kuma
**Command:**
~~~
armbian-config --cmd MON002
@@ -56,7 +60,9 @@ armbian-config --cmd MON002
***
## Uptime Kuma purge data folder
## Uptime Kuma purge with data folder
This operation will remove Uptime Kuma with data folder
**Command:**
~~~
armbian-config --cmd MON003
@@ -70,10 +76,10 @@ armbian-config --cmd MON003
***
## Netdata Install
## Netdata - monitoring real-time metrics
<!--- section image START from tools/include/images/MON005.png --->
[![Netdata Install](/images/MON005.png)](#)
[![Netdata - monitoring real-time metrics](/images/MON005.png)](#)
<!--- section image STOP from tools/include/images/MON005.png --->
@@ -82,6 +88,8 @@ Netdata is a partially open source tool designed to collect real-time metrics, s
<!--- header STOP from tools/include/markdown/MON005-header.md --->
This operation will install Netdata
**Command:**
~~~
armbian-config --cmd MON005
@@ -96,6 +104,8 @@ armbian-config --cmd MON005
***
## Netdata remove
This operation will remove Netdata
**Command:**
~~~
armbian-config --cmd MON006
@@ -109,7 +119,9 @@ armbian-config --cmd MON006
***
## Netdata purge data folder
## Netdata purge with data folder
This operation will purge Netdata with data folder
**Command:**
~~~
armbian-config --cmd MON007

18
docs/User-Guide_Armbian-Software/Netconfig.md
View File

@@ -1,9 +1,9 @@
# Network tools
# Console network tools for measuring load and bandwidth
***
## Install realtime console network usage monitor (nload)
## nload -realtime console network usage monitor
**Command:**
~~~
armbian-config --cmd NET001
@@ -17,7 +17,7 @@ armbian-config --cmd NET001
***
## Remove realtime console network usage monitor (nload)
## nload - remove
**Command:**
~~~
armbian-config --cmd NET002
@@ -31,7 +31,7 @@ armbian-config --cmd NET002
***
## Install bandwidth measuring tool (iperf3)
## iperf3 bandwidth measuring tool
**Command:**
~~~
armbian-config --cmd NET003
@@ -45,7 +45,7 @@ armbian-config --cmd NET003
***
## Remove bandwidth measuring tool (iperf3)
## iperf3 remove
**Command:**
~~~
armbian-config --cmd NET004
@@ -59,7 +59,7 @@ armbian-config --cmd NET004
***
## Install IP LAN monitor (iptraf-ng)
## iptraf-ng IP LAN monitor
**Command:**
~~~
armbian-config --cmd NET005
@@ -73,7 +73,7 @@ armbian-config --cmd NET005
***
## Remove IP LAN monitor (iptraf-ng)
## iptraf-ng remove
**Command:**
~~~
armbian-config --cmd NET006
@@ -87,7 +87,7 @@ armbian-config --cmd NET006
***
## Install hostname broadcast via mDNS (avahi-daemon)
## avahi-daemon hostname broadcast via mDNS
**Command:**
~~~
armbian-config --cmd NET007
@@ -101,7 +101,7 @@ armbian-config --cmd NET007
***
## Remove hostname broadcast via mDNS (avahi-daemon)
## avahi-daemon remove
**Command:**
~~~
armbian-config --cmd NET008

6
docs/User-Guide_Armbian-Software/WebHosting.md
View File

@@ -1,4 +1,4 @@
# Web hosting
# Web server, LEMP, reverse proxy, Let's Encrypt SSL
**Status:** Stable
@@ -62,7 +62,7 @@ armbian-config --cmd SWAG02
***
## SWAG reverse proxy remove
## SWAG remove
**Command:**
~~~
armbian-config --cmd SWAG03
@@ -76,7 +76,7 @@ armbian-config --cmd SWAG03
***
## SWAG reverse proxy purge data folder
## SWAG purge with data folder
**Command:**
~~~
armbian-config --cmd SWAG04

BIN
docs/images/BAZ001.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.2 KiB

BIN
docs/images/DEL001.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
docs/images/JEL001.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 45 KiB

BIN
docs/images/LID001.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 24 KiB

BIN
docs/images/MED001.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.0 KiB

BIN
docs/images/MED003.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.8 KiB

BIN
docs/images/RAD001.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.1 KiB

BIN
docs/images/RDR001.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.1 KiB

BIN
docs/images/SABN01.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

Some files were not shown because too many files have changed in this diff Show More