config

Documentation

Index

• func GetEnv() (requested bo)
• func HelpRequested() (help bo)
• func PrintEnv(cfg *C, printer io.Writer)
• func PrintHelp(cfg *C, printer io.Writer)
• type C
  • func New() (cfg *C, err er)

Functions

func GetEnv

func GetEnv() (requested bo)

func HelpRequested

func HelpRequested() (help bo)

HelpRequested returns true if any of the common types of help invocation are found as the first command line parameter/flag.

func PrintEnv

func PrintEnv(cfg *C, printer io.Writer)

func PrintHelp

func PrintHelp(cfg *C, printer io.Writer)

PrintHelp outputs a help text listing the configuration options and default values to a provided io.Writer (usually os.Stderr or os.Stdout).

Types

type C

type C struct {
	AppName        st   `env:"APP_NAME" default:"realy"`
	Profile        st   `env:"PROFILE" usage:"root path for all other path configurations (based on APP_NAME and OS specific location)"`
	Listen         st   `env:"LISTEN" default:"0.0.0.0" usage:"network listen address"`
	Port           no   `env:"PORT" default:"3334" usage:"port to listen on"`
	AdminUser      st   `env:"ADMIN_USER" default:"admin" usage:"admin user"`
	AdminPass      st   `env:"ADMIN_PASS" usage:"admin password"`
	LogLevel       st   `env:"LOG_LEVEL" default:"info" usage:"debug level: fatal error warn info debug trace"`
	DbLogLevel     st   `env:"DB_LOG_LEVEL" default:"info" usage:"debug level: fatal error warn info debug trace"`
	AuthRequired   bo   `` /* 161-byte string literal not displayed */
	Owners         []st `` /* 284-byte string literal not displayed */
	FollowsFollows bo   `` /* 134-byte string literal not displayed */
	DBSizeLimit    no   `` /* 149-byte string literal not displayed */
	DBLowWater     no   `env:"DB_LOW_WATER" default:"60" usage:"the percentage of DBSizeLimit a GC run will reduce the used storage down to"`
	DBHighWater    no   `env:"DB_HIGH_WATER" default:"80" usage:"the trigger point at which a GC run should start if exceeded"`
	GCFrequency    no   `env:"GC_FREQUENCY" default:"3600" usage:"the frequency of checks of the current utilisation in minutes"`
	Pprof          bo   `env:"PPROF" default:"false" usage:"enable pprof on 127.0.0.1:6060"`
	MemLimit       no   `env:"MEMLIMIT" default:"250000000" usage:"set memory limit, default is 250Mb"`
	NWC            st   `env:"NWC" usage:"NWC connection string for relay to interact with an NWC enabled wallet"`
}

func New

func New() (cfg *C, err er)