ui

Documentation

Index

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

Variables

var (
	// StaticFolder is the path to the location of the static folder from the root path of the project
	// The only reason this is exposed is to allow running tests from a different path than the root path of the project
	StaticFolder = "./web/static"
)

Types

type Config

type Config struct {
	Title  string `yaml:"title,omitempty"`  // Title 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
}

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.