service

Documentation

Index

• func RequestLogger(log logging.Logger, inner http.Handler, name string) http.Handler
• type BindAddress
• type Config
• type Environment
  • func NewEnvironment(env *Environment) (*Environment, error)
  • func (env *Environment) RunServers(await bool) func()
• type GlobalConfig
• type HTTPConfig
• type ServerConfig
• type ServicesConfig

Functions

func RequestLogger

func RequestLogger(log logging.Logger, inner http.Handler, name string) http.Handler

Types

type BindAddress

type BindAddress struct {
	Address string
}

BindAddress specifies where the http server should bind to.

type Config

type Config struct {
	Servers        ServerConfig
	Database       database.DatabaseConfig
	Gateway        tmw.TumblerConfig
	Authentication authn.Config
	Session        session.Config
	Notifications  notifications.NotificationsConfig
	Invites        invites.Config
	Services       ServicesConfig
}

Config defines all the configuration for the app

type Environment

type Environment struct {
	Logger       logging.Logger
	Config       *Config
	TimeService  stime.TimeService
	GatewayKeys  webkeys.WebKeysService
	PublicRouter *mux.Router
	Shutdown     func()

	InviteService      invites.InvitesService
	IdentitiesService  identities.Service
	CredentialsService credentials.CredentialsService
}

Environment - Contains everything thats been instantiated for this service.

func NewEnvironment

func NewEnvironment(env *Environment) (*Environment, error)

NewEnvironment - Generates a new default environment. Overrides can be specified via configs.

func (*Environment) RunServers

func (env *Environment) RunServers(await bool) func()

RunServers - Boots up all the servers and awaits till they are stopped.

type GlobalConfig

type GlobalConfig struct {
	Identity Config
}

type HTTPConfig

type HTTPConfig struct {
	Bind BindAddress
}

HTTPConfig configuration for running an http server

type ServerConfig

type ServerConfig struct {
	Public HTTPConfig
	Admin  HTTPConfig
}

ServerConfig - Groups all the http configs for the servers and ports that get opened.

type ServicesConfig

type ServicesConfig struct {
	Authn string
}