consoleweb

Documentation

Index

• Variables
• type Config
• type Server
  • func NewServer(logger *zap.Logger, config Config, service *console.Service, ...) *Server
  • func (s *Server) Close() error
  • func (s *Server) Run(ctx context.Context) error

Variables

var Error = errs.Class("satellite console error")

Error is satellite console error type

Types

type Config

type Config struct {
	Address         string `help:"server address of the graphql api gateway and frontend app" default:"127.0.0.1:8081"`
	StaticDir       string `help:"path to static resources" default:""`
	ExternalAddress string `help:"external endpoint of the satellite if hosted" default:""`

	// TODO: remove after Vanguard release
	AuthToken string `help:"auth token needed for access to registration token creation endpoint" default:""`

	PasswordCost int `internal:"true" help:"password hashing cost (0=automatic)" default:"0"`
}

Config contains configuration for console web server

type Server

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

Server represents console web server

func NewServer

func NewServer(logger *zap.Logger, config Config, service *console.Service, mailService *mailservice.Service, listener net.Listener) *Server

NewServer creates new instance of console server

func (*Server) Close

func (s *Server) Close() error

Close closes server and underlying listener

func (*Server) Run

func (s *Server) Run(ctx context.Context) error

Run starts the server that host webapp and api endpoint