notifications

Documentation

Index

• Constants
• Variables
• func AppendLegacyUrls(urls []string, cmd *cobra.Command, title string) ([]string, time.Duration)
• func GetHostname(c *cobra.Command) string
• func GetScheme(url string) string
• func GetTitle(hostname string) string
• func NewNotifier(c *cobra.Command) ty.Notifier
• type Data

Constants

const ColorHex = "#406170"

ColorHex is the default notification color used for services that support it (formatted as a CSS hex string)

const ColorInt = 0x406170

ColorInt is the default notification color used for services that support it (as an int value)

Variables

var LocalLog = log.WithField("notify", "no")

LocalLog is a logrus logger that does not send entries as notifications

Functions

func AppendLegacyUrls

func AppendLegacyUrls(urls []string, cmd *cobra.Command, title string) ([]string, time.Duration)

AppendLegacyUrls creates shoutrrr equivalent URLs from legacy notification flags

func GetHostname

func GetHostname(c *cobra.Command) string

GetHostname returns the hostname as set by args or resolved from OS

func GetScheme

func GetScheme(url string) string

GetScheme returns the scheme part of a Shoutrrr URL

func GetTitle

func GetTitle(hostname string) string

GetTitle returns a common notification title with hostname appended

func NewNotifier

func NewNotifier(c *cobra.Command) ty.Notifier

NewNotifier creates and returns a new Notifier, using global configuration.

Types

type Data

type Data struct {
	Entries []*log.Entry
	Report  t.Report
	Title   string
	Host    string
}

Data is the notification template data model