app

Documentation

Index

• func GetEnv() (requested bool)
• func HelpRequested() (help bool)
• func MonitorResources(c context.T)
• func NewConfig() (cfg *Config, err E)
• func PrintEnv(cfg *Config, printer io.Writer)
• func PrintHelp(cfg *Config, printer io.Writer)
• type B
• type Config
• type Ctx
• type E
• type N
• type Relay
  • func (r *Relay) AcceptEvent(c context.T, evt *event.T, hr *http.Request, origin S, authedPubkey B) (accept bool, notice S, afterSave func())
  • func (r *Relay) AcceptReq(c Ctx, hr *http.Request, idB, ff *filters.T, authedPubkey B) (allowed *filters.T, ok bool)
  • func (r *Relay) AuthEnabled() bool
  • func (r *Relay) CheckOwnerLists(c context.T)
  • func (r *Relay) Init() (err E)
  • func (r *Relay) Name() S
  • func (r *Relay) ServiceUrl(req *http.Request) (s S)
  • func (r *Relay) Storage(c context.T) store.I
• type S

Functions

func GetEnv

func GetEnv() (requested bool)

func HelpRequested

func HelpRequested() (help bool)

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

func MonitorResources

func MonitorResources(c context.T)

func NewConfig

func NewConfig() (cfg *Config, err E)

func PrintEnv

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

func PrintHelp

func PrintHelp(cfg *Config, 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 B

type B = []byte

type Config

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

type Ctx

type Ctx = context.T

type E

type E = error

type N

type N = int

type Relay

type Relay struct {
	sync.Mutex
	*Config
	Store store.I
	// Owners' pubkeys
	Owners          []B
	Followed, Muted map[S]struct{}
	// OwnersFollowLists are the event IDs of owners follow lists, which must not be deleted, only
	// replaced.
	OwnersFollowLists []B
	// OwnersMuteLists are the event IDs of owners mute lists, which must not be deleted, only
	// replaced.
	OwnersMuteLists []B
}

func (*Relay) AcceptEvent

func (r *Relay) AcceptEvent(c context.T, evt *event.T, hr *http.Request, origin S,
	authedPubkey B) (accept bool, notice S, afterSave func())

func (*Relay) AcceptReq

func (r *Relay) AcceptReq(c Ctx, hr *http.Request, idB, ff *filters.T,
	authedPubkey B) (allowed *filters.T, ok bool)

func (*Relay) AuthEnabled

func (r *Relay) AuthEnabled() bool

func (*Relay) CheckOwnerLists

func (r *Relay) CheckOwnerLists(c context.T)

CheckOwnerLists regenerates the owner follow and mute lists if they are empty.

It also adds the followed npubs of the follows.

func (*Relay) Init

func (r *Relay) Init() (err E)

func (*Relay) Name

func (r *Relay) Name() S

func (*Relay) ServiceUrl

func (r *Relay) ServiceUrl(req *http.Request) (s S)

ServiceUrl returns the address of the relay to send back in auth responses. If auth is disabled this returns an empty string.

func (*Relay) Storage

func (r *Relay) Storage(c context.T) store.I

type S

type S = string