-
-
Notifications
You must be signed in to change notification settings - Fork 592
feat(config): customizable dashboard texts #1235
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
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 |
Out of curiosity, what did you want to modify them to? Did you want to completely remove them (i.e. set them to |
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. |
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 |
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" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please align using spaces, not tabs.
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') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same alignment comment here
DashboardTitle string `yaml:"dashboard-title,omitempty"` // Dashboard Title between header and endpoints | ||
DashboardDescription string `yaml:"dashboard-description,omitempty"` // Dashboard Description between header and endpoints |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should probably be named DashboardHeading
and DashboardSubheading
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I assume the config should also reflect this naming?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe even creating an object called dashboard
?
dashboard:
heading: asdf
subheading: hjkl
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need to create a parent dashboard
object for now, just dashboard-heading
and dashboard-subheading
is fine
DashboardTitle: "", | ||
DashboardDescription: "", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These should be aligned
Summary
I wanted to edit the dashboard texts, but they were hard coded, so I made them editable via the config.yaml file
Checklist
README.md
, if applicable.