luna

Documentation

Index

• Constants
• func GenericNotificationsEnabled() bool
• func ItsUsedTrustMeBro(...any)
• func LoadDotEnv(path string) error
• func LoadDotEnvIfExists(path string) error
• func Main() int
• func NotificationsEnabledForWidget(widgetType string) bool
• func SendAppriseNotification(settings notificationSettings, title string, body string, notifyType string) error
• func SendWidgetNotification(widgetType string, title string, body string, notifyType string)
• func ShouldUseGenericNotifications(widgetType string) bool
• func StringSetChanged(previous, current map[string]struct{}) bool
• type CustomAPIRequest
• type MarketProvider
• type RateLimitConfig
• type SearchBang
• type SiteStatusRequest

Constants

const AUTH_RATE_LIMIT_MAX_ATTEMPTS = 5

const AUTH_RATE_LIMIT_WINDOW = 5 * time.Minute

const AUTH_SECRET_KEY_LENGTH = AUTH_TOKEN_SECRET_LENGTH + AUTH_USERNAME_HASH_LENGTH

const AUTH_SESSION_COOKIE_NAME = "session_token"

const AUTH_TIMESTAMP_LENGTH = 4 // uint32

const AUTH_TOKEN_DATA_LENGTH = AUTH_USERNAME_HASH_LENGTH + AUTH_TIMESTAMP_LENGTH

const AUTH_TOKEN_REGEN_BEFORE = 7 * 24 * time.Hour // 7 days

How long the token has left before it should be regenerated

const AUTH_TOKEN_SECRET_LENGTH = 32

const AUTH_TOKEN_VALID_PERIOD = 14 * 24 * time.Hour // 14 days

How long the token will be valid for

const AUTH_USERNAME_HASH_LENGTH = 32

const CONFIG_INCLUDE_RECURSION_DEPTH_LIMIT = 20

const STATIC_ASSETS_CACHE_DURATION = 24 * time.Hour

Functions

func GenericNotificationsEnabled

func GenericNotificationsEnabled() bool

func ItsUsedTrustMeBro

func ItsUsedTrustMeBro(...any)

Having compile time errors about unused variables is cool and all, but I don't want to have to constantly comment out my code while I'm working on it and testing things out

func LoadDotEnv

func LoadDotEnv(path string) error

LoadDotEnv loads environment variables from a .env file without overriding existing values. It is a minimal parser intended for simple KEY=VALUE lines.

func LoadDotEnvIfExists

func LoadDotEnvIfExists(path string) error

func Main

func Main() int

func NotificationsEnabledForWidget

func NotificationsEnabledForWidget(widgetType string) bool

func SendAppriseNotification

func SendAppriseNotification(settings notificationSettings, title string, body string, notifyType string) error

func SendWidgetNotification

func SendWidgetNotification(widgetType string, title string, body string, notifyType string)

func ShouldUseGenericNotifications

func ShouldUseGenericNotifications(widgetType string) bool

func StringSetChanged

func StringSetChanged(previous, current map[string]struct{}) bool

Types

type CustomAPIRequest

type CustomAPIRequest struct {
	URL                string               `yaml:"url"`
	AllowInsecure      bool                 `yaml:"allow-insecure"`
	Headers            map[string]string    `yaml:"headers"`
	Parameters         queryParametersField `yaml:"parameters"`
	Method             string               `yaml:"method"`
	BodyType           string               `yaml:"body-type"`
	Body               any                  `yaml:"body"`
	SkipJSONValidation bool                 `yaml:"skip-json-validation"`
	// contains filtered or unexported fields
}

Needs to be exported for the YAML unmarshaler to work

type MarketProvider

type MarketProvider interface {
	// FetchMarkets retrieves market data for the given symbols.
	// apiKey may be empty for providers that don't require one.
	FetchMarkets(requests []marketRequest, apiKey string) (marketList, error)
}

MarketProvider is the interface all market data providers must implement. To add a new provider:

1. Create a new file: market-provider-<name>.go
2. Implement this interface
3. Call registerMarketProvider("<name>", &yourProvider{}) in an init() func

type RateLimitConfig

type RateLimitConfig struct {
	MaxCredits   int           // bucket size (burst capacity)
	RefillRate   int           // credits added per refill period
	RefillPeriod time.Duration // how often credits are refilled
}

RateLimitConfig defines rate limiting parameters for a provider.

type SearchBang

type SearchBang struct {
	Title    string
	Shortcut string
	URL      string
}

type SiteStatusRequest

type SiteStatusRequest struct {
	DefaultURL    string        `yaml:"url"`
	CheckURL      string        `yaml:"check-url"`
	AllowInsecure bool          `yaml:"allow-insecure"`
	Timeout       durationField `yaml:"timeout"`
	BasicAuth     struct {
		Username string `yaml:"username"`
		Password string `yaml:"password"`
	} `yaml:"basic-auth"`
}