Skip to content

Commit c7fae7c

Browse files
authored
Override LOCALIPADD with localhost in documentation generation (#657)
1 parent dde4dd7 commit c7fae7c

File tree

2 files changed

+49
-46
lines changed

2 files changed

+49
-46
lines changed

DOCUMENTATION.md

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ Outputs:
415415
--cmd ACC011 - Disable last login banner
416416
--cmd ACC012 - Enable last login banner
417417
--cmd SSH001 - Sandboxed & containerised SSH server
418-
--cmd SSH002 - Remove sandboxed SSH server (ssh://10.1.0.126:2222)
418+
--cmd SSH002 - Remove sandboxed SSH server (ssh://localhost:2222)
419419
--cmd SSH003 - Purge sandboxed SSH server with data folder
420420
User - Change shell, adjust MOTD
421421
--cmd SHELL1 - Change shell system wide to ZSH
@@ -448,7 +448,7 @@ Outputs:
448448
--cmd KEY001 - Change Keyboard layout
449449
--cmd HOS001 - Change System Hostname
450450
451-
Software - Run/Install 3rd party applications (Update the package lists.)
451+
Software - Run/Install 3rd party applications (The package lists are up-to-date.)
452452
Armbian - Armbian infrastructure services
453453
--cmd ART001 - Router for repository mirror automation
454454
--cmd ART002 - Remove CDN router
@@ -458,23 +458,23 @@ Outputs:
458458
--cmd RSD002 - Remove Armbian rsyncd server
459459
Backup - Backup solutions for your data
460460
--cmd DPL001 - Duplicati install
461-
--cmd DPL002 - Duplicati remove (http://10.1.0.126:8200)
461+
--cmd DPL002 - Duplicati remove (http://localhost:8200)
462462
--cmd DPL003 - Duplicati purge with data folder
463463
Containers - Docker containerization and KVM virtual machines
464464
--cmd CON001 - Docker minimal
465465
--cmd CON002 - Docker engine
466466
--cmd CON003 - Docker remove
467467
--cmd CON004 - Docker purge with all images, containers, and volumes
468468
--cmd POR001 - Portainer container management platform
469-
--cmd POR002 - Portainer remove (http://10.1.0.126:9000)
469+
--cmd POR002 - Portainer remove (http://localhost:9000)
470470
--cmd POR003 - Portainer purge with with data folder
471471
DNS - Network-wide ad blockers servers
472472
--cmd ADG001 - AdGuardHome DNS sinkhole
473-
--cmd ADG002 - AdGuardHome remove (http://10.1.0.126:3000)
473+
--cmd ADG002 - AdGuardHome remove (http://localhost:3000)
474474
--cmd ADG003 - AdGuardHome purge with data folder
475475
--cmd PIH001 - Pi-hole DNS ad blocker with Unbound support
476476
--cmd PIH002 - Pi-hole change web admin password
477-
--cmd PIH003 - Pi-hole remove (http://10.1.0.126:8811/admin)
477+
--cmd PIH003 - Pi-hole remove (http://localhost:8811/admin)
478478
--cmd PIH004 - Pi-hole purge with data folder
479479
--cmd UNB001 - Unbound caching DNS resolver
480480
--cmd UNB002 - Unbound remove
@@ -484,10 +484,10 @@ Outputs:
484484
--cmd MYSQL2 - MySQL remove
485485
--cmd MYSQL3 - MySQL purge with data folder
486486
--cmd DAT001 - Mariadb SQL database server
487-
--cmd DAT002 - Mariadb remove (Server: 10.1.0.126)
487+
--cmd DAT002 - Mariadb remove (Server: localhost)
488488
--cmd DAT003 - Mariadb purge with data folder
489489
--cmd MYA001 - phpMyAdmin web interface manager
490-
--cmd MYA002 - phpMyAdmin remove (http://10.1.0.126:8071)
490+
--cmd MYA002 - phpMyAdmin remove (http://localhost:8071)
491491
--cmd MYA003 - phpMyAdmin purge with data folder
492492
--cmd PGSQL1 - PostgreSQL install
493493
--cmd PGSQL2 - PostgreSQL remove
@@ -500,118 +500,118 @@ Outputs:
500500
--cmd GIT002 - Remove tools for cloning and managing repositories (git)
501501
Downloaders - Download apps for movies, TV shows, music and subtitles
502502
--cmd BAZ001 - Bazarr automatic subtitles downloader for Sonarr and Radarr
503-
--cmd BAZ002 - Bazarr remove (http://10.1.0.126:6767)
503+
--cmd BAZ002 - Bazarr remove (http://localhost:6767)
504504
--cmd BAZ003 - Bazarr purge with data folder
505505
--cmd DEL001 - Deluge BitTorrent client
506-
--cmd DEL002 - Deluge remove (http://10.1.0.126:8112)
506+
--cmd DEL002 - Deluge remove (http://localhost:8112)
507507
--cmd DEL003 - Deluge purge with data folder
508508
--cmd DOW001 - qBittorrent BitTorrent client
509-
--cmd DOW002 - qBittorrent remove (http://10.1.0.126:8090)
509+
--cmd DOW002 - qBittorrent remove (http://localhost:8090)
510510
--cmd DOW003 - qBittorrent purge with data folder
511511
--cmd DOW025 - Prowlarr index manager and proxy for PVR
512-
--cmd DOW026 - Prowlarr remove (http://10.1.0.126:9696)
512+
--cmd DOW026 - Prowlarr remove (http://localhost:9696)
513513
--cmd DOW027 - Prowlarr purge with data folder
514514
--cmd JEL001 - Jellyseerr Jellyfin/Emby/Plex integration install
515-
--cmd JEL002 - Jellyseerr remove (http://10.1.0.126:5055)
515+
--cmd JEL002 - Jellyseerr remove (http://localhost:5055)
516516
--cmd JEL003 - Jellyseerr purge with data folder
517517
--cmd LID001 - Lidarr automatic music downloader
518-
--cmd LID002 - Lidarr remove (http://10.1.0.126:8686)
518+
--cmd LID002 - Lidarr remove (http://localhost:8686)
519519
--cmd LID003 - Lidarr purge with data folder
520520
--cmd MDS001 - Medusa automatic downloader for TV shows
521-
--cmd MDS002 - Medusa TV shows downloader remove (http://10.1.0.126:8081)
521+
--cmd MDS002 - Medusa TV shows downloader remove (http://localhost:8081)
522522
--cmd MDS003 - Medusa TV shows downloader purge
523523
--cmd RAD001 - Radarr automatic downloader for movies
524-
--cmd RAD002 - Radarr remove (http://10.1.0.126:7878)
524+
--cmd RAD002 - Radarr remove (http://localhost:7878)
525525
--cmd RAD003 - Radarr purge with data folder
526526
--cmd RDR001 - Readarr automatic downloader for Ebooks
527-
--cmd RDR002 - Readarr remove (http://10.1.0.126:8787)
527+
--cmd RDR002 - Readarr remove (http://localhost:8787)
528528
--cmd RDR003 - Readarr purge with data folder
529529
--cmd SABN01 - SABnzbd newsgroup downloader
530-
--cmd SABN02 - SABnzbd remove (http://10.1.0.126:8380)
530+
--cmd SABN02 - SABnzbd remove (http://localhost:8380)
531531
--cmd SABN03 - SABnzbd purge with data folder
532532
--cmd SON001 - Sonarr automatic downloader for TV shows
533-
--cmd SON002 - Sonarr remove (http://10.1.0.126:8989)
533+
--cmd SON002 - Sonarr remove (http://localhost:8989)
534534
--cmd SON003 - Sonarr purge with data folder
535535
--cmd TRA001 - Transmission BitTorrent client
536-
--cmd TRA002 - Transmission remove (http://10.1.0.126:9091)
536+
--cmd TRA002 - Transmission remove (http://localhost:9091)
537537
--cmd TRA003 - Transmission purge with data folder
538538
Finance - Manage your finances
539539
--cmd ABU001 - Do your finances with Actual Budget
540-
--cmd ABU002 - Actual Budget remove (http://10.1.0.126:5006)
540+
--cmd ABU002 - Actual Budget remove (http://localhost:5006)
541541
--cmd ABU003 - Actual Budget purge with data folder
542542
HomeAutomation - Home Automation for control home appliances
543543
--cmd DOM001 - Domoticz open source home automation
544-
--cmd DOM002 - Domoticz remove (http://10.1.0.126:8780)
544+
--cmd DOM002 - Domoticz remove (http://localhost:8780)
545545
--cmd DOM003 - Domoticz purge with data folder
546546
--cmd EVCC01 - EVCC - solar charging automation
547-
--cmd EVCC02 - EVCC - solar charging automation remove (http://10.1.0.126:7070)
547+
--cmd EVCC02 - EVCC - solar charging automation remove (http://localhost:7070)
548548
--cmd EVCC03 - EVCC purge with data folder
549549
--cmd HAB001 - openHAB empowering the smart home
550-
--cmd HAB002 - openHAB remove (http://10.1.0.126:8080)
550+
--cmd HAB002 - openHAB remove (http://localhost:2080 2443 5007 9123)
551551
--cmd HAB003 - openHAB purge with data folder
552552
--cmd HAS001 - Home Assistant open source home automation
553-
--cmd HAS002 - Home Assistant remove (http://10.1.0.126:8123)
553+
--cmd HAS002 - Home Assistant remove (http://localhost:8123)
554554
--cmd HAS003 - Home Assistant purge with data folder
555555
Management - Remote File & Management tools
556556
--cmd CPT001 - Cockpit OS and VM management tool
557-
--cmd CPT002 - Remove Cockpit (https://10.1.0.126:9890)
557+
--cmd CPT002 - Remove Cockpit (https://localhost:9890)
558558
--cmd CPT003 - Purge Cockpit with virtual machines
559559
--cmd HPG001 - Install Homepage startpage / application dashboard
560-
--cmd HPG002 - Remove Homepage (http://10.1.0.126:3021)
560+
--cmd HPG002 - Remove Homepage (http://localhost:3021)
561561
--cmd HPG003 - Purge Homepage with data folder
562562
--cmd NBOX01 - NetBox infrastructure resource modeling install
563-
--cmd NBOX02 - NetBox remove (http://10.1.0.126:8222)
563+
--cmd NBOX02 - NetBox remove (http://localhost:8222)
564564
--cmd NBOX03 - NetBox purge with data folder
565565
--cmd SMB001 - SAMBA Remote File share
566566
--cmd WBM001 - Webmin web-based management tool
567567
Media - Media servers, organizers and editors
568568
--cmd EMB001 - Emby organizes video, music, live TV, and photos
569-
--cmd EMB002 - Emby server remove (http://10.1.0.126:8091)
569+
--cmd EMB002 - Emby server remove (http://localhost:8091)
570570
--cmd EMB003 - Emby server purge with data folder
571571
--cmd FIL001 - Filebrowser provides a web-based file manager accessible via a browser
572-
--cmd FIL002 - Filebrowser container remove (http://10.1.0.126:8095)
572+
--cmd FIL002 - Filebrowser container remove (http://localhost:8095)
573573
--cmd FIL003 - Filebrowser container purge with data folder
574574
--cmd HPS001 - Hastebin Paste Server
575575
--cmd HPS002 - Hastebin remove
576576
--cmd HPS003 - Hastebin purge with data folder
577577
--cmd IMM001 - Immich - high-performance self-hosted photo and video backup solution
578-
--cmd IMM002 - Immich remove (http://10.1.0.126:8077)
578+
--cmd IMM002 - Immich remove (http://localhost:8077)
579579
--cmd IMM003 - Immich purge with data folder
580580
--cmd JMS001 - Jellyfin Media System
581-
--cmd JMS002 - Jellyfin remove (http://10.1.0.126:8096)
581+
--cmd JMS002 - Jellyfin remove (http://localhost:8096)
582582
--cmd JMS003 - Jellyfin purge with data folder
583583
--cmd NAV001 - Navidrome music server and streamer compatible with Subsonic/Airsonic
584-
--cmd NAV002 - Navidrome remove (http://10.1.0.126:4533)
584+
--cmd NAV002 - Navidrome remove (http://localhost:4533)
585585
--cmd NAV003 - Navidrome purge with data folder
586586
--cmd NCT001 - Nextcloud content collaboration platform
587-
--cmd NCT002 - Nextcloud remove (https://10.1.0.126:1443)
587+
--cmd NCT002 - Nextcloud remove (https://localhost:1443)
588588
--cmd NCT003 - Nextcloud purge with data folder
589589
--cmd OMV001 - Deploy NAS using OpenMediaVault
590-
--cmd OMV002 - OpenMediaVault remove (http://10.1.0.126:80)
590+
--cmd OMV002 - OpenMediaVault remove (http://localhost:80)
591591
--cmd OWC001 - Owncloud share files and folders, easy and secure
592-
--cmd OWC002 - Owncloud remove (http://10.1.0.126:7787)
592+
--cmd OWC002 - Owncloud remove (http://localhost:7787)
593593
--cmd OWC003 - Owncloud purge with data folder
594594
--cmd STC001 - Syncthing continuous file synchronization
595-
--cmd STC002 - Syncthing remove (http://10.1.0.126:8884)
595+
--cmd STC002 - Syncthing remove (http://localhost:8884)
596596
--cmd STC003 - Syncthing purge with data folder
597597
--cmd STR001 - Stirling PDF tools for viewing and editing PDF files
598-
--cmd STR002 - Stirling PDF remove (http://10.1.0.126:8075)
598+
--cmd STR002 - Stirling PDF remove (http://localhost:8075)
599599
--cmd STR003 - Stirling PDF purge with data folder
600600
Monitoring - Real-time monitoring, collecting metrics, up-time status
601601
--cmd GRA001 - Grafana data analytics
602-
--cmd GRA002 - Grafana remove (http://10.1.0.126:3022)
602+
--cmd GRA002 - Grafana remove (http://localhost:3022)
603603
--cmd GRA003 - Grafana purge with data folder
604604
--cmd NAX001 - NetAlertX network scanner & notification framework
605-
--cmd NAX002 - NetAlertX network scanner remove (http://10.1.0.126:20211)
605+
--cmd NAX002 - NetAlertX network scanner remove (http://localhost:20211)
606606
--cmd NAX003 - NetAlertX network scanner purge with data folder
607607
--cmd NTD001 - Netdata - monitoring real-time metrics
608-
--cmd NTD002 - Netdata remove (http://10.1.0.126:19999)
608+
--cmd NTD002 - Netdata remove (http://localhost:19999)
609609
--cmd NTD003 - Netdata purge with data folder
610610
--cmd PRO001 - Prometheus monitoring and alerting toolkit
611-
--cmd PRO002 - Prometheus remove (http://10.1.0.126:9191)
611+
--cmd PRO002 - Prometheus remove (http://localhost:9191)
612612
--cmd PRO003 - Prometheus purge with data folder
613613
--cmd UPK001 - Uptime Kuma self-hosted monitoring tool
614-
--cmd UPK002 - Uptime Kuma remove (http://10.1.0.126:3001)
614+
--cmd UPK002 - Uptime Kuma remove (http://localhost:3001)
615615
--cmd UPK003 - Uptime Kuma purge with data folder
616616
Netconfig - Console network tools for measuring load and bandwidth
617617
--cmd AVH001 - avahi-daemon hostname broadcast via mDNS
@@ -624,7 +624,7 @@ Outputs:
624624
--cmd NLD002 - nload - remove
625625
Printing - Tools for printing and 3D printing
626626
--cmd OCT001 - OctoPrint web-based 3D printers management tool
627-
--cmd OCT002 - OctoPrint remove (http://10.1.0.126:7981)
627+
--cmd OCT002 - OctoPrint remove (http://localhost:7981)
628628
--cmd OCT003 - OctoPrint purge with data folder
629629
VPN - Virtual Private Network tools
630630
--cmd WRG001 - WireGuard VPN server
@@ -639,7 +639,7 @@ Outputs:
639639
--cmd SWAG03 - SWAG remove
640640
--cmd SWAG04 - SWAG purge with data folder
641641
--cmd GHOST1 - Ghost CMS install
642-
--cmd GHOST2 - Ghost CMS remove (http://10.1.0.126:9190/ghost)
642+
--cmd GHOST2 - Ghost CMS remove (http://localhost:9190/ghost)
643643
--cmd GHOST3 - Ghost CMS purge with data folder
644644
645645
Help - About this tool
@@ -1016,7 +1016,7 @@ These helper functions facilitate various operations related to job management,
10161016
| Install stirling container | install remove purge status help | @Frooodle
10171017
| Install sonarr container | install remove purge status help | @armbian
10181018
| Generate Document files. | generate_readme | @Tearran
1019-
| | | @igorpecovnik
1019+
| Storing netplan config to tmp | store_netplan_config | @igorpecovnik
10201020
| Install PostgreSQL container (advanced relational database) | install remove purge status help |
10211021
| Install jellyfin container | install remove purge status help | @armbian
10221022
| Install jellyseerr container | install remove purge status help | @armbian

bin/armbian-config

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ checkpoint mark "Loaded Software helpers..."
5757
#
5858
# Loads the variables from beta armbian-config for runtime handling
5959

60+
# Override LOCALIPADD to use localhost for documentation
61+
[[ "$1" == "--doc" ]] && LOCALIPADD="localhost"
62+
6063
source "$lib_dir/config.runtime.sh"
6164
checkpoint mark "Loaded Runtime conditions..."
6265

0 commit comments

Comments
 (0)