Skip to content

Commit

Permalink
Automatic documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
igorpecovnik committed Jan 27, 2025
1 parent 8a05d9f commit 9fd669b
Showing 1 changed file with 76 additions and 32 deletions.
108 changes: 76 additions & 32 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,16 @@ sudo armbian-config

- ## **Network**

- ### Configure network interfaces
- ### Basic Network Setup


- ### Remove Fallback DHCP Configuration


- ### View Network Settings


- ### Advanced bridged network configuration
- ### Add / change interface
- ### Revert to Armbian defaults
- ### Show configuration
Expand Down Expand Up @@ -342,7 +351,10 @@ Outputs:
--cmd WTC002 - Disable automating Docker container base images updating
Network - Fixed and wireless network settings (eth0)
NE001 - Configure network interfaces
--cmd BNS001 - Basic Network Setup
--cmd BNS002 - Remove Fallback DHCP Configuration
--cmd VNS001 - View Network Settings
NEA002 - Advanced bridged network configuration
--cmd NE002 - Add / change interface
--cmd NE003 - Revert to Armbian defaults
--cmd NE004 - Show configuration
Expand All @@ -366,14 +378,14 @@ 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.89:8080)
--cmd HAB002 - openHAB remove (http://10.1.0.210: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.89:8123)
--cmd HAS002 - Home Assistant remove (http://10.1.0.210:8123)
--cmd HAS003 - Home Assistant purge with data folder
DNS - Network-wide ad blockers servers
--cmd DNS001 - Pi-hole DNS ad blocker
--cmd DNS003 - Pi-hole remove (http://10.1.0.89:80)
--cmd DNS003 - Pi-hole remove (http://10.1.0.210:80)
--cmd DNS002 - Pi-hole change web admin password
--cmd DNS004 - Pi-hole purge with data folder
Music - Music servers and streamers
Expand All @@ -382,47 +394,47 @@ Outputs:
--cmd NAV003 - Navidrome 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.89:8090)
--cmd DOW002 - qBittorrent remove (http://10.1.0.210:8090)
--cmd DOW003 - qBittorrent purge with data folder
--cmd DEL001 - Deluge BitTorrent client
--cmd DEL002 - Deluge remove (http://10.1.0.89:8112)
--cmd DEL002 - Deluge remove (http://10.1.0.210:8112)
--cmd DEL003 - Deluge purge with data folder
--cmd TRA001 - Transmission BitTorrent client
--cmd TRA002 - Transmission remove (http://10.1.0.89:9091)
--cmd TRA002 - Transmission remove (http://10.1.0.210:9091)
--cmd TRA003 - Transmission purge with data folder
--cmd SABN01 - SABnzbd newsgroup downloader
--cmd SABN02 - SABnzbd remove (http://10.1.0.89:8080)
--cmd SABN02 - SABnzbd remove (http://10.1.0.210: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.89:8081)
--cmd MDS002 - Medusa TV shows downloader remove (http://10.1.0.210:8081)
--cmd MDS003 - Medusa TV shows downloader purge
--cmd SON001 - Sonarr automatic downloader for TV shows
--cmd SON002 - Sonarr remove (http://10.1.0.89:8989)
--cmd SON002 - Sonarr remove (http://10.1.0.210:8989)
--cmd SON003 - Sonarr purge with data folder
--cmd RAD001 - Radarr automatic downloader for movies
--cmd RAD002 - Radarr remove (http://10.1.0.89:7878)
--cmd RAD002 - Radarr remove (http://10.1.0.210: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.89:6767)
--cmd BAZ002 - Bazarr remove (http://10.1.0.210:6767)
--cmd BAZ003 - Bazarr purge with data folder
--cmd LID001 - Lidarr automatic music downloader
--cmd LID002 - Lidarr remove (http://10.1.0.89:8686)
--cmd LID002 - Lidarr remove (http://10.1.0.210:8686)
--cmd LID003 - Lidarr purge with data folder
--cmd RDR001 - Readarr automatic downloader for Ebooks
--cmd RDR002 - Readarr remove (http://10.1.0.89:8787)
--cmd RDR002 - Readarr remove (http://10.1.0.210: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.89:9696)
--cmd DOW026 - Prowlarr remove (http://10.1.0.210:9696)
--cmd DOW027 - Prowlarr purge with data folder
--cmd JEL001 - Jellyseerr Jellyfin/Emby/Plex integration install
--cmd JEL002 - Jellyseerr remove (http://10.1.0.89:5055)
--cmd JEL002 - Jellyseerr remove (http://10.1.0.210:5055)
--cmd JEL003 - Jellyseerr purge with data folder
Database - SQL database servers and web interface managers
--cmd DAT001 - Mariadb SQL database server
--cmd DAT002 - Mariadb remove (Server: 10.1.0.89)
--cmd DAT002 - Mariadb remove (Server: 10.1.0.210)
--cmd DAT003 - Mariadb purge with data folder
--cmd DAT005 - phpMyAdmin web interface manager
--cmd DAT006 - phpMyAdmin remove (http://10.1.0.89:8071)
--cmd DAT006 - phpMyAdmin remove (http://10.1.0.210:8071)
--cmd DAT007 - phpMyAdmin purge with data folder
DevTools - Applications and tools for development
--cmd DEV001 - Install tools for cloning and managing repositories (git)
Expand All @@ -433,40 +445,40 @@ Outputs:
--cmd CON003 - Docker remove
--cmd CON004 - Docker purge with all images, containers, and volumes
--cmd CON005 - Portainer container management platform
--cmd CON006 - Portainer remove (http://10.1.0.89:9000)
--cmd CON006 - Portainer remove (http://10.1.0.210:9000)
--cmd CON007 - Portainer purge with with data folder
Media - Media servers, organizers and editors
--cmd MED003 - Emby organizes video, music, live TV, and photos
--cmd MED004 - Emby server remove (http://10.1.0.89:8096)
--cmd MED004 - Emby server remove (http://10.1.0.210:8096)
--cmd MED005 - Emby server purge with data folder
--cmd MED010 - Stirling PDF tools for viewing and editing PDF files
--cmd MED011 - Stirling PDF remove (http://10.1.0.89:8077)
--cmd MED011 - Stirling PDF remove (http://10.1.0.210:8077)
--cmd MED012 - Stirling PDF purge with data folder
--cmd MED015 - Syncthing continuous file synchronization
--cmd MED016 - Syncthing remove (http://10.1.0.89:8884)
--cmd MED016 - Syncthing remove (http://10.1.0.210:8884)
--cmd MED017 - Syncthing purge with data folder
--cmd MED020 - Nextcloud content collaboration platform
--cmd MED021 - Nextcloud remove (https://10.1.0.89:443)
--cmd MED021 - Nextcloud remove (https://10.1.0.210:443)
--cmd MED022 - Nextcloud purge with data folder
--cmd MED025 - Owncloud share files and folders, easy and secure
--cmd MED026 - Owncloud remove (http://10.1.0.89:7787)
--cmd MED026 - Owncloud remove (http://10.1.0.210:7787)
--cmd MED027 - Owncloud purge with data folder
Monitoring - Real-time monitoring, collecting metrics, up-time status
--cmd MON001 - Uptime Kuma self-hosted monitoring tool
--cmd MON002 - Uptime Kuma remove (http://10.1.0.89:3001)
--cmd MON002 - Uptime Kuma remove (http://10.1.0.210:3001)
--cmd MON003 - Uptime Kuma purge with data folder
--cmd MON005 - Netdata - monitoring real-time metrics
--cmd MON006 - Netdata remove (http://10.1.0.89:19999)
--cmd MON006 - Netdata remove (http://10.1.0.210:19999)
--cmd MON007 - Netdata purge with data folder
--cmd GRA001 - Grafana data analytics
--cmd GRA002 - Grafana remove (http://10.1.0.89:3000)
--cmd GRA002 - Grafana remove (http://10.1.0.210:3000)
--cmd GRA003 - Grafana purge with data folder
Management - Remote Management tools
--cmd MAN001 - Cockpit web-based management tool (http://10.1.0.89:9090)
--cmd MAN001 - Cockpit web-based management tool (http://10.1.0.210:9090)
--cmd MAN005 - Webmin web-based management tool
Printing - Tools for printing and 3D printing
--cmd OCT001 - OctoPrint web-based 3D printers management tool
--cmd OCT002 - OctoPrint remove (http://10.1.0.89:7981)
--cmd OCT002 - OctoPrint remove (http://10.1.0.210:7981)
--cmd OCT003 - OctoPrint purge with data folder
Netconfig - Console network tools for measuring load and bandwidth
--cmd NET001 - nload -realtime console network usage monitor
Expand Down Expand Up @@ -564,9 +576,40 @@ Jobs:
No commands available
~~~
### NE001
### BNS001
Basic Network Setup
Jobs:
~~~
module_simple_network simple
~~~
### BNS002
Remove Fallback DHCP Configuration
Jobs:
~~~
rm -f /etc/netplan/10-dhcp-all-interfaces.yaml
netplan apply
~~~
### VNS001
View Network Settings
Jobs:
~~~
show_message <<< "$(netplan get all)"
~~~
### NEA002
Configure network interfaces
Advanced bridged network configuration
Jobs:
Expand Down Expand Up @@ -812,6 +855,7 @@ These helper functions facilitate various operations related to job management,
| Check for (Whiptail, DIALOG, READ) tools and set the user interface. | | Tearran
| Toggle SSH lastlog | toggle_ssh_lastlog | @Tearran
| Generate this markdown table of all module_options | see_function_table_md | @Tearran
| Netplan wrapper | simple advanced type stations select store restore dhcp static help | @igorpecovnik
| Webmin setup and service setting. | help install remove start stop enable disable status check | @Tearran
| Install HA supervised container | install remove purge status help | @igorpecovnik
| Display a menu from pipe | show_menu <<< armbianmonitor -h ; | @Tearran
Expand Down

0 comments on commit 9fd669b

Please sign in to comment.