Dietpi banner upgrades by timjolson · Pull Request #8172 · MichaIng/DietPi

timjolson · 2026-06-08T03:11:54Z

Enhancing dietpi-banner.

Changed custom entry to accept multiple commands
Added network usage by namespace
Added disk usage by pattern matching
Added systemd and fail2ban status
Standardized printing
Organized color resources
Added G_TRUNCATE_MID

timjolson · 2026-06-09T18:53:06Z

Outstanding items I know of:

no IPv6 detection for the network traffic, only ipv4
dynamic disk space usage is independent of the pre-existing disk space entries (what do we do with the existing options?)
wrapping has not been tested or dealt with
IP address and network information (retrieval and parsing) use different methods than are pre-existing in the script - need to work through what might be more robust / efficient and consolidate to helper functions
no handling of permissions checking is in place yet
there sometimes is an issue with the terminal not being properly cleared when running dietpi-banner 1, probably applies to dietpi-banner 0, as well. The issue occurs often when using VSCode and has not been verified in other terminals.

MichaIng

A great extension! But there is some cleanup/polishing needed to reduce the overhead (in code an UI), and make it work for expected use cases.

MichaIng · 2026-07-09T21:30:59Z

Just as an overview, the things I'd still want to do before merging. But will do so before DietPi v10.6 release (which will be delayed anyway because of a spontaneous holiday trip consuming some time this week):

Move array index migration to https://github.com/MichaIng/DietPi/blob/master/.update/patches, so we do not need to carry the code here, but just do this once with a sed loop or so.
Migrate existing /boot/dietpi/.dietpi-banner_custom and aDESCRIPTION[10] into the new custom command array.
Migrate/Replace aENABLED[disk_rootfs] and aENABLED[disk_userdata] with aDISK_SPACE_PATTERNS.
When adding a disk space pattern, findmnt -nro TARGET --real output lines, which are not matched yet, are offered in the menu directly, with "custom" allowing to enter a custom pattern. I'd also list all active pattern in the primary menu, showing the inputbox to edit them on select, removing them by emptying the inputbox, + the "Add" entry.
Instead of scraping the df output, findmnt -nro TARGET,USED,SIZE,USE% --real might be the cleaner alternative. Though, interestingly it is much slower as I just recognized, taking about 3x more time to process. Alternative is df -h --output=target,used,size,pcent, and we skip the redundancy math + skip separate percent calculation? There is no reason to assume used or size wouldn't be available. Or if used wouldn't be for some special mounts, avail wouldn't be available either. If higher precision and/or aligned unit is wanted the -m flag could be used instead of -h to get MiB values, which can then be converted to GiB slightly simpler.
Add IPv6 support for network usage and Fail2Ban stats.
Reduce sudo calls in Print_Network_Usage: If namespaces are used, check via sudo -n -v once whether the current user can use sudo. If so, do the whole namespace processing loop in a single sudo -n dash -c 'declare -f func; func' 2>&1 call. Else, process the default namespace only.

MichaIng · 2026-07-11T11:37:07Z

