notifications

package

v1.7.1 Latest Latest Go to latest Published: Nov 11, 2023 License: Apache-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const ColorHex = "#406170"

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

View Source

const ColorInt = 0x406170

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

View Source

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

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

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

AppendLegacyUrls creates shoutrrr equivalent URLs from legacy notification flags

func GetDelay(c *cobra.Command, legacyDelay time.Duration) time.Duration

GetDelay returns the legacy delay if defined, otherwise the delay as set by args is returned

func GetScheme(url string) string

GetScheme returns the scheme part of a Shoutrrr URL

func GetTitle(hostname string, tag string) string

GetTitle formats the title based on the passed hostname and tag

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

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

type Data struct {
	StaticData
	Entries []*log.Entry
	Report  t.Report
}

Data is the notification template data model

func (d Data) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

type StaticData struct {
	Title string
	Host  string
}

StaticData is the part of the notification template data model set upon initialization

func GetTemplateData(c *cobra.Command) StaticData

GetTemplateData populates the static notification data from flags and environment