config

Documentation

Index

• type Config
  • func Load(file string, logger log.Logger, fs FileSystem) (*Config, error)
  • func (c Config) Validate() error
• type FileSystem
• type OSFileSystem
  • func (OSFileSystem) ReadFile(name string) ([]byte, error)

Types

type Config

type Config struct {
	// the server port. Defaults to 8080
	ServerPort int `yaml:"server_port" env:"SERVER_PORT"`
	// the data source name (DSN) for connecting to the database. required.
	DSN string `yaml:"dsn" env:"DSN,secret"`
	// JWT signing key. required.
	JWTSigningKey string `yaml:"jwt_signing_key" env:"JWT_SIGNING_KEY,secret"`
	// JWT expiration in hours. Defaults to 72 hours (3 days)
	JWTExpiration int `yaml:"jwt_expiration" env:"JWT_EXPIRATION"`
}

Config represents an application configuration.

func Load

func Load(file string, logger log.Logger, fs FileSystem) (*Config, error)

Load returns an application configuration which is populated from the given configuration file and environment variables.

func (Config) Validate

func (c Config) Validate() error

Validate validates the application configuration.

type FileSystem

type FileSystem interface {
	ReadFile(name string) ([]byte, error)
}

FileSystem represents a file system.

type OSFileSystem

type OSFileSystem struct{}

OSFileSystem represents a real OS file system.

func (OSFileSystem) ReadFile

func (OSFileSystem) ReadFile(name string) ([]byte, error)

ReadFile reads the file from the real OS file system.