feat(ui): customizable dashboard heading and subheading #1235

RezeOW · 2025-08-31T01:06:19Z

Summary

I wanted to edit the dashboard texts, but they were hard coded, so I made them editable via the config.yaml file

Checklist

Tested and/or added tests to validate that the changes work as intended, if applicable.
Updated documentation in README.md, if applicable.

ben-burwood · 2025-10-03T10:28:51Z

Was about to start work on this but then I saw the PR - would be keen for this to get through! :)

Appears to also be requested in #1299

TwiN · 2025-10-20T18:02:32Z

Out of curiosity, what did you want to modify them to? Did you want to completely remove them (i.e. set them to "")?

RezeOW · 2025-10-20T18:21:53Z

I’d like to make the wording clearer for my users, especially the endpoint part. It’s mostly a personal preference, so I thought making it customizable would be best.

justinnamilee · 2025-10-20T19:57:13Z

Would really love the option to modify them, or even hide that whole div to be honest, but would settle for being able to set them blank or to something custom.

For now I've just dropped it entirely with ui.custom-css: 'div[class="flex items-center justify-between mb-6"]{display:none!important}' tho I'm not sure what other implications this would have (if any) at this time, heh, but it seems to do the trick (tho I do lose the toggle for which measurement to use).

TwiN · 2025-10-20T23:38:10Z

config/ui/ui.go

+	defaultTitle       			= "Health Dashboard | Gatus"
+	defaultDescription 			= "Gatus is an advanced automated status page that lets you monitor your applications and configure alerts to notify you if there's an issue"
+	defaultHeader      			= "Gatus"
+	defaultDashboardTitle 		= "Health Dashboard"
+	defaultDashboardDescription = "Monitor the health of your endpoints in real-time"
+	defaultLogo        			= ""
+	defaultLink        			= ""
+	defaultCustomCSS   			= ""
+	defaultSortBy      			= "name"
+	defaultFilterBy    			= "none"


Please align using spaces, not tabs.

TwiN · 2025-10-20T23:38:45Z

config/ui/ui.go

+	Title           		string   `yaml:"title,omitempty"`             		// Title of the page
+	Description     		string   `yaml:"description,omitempty"`       		// Meta description of the page
+	DashboardTitle			string	 `yaml:"dashboard-title,omitempty"`    		// Dashboard Title between header and endpoints
+	DashboardDescription	string	 `yaml:"dashboard-description,omitempty"`   // Dashboard Description between header and endpoints
+	Header          		string   `yaml:"header,omitempty"`            		// Header is the text at the top of the page
+	Logo            		string   `yaml:"logo,omitempty"`              		// Logo to display on the page
+	Link            		string   `yaml:"link,omitempty"`              		// Link to open when clicking on the logo
+	Buttons         		[]Button `yaml:"buttons,omitempty"`           		// Buttons to display below the header
+	CustomCSS       		string   `yaml:"custom-css,omitempty"`        		// Custom CSS to include in the page
+	DarkMode        		*bool    `yaml:"dark-mode,omitempty"`         		// DarkMode is a flag to enable dark mode by default
+	DefaultSortBy   		string   `yaml:"default-sort-by,omitempty"`   		// DefaultSortBy is the default sort option ('name', 'group', 'health')
+	DefaultFilterBy 		string   `yaml:"default-filter-by,omitempty"` 		// DefaultFilterBy is the default filter option ('none', 'failing', 'unstable')


Same alignment comment here

TwiN · 2025-10-20T23:43:44Z

config/ui/ui.go

+	DashboardTitle			string	 `yaml:"dashboard-title,omitempty"`    		// Dashboard Title between header and endpoints
+	DashboardDescription	string	 `yaml:"dashboard-description,omitempty"`   // Dashboard Description between header and endpoints


This should probably be named DashboardHeading and DashboardSubheading.

I assume the config should also reflect this naming?

Maybe even creating an object called dashboard?

dashboard: heading: asdf subheading: hjkl

No need to create a parent dashboard object for now, just dashboard-heading and dashboard-subheading is fine

TwiN · 2025-10-20T23:43:59Z

config/ui/ui_test.go

+		DashboardTitle: "",
+		DashboardDescription: "",


These should be aligned

macmoritz · 2025-10-27T17:32:19Z

@RezeOW could you be so kind and fix the alignment issues soon?

RezeOW · 2025-10-27T19:20:14Z

