server

Documentation

Index

• type Options
• type ServeOptions
• type Server
  • func NewServer(o Options) (s *Server, err error)
  • func (s *Server) Serve(o ServeOptions) error
  • func (s *Server) Shutdown(ctx context.Context)
  • func (s Server) Version() string

Types

type Options

type Options struct {
	Name                    string
	Version                 string
	BuildInfo               string
	Brand                   string
	Domain                  string
	RedirectToHTTPS         bool
	Headers                 map[string]string
	XSRFCookieName          string
	SessionCookieName       string
	AssetsDir               string
	StaticDir               string
	TemplatesDir            string
	StorageDir              string
	MaintenanceFilename     string
	GoogleAnalyticsID       string
	RememberMeDays          int
	DefaultFrom             string
	ContactRecipientEmail   string
	ACMEDirectoryURL        string
	ACMEDirectoryURLStaging string
	SkipDomainVerification  bool
	VerificationSubdomain   string
	ForbiddenDomains        []string
	TLSEnabled              bool

	EmailService    email.Service
	RecoveryService recovery.Service

	SessionService      session.Service
	UserService         user.Service
	NotificationService notification.Service
	CertificateService  certificate.Service
	PackagesService     packages.Service
}

Options structure contains optional properties for the Server.

type ServeOptions

type ServeOptions struct {
	Listen            string
	ListenTLS         string
	ListenInternal    string
	ListenInternalTLS string
	TLSKey            string
	TLSCert           string
}

ServeOptions structure contains options for HTTP servers when invoking Server.Serve.

type Server

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

Server contains all required properties, services and functions to provide core functionality.

func NewServer

func NewServer(o Options) (s *Server, err error)

NewServer creates a new instance of Server with HTTP handlers.

func (*Server) Serve

func (s *Server) Serve(o ServeOptions) error

Serve starts HTTP servers based on provided ServeOptions properties.

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context)

Shutdown gracefully terminates HTTP servers.

func (Server) Version

func (s Server) Version() string

Version returns service version based on values from version and build information.