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

Automatic documentation update

Browse Source
This commit is contained in:
igorpecovnik
2025-05-03 09:18:20 +00:00
committed by Igor
parent f6efcca9eb
commit 786b16183b
1 changed files with 78 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

186
DOCUMENTATION.md
View File

@@ -89,18 +89,6 @@ sudo armbian-config
- ### Show active status
- ### WireGuard VPN client / server
- ### WireGuard remove
- ### WireGuard clients QR codes
- ### WireGuard purge with data folder
- ## **Localisation**
@@ -228,13 +216,18 @@ sudo armbian-config
- ### phpMyAdmin purge with data folder
- ### Armbian infrastructure services
- ### Router for repository mirror automation
- ### Remove CDN router
- ### GitHub runners for Armbian automation
- ### Remove GitHub runners for Armbian automation
- ### Rsyncd server
- ### Remove Armbian rsyncd server
- ### Applications and tools for development
- ### Install tools for cloning and managing repositories (git)
- ### Remove tools for cloning and managing repositories (git)
- ### Armbian router for repository mirror automation
- ### Remove Armbian router
- ### Armbian rsyncd server
- ### Remove Armbian rsyncd server
- ### Docker containerization and KVM virtual machines
@@ -321,7 +314,11 @@ sudo armbian-config
- ### avahi-daemon remove
- ### VPN tools
- ### Virtual Private Network tools
- ### WireGuard VPN client / server
- ### WireGuard remove
- ### WireGuard clients QR codes
- ### WireGuard purge with data folder
- ### ZeroTier connect devices over your own private network in the world.
@@ -407,7 +404,7 @@ Outputs:
--cmd ACC011 - Disable last login banner
--cmd ACC012 - Enable last login banner
--cmd SSH001 - Sandboxed & containerised SSH server
--cmd SSH002 - Remove sandboxed SSH server (ssh://10.1.0.185:2222)
--cmd SSH002 - Remove sandboxed SSH server (ssh://10.1.0.29:2222)
--cmd SSH003 - Purge sandboxed SSH server with data folder
User - Change shell, adjust MOTD
--cmd SHELL1 - Change shell system wide to ZSH
@@ -433,10 +430,6 @@ Outputs:
--cmd NEA003 - Revert to Armbian defaults
--cmd NEA004 - Show configuration
--cmd NEA005 - Show active status
--cmd WRG001 - WireGuard VPN client / server
--cmd WRG002 - WireGuard remove
--cmd WRG003 - WireGuard clients QR codes
--cmd WRG004 - WireGuard purge with data folder
Localisation - Localisation (C.UTF-8)
--cmd LOC001 - Change Global timezone
@@ -452,27 +445,27 @@ Outputs:
--cmd SWAG04 - SWAG purge with data folder
HomeAutomation - Home Automation for control home appliances
--cmd HAB001 - openHAB empowering the smart home
--cmd HAB002 - openHAB remove (http://10.1.0.185:8080)
--cmd HAB002 - openHAB remove (http://10.1.0.29:8080)
--cmd HAB003 - openHAB purge with data folder
--cmd HAS001 - Home Assistant open source home automation
--cmd HAS002 - Home Assistant remove (http://10.1.0.185:8123)
--cmd HAS002 - Home Assistant remove (http://10.1.0.29:8123)
--cmd HAS003 - Home Assistant purge with data folder
--cmd DOM001 - Domoticz open source home automation
--cmd DOM002 - Domoticz remove (http://10.1.0.185:8080)
--cmd DOM002 - Domoticz remove (http://10.1.0.29:8080)
--cmd DOM003 - Domoticz purge with data folder
--cmd EVCC01 - EVCC - solar charging automation
--cmd EVCC02 - EVCC - solar charging automation remove (http://10.1.0.185:7070)
--cmd EVCC02 - EVCC - solar charging automation remove (http://10.1.0.29:7070)
--cmd EVCC03 - EVCC purge with data folder
DNS - Network-wide ad blockers servers
--cmd PIH001 - Pi-hole DNS ad blocker
--cmd PIH003 - Pi-hole remove (http://10.1.0.185:80)
--cmd PIH003 - Pi-hole remove (http://10.1.0.29:80)
--cmd PIH002 - Pi-hole change web admin password
--cmd PIH004 - Pi-hole purge with data folder
--cmd UNB001 - Unbound caching DNS resolver
--cmd UNB002 - Unbound remove
--cmd UNB003 - Unbound purge with data folder
--cmd ADG001 - AdGuardHome DNS sinkhole
--cmd ADG002 - AdGuardHome remove (http://10.1.0.185:3000)
--cmd ADG002 - AdGuardHome remove (http://10.1.0.29:3000)
--cmd ADG003 - AdGuardHome purge with data folder
Music - Music servers and streamers
--cmd NAV001 - Navidrome music server and streamer compatible with Subsonic/Airsonic
@@ -480,131 +473,134 @@ Outputs:
--cmd NAV003 - Navidrome purge with data folder
Finance - Manage your finances
--cmd ABU001 - Do your finances with Actual Budget
--cmd ABU002 - Actual Budget remove (http://10.1.0.185:5006)
--cmd ABU002 - Actual Budget remove (http://10.1.0.29:5006)
--cmd ABU003 - Actual Budget purge with data folder
Backup - Backup solutions for your data
--cmd DPL001 - Duplicati install
--cmd DPL002 - Duplicati remove (http://10.1.0.185:8200)
--cmd DPL002 - Duplicati remove (http://10.1.0.29:8200)
--cmd DPL003 - Duplicati purge with data folder
Downloaders - Download apps for movies, TV shows, music and subtitles
--cmd DOW001 - qBittorrent BitTorrent client
--cmd DOW002 - qBittorrent remove (http://10.1.0.185:8090)
--cmd DOW002 - qBittorrent remove (http://10.1.0.29:8090)
--cmd DOW003 - qBittorrent purge with data folder
--cmd DEL001 - Deluge BitTorrent client
--cmd DEL002 - Deluge remove (http://10.1.0.185:8112)
--cmd DEL002 - Deluge remove (http://10.1.0.29:8112)
--cmd DEL003 - Deluge purge with data folder
--cmd TRA001 - Transmission BitTorrent client
--cmd TRA002 - Transmission remove (http://10.1.0.185:9091)
--cmd TRA002 - Transmission remove (http://10.1.0.29:9091)
--cmd TRA003 - Transmission purge with data folder
--cmd SABN01 - SABnzbd newsgroup downloader
--cmd SABN02 - SABnzbd remove (http://10.1.0.185:8080)
--cmd SABN02 - SABnzbd remove (http://10.1.0.29:8080)
--cmd SABN03 - SABnzbd purge with data folder
--cmd MDS001 - Medusa automatic downloader for TV shows
--cmd MDS002 - Medusa TV shows downloader remove (http://10.1.0.185:8081)
--cmd MDS002 - Medusa TV shows downloader remove (http://10.1.0.29:8081)
--cmd MDS003 - Medusa TV shows downloader purge
--cmd SON001 - Sonarr automatic downloader for TV shows
--cmd SON002 - Sonarr remove (http://10.1.0.185:8989)
--cmd SON002 - Sonarr remove (http://10.1.0.29:8989)
--cmd SON003 - Sonarr purge with data folder
--cmd RAD001 - Radarr automatic downloader for movies
--cmd RAD002 - Radarr remove (http://10.1.0.185:7878)
--cmd RAD002 - Radarr remove (http://10.1.0.29:7878)
--cmd RAD003 - Radarr purge with data folder
--cmd BAZ001 - Bazarr automatic subtitles downloader for Sonarr and Radarr
--cmd BAZ002 - Bazarr remove (http://10.1.0.185:6767)
--cmd BAZ002 - Bazarr remove (http://10.1.0.29:6767)
--cmd BAZ003 - Bazarr purge with data folder
--cmd LID001 - Lidarr automatic music downloader
--cmd LID002 - Lidarr remove (http://10.1.0.185:8686)
--cmd LID002 - Lidarr remove (http://10.1.0.29:8686)
--cmd LID003 - Lidarr purge with data folder
--cmd RDR001 - Readarr automatic downloader for Ebooks
--cmd RDR002 - Readarr remove (http://10.1.0.185:8787)
--cmd RDR002 - Readarr remove (http://10.1.0.29:8787)
--cmd RDR003 - Readarr purge with data folder
--cmd DOW025 - Prowlarr index manager and proxy for PVR
--cmd DOW026 - Prowlarr remove (http://10.1.0.185:9696)
--cmd DOW026 - Prowlarr remove (http://10.1.0.29:9696)
--cmd DOW027 - Prowlarr purge with data folder
--cmd JEL001 - Jellyseerr Jellyfin/Emby/Plex integration install
--cmd JEL002 - Jellyseerr remove (http://10.1.0.185:5055)
--cmd JEL002 - Jellyseerr remove (http://10.1.0.29:5055)
--cmd JEL003 - Jellyseerr purge with data folder
Database - SQL database servers and web interface managers
--cmd PGSQL1 - PostgreSQL install
--cmd PGSQL2 - PostgreSQL remove
--cmd PGSQL3 - PostgreSQL purge with data folder
--cmd DAT001 - Mariadb SQL database server
--cmd DAT002 - Mariadb remove (Server: 10.1.0.185)
--cmd DAT002 - Mariadb remove (Server: 10.1.0.29)
--cmd DAT003 - Mariadb purge with data folder
--cmd REDIS1 - Redis install
--cmd REDIS2 - Redis remove
--cmd REDIS3 - Redis purge with data folder
--cmd MYA001 - phpMyAdmin web interface manager
--cmd MYA002 - phpMyAdmin remove (http://10.1.0.185:8071)
--cmd MYA002 - phpMyAdmin remove (http://10.1.0.29:8071)
--cmd MYA003 - phpMyAdmin purge with data folder
Armbian - Armbian infrastructure services
--cmd ART001 - Router for repository mirror automation
--cmd ART002 - Remove CDN router
--cmd GHR001 - GitHub runners for Armbian automation
--cmd GHR002 - Remove GitHub runners for Armbian automation
--cmd RSD001 - Rsyncd server
--cmd RSD002 - Remove Armbian rsyncd server
DevTools - Applications and tools for development
--cmd GIT001 - Install tools for cloning and managing repositories (git)
--cmd GIT002 - Remove tools for cloning and managing repositories (git)
--cmd ART001 - Armbian router for repository mirror automation
--cmd ART002 - Remove Armbian router
--cmd RSD001 - Armbian rsyncd server
--cmd RSD002 - Remove Armbian rsyncd server
Containers - Docker containerization and KVM virtual machines
--cmd CON001 - Docker minimal
--cmd CON002 - Docker engine
--cmd CON003 - Docker remove
--cmd CON004 - Docker purge with all images, containers, and volumes
--cmd POR001 - Portainer container management platform
--cmd POR002 - Portainer remove (http://10.1.0.185:9000)
--cmd POR002 - Portainer remove (http://10.1.0.29:9000)
--cmd POR003 - Portainer purge with with data folder
Media - Media servers, organizers and editors
--cmd EMB001 - Emby organizes video, music, live TV, and photos
--cmd EMB002 - Emby server remove (http://10.1.0.185:8096)
--cmd EMB002 - Emby server remove (http://10.1.0.29:8096)
--cmd EMB003 - Emby server purge with data folder
--cmd STR001 - Stirling PDF tools for viewing and editing PDF files
--cmd STR002 - Stirling PDF remove (http://10.1.0.185:8077)
--cmd STR002 - Stirling PDF remove (http://10.1.0.29:8077)
--cmd STR003 - Stirling PDF purge with data folder
--cmd STC001 - Syncthing continuous file synchronization
--cmd STC002 - Syncthing remove (http://10.1.0.185:8884)
--cmd STC002 - Syncthing remove (http://10.1.0.29:8884)
--cmd STC003 - Syncthing purge with data folder
--cmd NCT001 - Nextcloud content collaboration platform
--cmd NCT002 - Nextcloud remove (https://10.1.0.185:443)
--cmd NCT002 - Nextcloud remove (https://10.1.0.29:443)
--cmd NCT003 - Nextcloud purge with data folder
--cmd OWC001 - Owncloud share files and folders, easy and secure
--cmd OWC002 - Owncloud remove (http://10.1.0.185:7787)
--cmd OWC002 - Owncloud remove (http://10.1.0.29:7787)
--cmd OWC003 - Owncloud purge with data folder
--cmd JMS001 - Jellyfin Media System
--cmd JMS002 - Jellyfin remove (http://10.1.0.185:8096)
--cmd JMS002 - Jellyfin remove (http://10.1.0.29:8096)
--cmd JMS003 - Jellyfin purge with data folder
--cmd HPS001 - Hastebin Paste Server
--cmd HPS002 - Hastebin remove
--cmd HPS003 - Hastebin purge with data folder
--cmd IMM001 - Immich - high-performance self-hosted photo and video backup solution
--cmd IMM002 - Immich remove (http://10.1.0.185:8077)
--cmd IMM002 - Immich remove (http://10.1.0.29:8077)
--cmd IMM003 - Immich purge with data folder
Monitoring - Real-time monitoring, collecting metrics, up-time status
--cmd UPK001 - Uptime Kuma self-hosted monitoring tool
--cmd UPK002 - Uptime Kuma remove (http://10.1.0.185:3001)
--cmd UPK002 - Uptime Kuma remove (http://10.1.0.29:3001)
--cmd UPK003 - Uptime Kuma purge with data folder
--cmd NTD001 - Netdata - monitoring real-time metrics
--cmd NTD002 - Netdata remove (http://10.1.0.185:19999)
--cmd NTD002 - Netdata remove (http://10.1.0.29:19999)
--cmd NTD003 - Netdata purge with data folder
--cmd GRA001 - Grafana data analytics
--cmd GRA002 - Grafana remove (http://10.1.0.185:3000)
--cmd GRA002 - Grafana remove (http://10.1.0.29:3000)
--cmd GRA003 - Grafana purge with data folder
--cmd PRO001 - Prometheus docker image
--cmd PRO002 - Prometheus remove
--cmd PRO003 - Prometheus purge with data folder
--cmd NAX001 - NetAlertX network scanner & notification framework
--cmd NAX002 - NetAlertX network scanner remove (http://10.1.0.185:20211)
--cmd NAX002 - NetAlertX network scanner remove (http://10.1.0.29:20211)
--cmd NAX003 - NetAlertX network scanner purge with data folder
Management - Remote File & Management tools
--cmd CPT001 - Cockpit web-based management tool (http://10.1.0.185:9090)
--cmd CPT001 - Cockpit web-based management tool (http://10.1.0.29:9090)
--cmd SMB001 - SAMBA Remote File share
--cmd WBM001 - Webmin web-based management tool
--cmd HPG001 - Install Homepage startpage / application dashboard
--cmd HPG002 - Remove Homepage (http://10.1.0.185:3000)
--cmd HPG002 - Remove Homepage (http://10.1.0.29:3000)
--cmd HPG003 - Purge Homepage with data folder
--cmd NBOX01 - NetBox infrastructure resource modeling install
--cmd NBOX02 - NetBox remove (http://10.1.0.185:8222)
--cmd NBOX02 - NetBox remove (http://10.1.0.29:8222)
--cmd NBOX03 - NetBox purge with data folder
Printing - Tools for printing and 3D printing
--cmd OCT001 - OctoPrint web-based 3D printers management tool
--cmd OCT002 - OctoPrint remove (http://10.1.0.185:7981)
--cmd OCT002 - OctoPrint remove (http://10.1.0.29:7981)
--cmd OCT003 - OctoPrint purge with data folder
Netconfig - Console network tools for measuring load and bandwidth
--cmd NLD001 - nload - realtime console network usage monitor
@@ -615,8 +611,12 @@ Outputs:
--cmd IPT002 - iptraf-ng remove
--cmd AVH001 - avahi-daemon hostname broadcast via mDNS
--cmd AVH002 - avahi-daemon remove
VPN - VPN tools
--cmd VPN001 - ZeroTier connect devices over your own private network in the world.
VPN - Virtual Private Network tools
--cmd WRG001 - WireGuard VPN client / server
--cmd WRG002 - WireGuard remove
--cmd WRG003 - WireGuard clients QR codes
--cmd WRG004 - WireGuard purge with data folder
--cmd ZTR001 - ZeroTier connect devices over your own private network in the world.
Help - About this tool
--cmd HLP001 - Contribute
@@ -745,46 +745,6 @@ Jobs:
No commands available
~~~
### WRG001
WireGuard VPN client / server
Jobs:
~~~
module_wireguard install
~~~
### WRG002
WireGuard remove
Jobs:
~~~
module_wireguard remove
~~~
### WRG003
WireGuard clients QR codes
Jobs:
~~~
module_wireguard qrcode
~~~
### WRG004
WireGuard purge with data folder
Jobs:
~~~
module_wireguard purge
~~~
### LOC001
Change Global timezone
@@ -908,6 +868,16 @@ Jobs:
No commands available
~~~
### Armbian
Armbian infrastructure services
Jobs:
~~~
No commands available
~~~
### DevTools
Applications and tools for development
@@ -980,7 +950,7 @@ No commands available
### VPN
VPN tools
Virtual Private Network tools
Jobs:
@@ -1042,7 +1012,7 @@ These helper functions facilitate various operations related to job management,
| Unmask service | srv_unmask ssh.service | @dimitry-ishenko
| Migrated procedures from Armbian config. | connect_bt_interface | @armbian
| Display a message box | show_message <<< 'hello world' | @Tearran
| Manage self hosted runners | install remove remove_online purge help | @igorpecovnik
| Manage self hosted runners | install remove remove_online purge status help | @igorpecovnik
| Install domoticz container | install remove purge status help | @armbian
| Install and configure automatic updates | install remove configure status defaults help | @igorpecovnik
| Menu for armbianmonitor features | see_monitoring | @Tearran