I am very sorry,
but I am currently pretty busy IRL and dont have the environment at hand to test my changes or build the VUE App.
But I changed the aligning and the naming scheme. If someone could test this, that would be great!

TwiN · 2025-11-05T02:24:28Z

@RezeOW Would you mind fixing the conflict when you have a minute?

RezeOW · 2025-11-13T22:39:47Z

I am gonna be honest, I am not a js dev and I dont want to break your app :(

TwiN · 2025-11-14T01:39:59Z

@RezeOW don't worry about it. I'll fix it when I have some time to work on this (unless somebody beats me to it).

I appreciate the effort nevertheless :)

macmoritz · 2025-11-16T19:13:15Z

@RezeOW I appreciate your work and respect your time in reallife.
But is there any change you could resolve the conflicts soon?
Alternativly it would be great if you could provide @TwiN or me access to your fork, so we can resolve conflicts and get this in quickly.

…hboardSubheading

macmoritz · 2025-11-16T19:56:12Z

@TwiN I've rebased and rebuiled the frontend, should be ready for merge. Would appreciate a quick release, so I can deploy this to production.

@RezeOW thanks for responding fast. I've simply rebased your branch and run make frontend-install && make frontend-build. This way the web/static/js/app.js file with conflicts gets regenerated. Also I tested your changes, works like a charm!

RezeOW · 2025-11-16T19:59:26Z

@macmoritz I appreciate your help, thanks!

TwiN · 2025-11-16T20:30:39Z

Excellent work folks.

tdaskalovaxway · 2025-11-18T16:40:54Z

OMG, I was really looking forward to this feature! Thanks everyone! 🎉 👏

github-actions bot added the feature New feature or request label Aug 31, 2025

TwiN mentioned this pull request Oct 20, 2025

make dashboard header configurable #1351

Closed

TwiN requested changes Oct 20, 2025

View reviewed changes

RezeOW requested a review from TwiN November 3, 2025 19:14

RezeOW and others added 3 commits November 16, 2025 20:45

Made the Dashboard Text customizable

3986c8c

Aligned with spaces, changed feature name to DashboardHeading and Das…

12d9919

…hboardSubheading

rebuild frontend

9f76d25

macmoritz force-pushed the add-customizable-dashboard-text branch from c12179d to 9f76d25 Compare November 16, 2025 19:50

TwiN changed the title ~~feat(config): customizable dashboard texts~~ feat(ui): customizable dashboard texts Nov 16, 2025

TwiN changed the title ~~feat(ui): customizable dashboard texts~~ feat(ui): customizable dashboard heading and subheading Nov 16, 2025

TwiN approved these changes Nov 16, 2025

View reviewed changes

TwiN merged commit 75c1b29 into TwiN:master Nov 16, 2025
3 checks passed

		DashboardTitle string `yaml:"dashboard-title,omitempty"` // Dashboard Title between header and endpoints
		DashboardDescription string `yaml:"dashboard-description,omitempty"` // Dashboard Description between header and endpoints

Uh oh!

feat(ui): customizable dashboard heading and subheading #1235

feat(ui): customizable dashboard heading and subheading #1235

Conversation

RezeOW commented Aug 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

ben-burwood commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TwiN commented Oct 20, 2025

Uh oh!

RezeOW commented Oct 20, 2025

Uh oh!

justinnamilee commented Oct 20, 2025

Uh oh!

TwiN Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

TwiN Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

TwiN Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

RezeOW Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

macmoritz Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

TwiN Oct 23, 2025

Choose a reason for hiding this comment

Uh oh!

TwiN Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

macmoritz commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

RezeOW commented Oct 27, 2025

Uh oh!

TwiN commented Nov 5, 2025

Uh oh!

RezeOW commented Nov 13, 2025

Uh oh!

TwiN commented Nov 14, 2025

Uh oh!

macmoritz commented Nov 16, 2025

Uh oh!

macmoritz commented Nov 16, 2025

Uh oh!

RezeOW commented Nov 16, 2025

Uh oh!

TwiN commented Nov 16, 2025

Uh oh!

Uh oh!

tdaskalovaxway commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

RezeOW commented Aug 31, 2025 •

edited

Loading

ben-burwood commented Oct 3, 2025 •

edited

Loading

macmoritz commented Oct 27, 2025 •

edited

Loading

tdaskalovaxway commented Nov 18, 2025 •

edited

Loading