config

Documentation

Index

• type DB
  • func NewDB(opts ...Option) (DB, error)
  • func (db DB) DSN() string
  • func (db DB) Driver() string
• type Logger
  • func NewLogger(opts ...Option) (Logger, error)
  • func (l Logger) Format() string
  • func (l Logger) Level() string
• type Option
  • func WithPrefix(prefix string) Option
• type Options
• type Server
  • func NewServer(opts ...Option) (Server, error)
  • func (s Server) Addr() string
• type TLS
  • func NewTLS(opts ...Option) (TLS, error)
  • func (t TLS) CACert() string
  • func (t TLS) Cert() string
  • func (t TLS) Key() string
  • func (t TLS) TLSConfig(opts ...TLSOption) (*tls.Config, error)
• type TLSOption
  • func WithMTLS() TLSOption

Types

type DB

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

DB holds the configuration settings needed to connect to a database.

func NewDB

func NewDB(opts ...Option) (DB, error)

NewDB returns the db configuration.

func (DB) DSN

func (db DB) DSN() string

DSN returns the datasource name for the database. The value is set from the <PREFIX_>DB_DSN environment variable.

func (DB) Driver

func (db DB) Driver() string

Driver returns the database driver. The value is set from the <PREFIX_>DB_DRIVER environment variable.

type Logger

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

Logger holds the configuration information for a logger.

func NewLogger

func NewLogger(opts ...Option) (Logger, error)

NewLogger returns the configuration of a logger.

func (Logger) Format

func (l Logger) Format() string

Format returns the logging format for the logger. The value is set from the <PREFIX_>LOG_FORMAT environment variable.

func (Logger) Level

func (l Logger) Level() string

Level returns the logging level for the logger. The value is set from the <PREFIX_>LOG_LEVEL environment variable.

type Option

type Option interface {
	Apply(*Options)
}

Option provides options when loading configuration information.

func WithPrefix

func WithPrefix(prefix string) Option

WithPrefix adds a prefix to the name of the enviroment variables being referenced.

type Options

type Options struct {
	// Prefix, if set, will require the prefix to be present in the name of the
	// environment variables associated with the config object.
	Prefix string
}

Options hold the config package options.

type Server

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

Server holds the configuration settings for a server.

func NewServer

func NewServer(opts ...Option) (Server, error)

NewServer returns the server configuration.

func (Server) Addr

func (s Server) Addr() string

Addr returns the network address the server will listen on. The value is set from the <PREFIX_>SERVER_ADDR environment variable.

type TLS

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

TLS holds the configuration settings for a TLS Cert.

func NewTLS

func NewTLS(opts ...Option) (TLS, error)

NewTLS returns the tls configuration.

func (TLS) CACert

func (t TLS) CACert() string

CACert returns the path of the certificate of the CA certificate file. This is used when creating a TLS connection with an entity that is presenting a certificate that is not signed by a well known CA available in the OS CA bundle. The value is set from the <PREFIX_>TLS_CACERT environment variable.

func (TLS) Cert

func (t TLS) Cert() string

Cert returns the path of the certificate file. The value is set from the <PREFIX_>TLS_CERT environment variable.

func (TLS) Key

func (t TLS) Key() string

Key returns the path of the certificate key file. The value is set from the <PREFIX_>TLS_KEY environment variable.

func (TLS) TLSConfig

func (t TLS) TLSConfig(opts ...TLSOption) (*tls.Config, error)

TLSConfig will create a *tls.Config given the options. This will return an error if there is a problem loading the required certificate files. If the WithMTLS option is specified, a client CA cert is required.

type TLSOption

type TLSOption interface {
	Apply(*tls.Config)
}

TLSOption provides options for configuring the creation of a tls.Config.

func WithMTLS

func WithMTLS() TLSOption

WithMTLS will setup the tls.Config to require and verify client connections.