config

package

v1.3.1 Latest Latest Go to latest Published: Sep 5, 2023 License: AGPL-3.0 Imports: 6 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

This section is empty.

This section is empty.

func OnConfigChange(callback OnConfigChangeFunc)

OnConfigChange can be used to attach a callback function which is called whenever the config changes

func PathUsed() string

PathUsed returns the used config path

func SetConfig(c *Config)

SetConfig sets the config to c

func Setup(configPath string) error

Setup reads the config file and parses it

func SetupWithName(configPath string, configName string) error

SetupWithName reads the config file and parses it and allows to set the name

type Config struct {
	Listen ListenConfig
	Forms  []*FormConfig
}

Config is the type which contains all above sub-configs

func DefaultConfig() *Config

DefaultConfig returns the default config

func GetConfig() *Config

GetConfig returns the config

type FormConfig struct {
	Enabled   bool
	ID        string
	Turnstile TurnstileConfig
	Targets   []*TargetConfig
}

FormConfig is the config of a form

type ListenConfig struct {
	Host                string
	Port                int
	UseForwardedHeaders bool
}

ListenConfig is for the server

type OnConfigChangeFunc func(event fsnotify.Event, config *Config, oldConfig *Config)

OnConfigChangeFunc is the type of a function which can be used as a callback

type TargetConfig struct {
	Enabled     bool
	Template    string
	ShoutrrrURL string
	Params      map[string]interface{}
}

TargetConfig is the config of a shoutrrr target

type TurnstileConfig struct {
	Enabled   bool
	SecretKey string
}

TurnstileConfig is the config for HCapthca