webserver

Documentation

Index

• type CommonArguments
• type WebServer
  • func New(core clientCore, addr, customSiteDir string, logger dex.Logger, ...) (*WebServer, error)
  • func (s *WebServer) Connect(ctx context.Context) (*sync.WaitGroup, error)

Types

type CommonArguments

type CommonArguments struct {
	UserInfo *userInfo
	Title    string
}

CommonArguments are common page arguments that must be supplied to every page to populate the <title> and <header> elements.

type WebServer

type WebServer struct {
	// contains filtered or unexported fields
}

WebServer is a single-client http and websocket server enabling a browser interface to the DEX client.

func New

func New(core clientCore, addr, customSiteDir string, logger dex.Logger, reloadHTML, httpProf bool) (*WebServer, error)

New is the constructor for a new WebServer. customSiteDir can be left blank, in which case a handful of default locations will be checked. This will work in most cases.

func (*WebServer) Connect

func (s *WebServer) Connect(ctx context.Context) (*sync.WaitGroup, error)

Connect starts the web server. Satisfies the dex.Connector interface.