http

Documentation

Overview

Package http manages the motki application web server.

Index

• type Config
• type SSLConfig
  • func (c SSLConfig) TLSConfig() (*tls.Config, error)
• type Server
  • func New(c Config, l log.Logger) (*Server, error)
  • func (s *Server) ListenAndServe() error
  • func (s *Server) ListenAndServeTLS() error
  • func (s *Server) Register(mods ...module) error
  • func (s *Server) Shutdown() error

Types

type Config

type Config struct {
	SSL        SSLConfig       `toml:"ssl"`
	Session    session.Config  `toml:"sessions"`
	Templating template.Config `toml:"templates"`

	ListenAddr string `toml:"listen"`
	Redirect   bool   `toml:"redirect"`
	// contains filtered or unexported fields
}

Config defines the basic configuration for the web server.

type SSLConfig

type SSLConfig struct {
	ListenAddr string   `toml:"listen"`
	AutoCert   bool     `toml:"autocert"`
	CertFile   string   `toml:"certfile"`
	CertKey    string   `toml:"keyfile"`
	RequireSSL bool     `toml:"require"`
	ExtraHosts []string `toml:"extra_hosts"`
	// contains filtered or unexported fields
}

SSLConfig defines a TLS configuration for the web server.

func (SSLConfig) TLSConfig

func (c SSLConfig) TLSConfig() (*tls.Config, error)

TLSConfig attempts to load the configured certificate.

type Server

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

Server is a wrapper used to orchestrate functions of the web server.

func New

func New(c Config, l log.Logger) (*Server, error)

New creates a new web server instance with the given configuration.

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

ListenAndServe begins listening for HTTP requests.

func (*Server) ListenAndServeTLS

func (s *Server) ListenAndServeTLS() error

ListenAndServeTLS begins listening for HTTPS requests.

func (*Server) Register

func (s *Server) Register(mods ...module) error

Register initializes the given modules.

func (*Server) Shutdown

func (s *Server) Shutdown() error

Shutdown attempts to shutdown both the HTTP and HTTPS servers gracefully.