ui

Documentation

Index

• Variables
• type Button
  • func (btn *Button) Validate() error
• type Config
  • func GetDefaultConfig() *Config
  • func (cfg *Config) ValidateAndSetDefaults() error

Variables

var (
	ErrButtonValidationFailed = errors.New("invalid button configuration: missing required name or link")
)

Types

type Button

type Button struct {
	Name string `yaml:"name,omitempty"` // Name is the text to display on the button
	Link string `yaml:"link,omitempty"` // Link to open when the button is clicked.
}

Button is the configuration for a button on the UI

func (*Button) Validate

func (btn *Button) Validate() error

Validate validates the button configuration

type Config

type Config struct {
	Title       string   `yaml:"title,omitempty"`       // Title of the page
	Description string   `yaml:"description,omitempty"` // Meta description of the page
	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
}

Config is the configuration for the UI of Gatus

func GetDefaultConfig

func GetDefaultConfig() *Config

GetDefaultConfig returns a Config struct with the default values

func (*Config) ValidateAndSetDefaults

func (cfg *Config) ValidateAndSetDefaults() error

ValidateAndSetDefaults validates the UI configuration and sets the default values if necessary.