I went through the open points you mentioned at the top. Regarding clearing the terminal in VS Code: See G_TERM_CLEAR() in dietpi-globals: It uses ANSI escape sequences, \n and \e[H to move the content into the scrollback buffer (where available) and move the cursor back to the top, rather than clear. I found it preferrable to keep the possibility to scroll back, rather then erasing the content. But it performs worse on certain terminals, where the content is visibly moved line by line. Possible that this does not work well in some dev terminals.

…d a safer delimiter

…ttern submenu. added migration of disk_rootfs and disk_userdata (removed them from the menu).

…hed aCUSTOM_COMMANDS to use associative indices to take advantage of Print_Item_State for display consistency; still TODO: update the submenu for associative indexing

…upgraded custom commands submenu to match the style of disk_usage patterns submenu; added custom command migration (needs testing)

…the banner is displayed

…s handled in Print_Banner, and `dietpi-banner 0` should not care

… surrounded by whitespace sometimes

* "systemd" is explicitly written with a lower-case "s". It would be "okay" to use an upper-case "s" at the beginning of a sentence, but we keep strict lower-case everywhere else in DietPi texts as well. To quote the makers: "The only situation where we find it OK to use an uppercase letter in the name (but don't like it either) is if you start a sentence with systemd." * Use single-quotes for string, where no variable expension is intended, except in (the left-side of) bash conditionals "[[ ]]", where quotation has no effect. * newline after loop condition before "do", same like after if condition before "then" * Skip double-quotes when assigning a single variable or command substitution, as it is not needed in this case. Skip as well for "case" input pattern, where it is not needed either. * Replace some on-line if-then(-else) with && (||) * Skip "-n" and "-z" in bash conditionals, only use "!" to check for empty expressions. Also avoid redundant "${var:-}" to replace an empty variable with an empty string, redundant in modern shells. * Avoid muting STDERR where it is not expected (findmnt call), especially for testing/beta phase * Use "$" for variable calls in bash arithmetics as well. It is not needed, but makes it easier to distinguish between variable calls and assignments when reviewing a script, especially if editors do syntax highlighting, or when searching for those via grep. * Use %s for printf placeholders instead of %b, if no ANSI code expansion or similar is expected. * Use -v flag explicitly when "unset"ing variables. Very rare chance that the same name is used for a function, especially in a called (instead of sourced) script, but I started with this convention at some point.

* Always print closing CLI_LINE, as it was done before. The multi-line blocks with subheader print a leading CLI_LINE but no trailing one. * Restore empty line before credits, update notifications, dietpi-* commands, but remove additional newline after banner (the migration messages will be removed, all done during dietpi-update). If a color reset is missing somewhere, we should fix it in the respective Print_* command, but so far I couldn't find any, especially after Print_Custom_Commands uses Print_Item_State as well.

…" is used The dark gray really is dark. For info which was explicitly selected by users, use the default white/bright grey, like all of the upper entry values do. This is already different from the "highlight" and "alert" colors used for all other output states where "weak" was used, so this does not cause overlaps. Keep "weak" color for the credits only as before. If we want to use it more widely in the banner, IMO never for keys or values, only for separation/ordering symbols or such things.

The ASCII V and W contain literal upper-case V characters.

* IPv6 are not trivial to match selectively, due to the possible shortenings of 0000 hextets, even on both ends. * For Fail2Ban stats, it makes sense to match those widely, to not miss if e.g. the localhost itself got banned. The output syntax is luckily specific enough for this to still reliably only match the banned IPs. * "ip -br a" has simple output format as well, with the 1st IP being the 3rd argument. There is no need to filter this, it is either an IP or empty. * For matching public IPs, the regex for IPv6 can be narrowed down much, since only the 2000::/3 block is globally routable. * Merge Get_WAN_IP and printing the IP address line into Print_Data_Usage, to deduplicate the ns_cmd_prefix crafting. Sadly, the whole function cannot simply be called with the namespace prefix, since we'd need to add all used functions and variables into the subshell, too. It would require some reorder for this to be reasonable, e.g. to obtain only the raw values with a simple dash-compatible function, and craft the colored output lines afterwards in the parent function. But this can be done in a future PR. * Make some variables local, and omit or rename some others

MichaIng · 2026-07-30T23:21:12Z

Ah dammit, I never think about that rebasing always causes a pain when aiming to sync it back to a(nother) local client 🙈. Sorry.

W was accidentally excluded

Make MENU_ITEMS array readonly, along with some other variables that are not intended to be change. Remove "unknown menu selection" error and "every other valid one" match instead. There is not really a way whiptail can return a value other than what MENU_ITEMS contains, and it makes maintainance/adding new items easier. If we'd really want to make a failsafe check for debugging purpose, we should instead check whether the returned value is in the MENU_ITEMS array.

It overrides "--real" and shows tmpfs and udev mountpoints that way, which are not commonly interesting for disk space info.

MichaIng · 2026-07-31T00:01:35Z

Okay, only left point from my end is to move the migration into dietpi-update patches. I'll do that tomorrow.

MichaIng added the Feature request 🏭 label Jun 8, 2026

MichaIng linked an issue Jun 8, 2026 that may be closed by this pull request

DietPi-Banner | Add Custom Scripts #8107

Open

MichaIng added the dietpi-banner label Jun 8, 2026

MichaIng assigned timjolson Jun 8, 2026

MichaIng mentioned this pull request Jun 12, 2026

Additions to the contributing guide #8171

Merged

MichaIng added this to the v10.6 milestone Jun 15, 2026

timjolson commented Jun 21, 2026

View reviewed changes

Comment thread dietpi/func/dietpi-banner Outdated

MichaIng force-pushed the dietpi-banner branch from e0362d6 to 4fbf03a Compare June 25, 2026 22:42

MichaIng requested changes Jun 26, 2026

View reviewed changes

MichaIng reviewed Jun 26, 2026

View reviewed changes

Comment thread dietpi/func/dietpi-banner Outdated

timjolson force-pushed the dietpi-banner branch from 7b2dccf to c53eca9 Compare June 30, 2026 20:14

MichaIng force-pushed the dietpi-banner branch 2 times, most recently from 3dde41b to 78d815c Compare July 7, 2026 15:46

MichaIng reviewed Jul 7, 2026

View reviewed changes

Comment thread dietpi/func/dietpi-globals Outdated

MichaIng force-pushed the dietpi-banner branch 2 times, most recently from 68a40de to 2cdb0c2 Compare July 9, 2026 16:18

MichaIng reviewed Jul 9, 2026

View reviewed changes

Comment thread dietpi/func/dietpi-banner Outdated

MichaIng reviewed Jul 9, 2026

View reviewed changes

Comment thread dietpi/func/dietpi-banner Outdated

MichaIng force-pushed the dietpi-banner branch from 2cdb0c2 to 284d4c7 Compare July 9, 2026 16:27

MichaIng reviewed Jul 9, 2026

View reviewed changes

Comment thread dietpi/func/dietpi-banner

MichaIng reviewed Jul 9, 2026

View reviewed changes

Comment thread dietpi/func/dietpi-banner Outdated

MichaIng reviewed Jul 9, 2026

View reviewed changes

Comment thread dietpi/func/dietpi-banner Outdated

MichaIng reviewed Jul 9, 2026

View reviewed changes

Comment thread dietpi/func/dietpi-banner Outdated

timjolson commented Jul 10, 2026

View reviewed changes

Comment thread dietpi/func/dietpi-banner Outdated

MichaIng reviewed Jul 10, 2026

View reviewed changes

Comment thread dietpi/func/dietpi-banner Outdated

MichaIng closed this Jul 11, 2026

MichaIng reopened this Jul 11, 2026

timjolson and others added 21 commits July 31, 2026 01:20

added configured but not matched mounts to the disk usage output. use…

914ce86

…d a safer delimiter

re-used Bytes_To_GiB

78a8045

re-used Bytes_To_GiB

77bc1e3

upgraded disk usage menu to list available mounts. simplified disk pa…

75343bd

…ttern submenu. added migration of disk_rootfs and disk_userdata (removed them from the menu).

added transient migration (every run) of .dietpi-banner_custom; switc…

42b2ce8

…hed aCUSTOM_COMMANDS to use associative indices to take advantage of Print_Item_State for display consistency; still TODO: update the submenu for associative indexing

upgraded custom commands for associative array and Print_Item_State; …

e969102

…upgraded custom commands submenu to match the style of disk_usage patterns submenu; added custom command migration (needs testing)

added custom command migration warning

5bd6cb3

Fixed migrated command not running after going through the menu.

5593399

quote custom command outputs for safety

2df5573

keep migration warnings when user has gone through the menu and then …

16fa623

…the banner is displayed

cleaning up separator lines

ed26433

LAN ip was not being printed with dietpi-banner 0. aENABLED check i…

fd9bbba

…s handled in Print_Banner, and `dietpi-banner 0` should not care

reset text color after the banner

1d2961f

organized and updated CONTRIBUTING.md

29de14f

fixed Disk Usage not working with word-wrap due to format codes being…

06a431c

… surrounded by whitespace sometimes

dietpi-banner: fix ASCII letter detection

7b71c6b

The ASCII V and W contain literal upper-case V characters.

dietpi-banner: fix variable names

d041c3d

MichaIng force-pushed the dietpi-banner branch from 169c5a2 to d041c3d Compare July 30, 2026 23:20

MichaIng reviewed Jul 30, 2026

View reviewed changes

Comment thread CONTRIBUTING.md Outdated

MichaIng added 5 commits July 31, 2026 01:29

dietpi-banner: little ASCII pattern fix

cac2d7e

W was accidentally excluded

dietpi-banner: typo

644bb17

dietpi-banner: remove -D flag from findmnt

7a1fbb6

It overrides "--real" and shows tmpfs and udev mountpoints that way, which are not commonly interesting for disk space info.

Update CONTRIBUTING.md

e738639

Uh oh!

Conversation

timjolson commented Jun 8, 2026

Uh oh!

timjolson commented Jun 9, 2026 • edited by MichaIng Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

MichaIng left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MichaIng commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MichaIng commented Jul 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MichaIng commented Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

MichaIng commented Jul 31, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

timjolson commented Jun 9, 2026 •

edited by MichaIng

Loading

MichaIng commented Jul 9, 2026 •

edited

Loading

MichaIng commented Jul 11, 2026 •

edited

Loading

MichaIng commented Jul 30, 2026 •

edited

Loading