apps

Documentation

Index

• func UnmarshalYAMLFile(configFile string, config interface{}) error
• type Application
• type ApplicationConfig
• type SMTPSettings
  • func NewSMTPSettingsFromFlags(fs *flag.FlagSet) *SMTPSettings

Functions

func UnmarshalYAMLFile

func UnmarshalYAMLFile(configFile string, config interface{}) error

UnmarshalYAMLFile reads a config file and unmarshals it into a config struct

Types

type Application

type Application struct {
	Name       string
	ConfigFile string
}

Application is a structure that contains the info about each supported application and its configuration file.

type ApplicationConfig

type ApplicationConfig interface {
	GetSMTPSettings() *SMTPSettings
	ValidateSMTPSettings() error
}

ApplicationConfig defines a common interface for getting information from the application config

type SMTPSettings

type SMTPSettings struct {
	Host string `default:"localhost"`
	Port int    `default:"25"`
	User string
	Pass string
}

SMTPSettings is a structure that contains the SMTP credentials to use on the SMTP checks

func NewSMTPSettingsFromFlags

func NewSMTPSettingsFromFlags(fs *flag.FlagSet) *SMTPSettings

NewSMTPSettingsFromFlags creates a SMTPSettings from the provided command line flags