config

Documentation

Overview

Package config is responsible for reading all environment variables and set up the base configuration for a functional application

Index

• Constants
• type Configuration
  • func Config() *Configuration
  • func GetConfig() *Configuration
• type DatabaseConfig
• type EmailConfig
• type LoggerConfig
• type MongoDB
• type RDBMS
• type REDIS
• type SecurityConfig
• type ServerConfig
• type Status2FA
• type ViewConfig

Constants

const Activated string = "yes"

Activated - "yes" keyword to activate a service

Types

type Configuration

type Configuration struct {
	Database   DatabaseConfig
	EmailConf  EmailConfig
	Logger     LoggerConfig
	Server     ServerConfig
	Security   SecurityConfig
	ViewConfig ViewConfig
}

Configuration - server and db configuration variables

func Config

func Config() *Configuration

Config - load all the configurations

func GetConfig

func GetConfig() *Configuration

GetConfig - return all the config variables

type DatabaseConfig

type DatabaseConfig struct {
	// relational database
	RDBMS RDBMS

	// redis database
	REDIS REDIS

	// mongo database
	MongoDB MongoDB
}

DatabaseConfig - all database variables

type EmailConfig

type EmailConfig struct {
	Activate     string
	Provider     string
	APIToken     string
	AddrFrom     string
	TrackOpens   bool
	TrackLinks   string
	DeliveryType string

	// for templated email
	EmailVerificationTemplateID int64
	PasswordRecoverTemplateID   int64
	EmailVerificationCodeLength uint64
	PasswordRecoverCodeLength   uint64
	EmailVerificationTag        string
	PasswordRecoverTag          string
	HTMLModel                   string
	EmailVerifyValidityPeriod   uint64 // in seconds
	PassRecoverValidityPeriod   uint64 // in seconds
}

EmailConfig - for external email services

type LoggerConfig

type LoggerConfig struct {
	Activate  string
	SentryDsn string
}

LoggerConfig ...

type MongoDB

type MongoDB struct {
	Activate string
	Env      struct {
		AppName  string
		URI      string
		PoolSize uint64
		PoolMon  string
		ConnTTL  int
	}
}

MongoDB - mongo database variables

type RDBMS

type RDBMS struct {
	Activate string
	Env      struct {
		Driver   string
		Host     string
		Port     string
		TimeZone string
	}
	Access struct {
		DbName string
		User   string
		Pass   string
	}
	Ssl struct {
		Sslmode string
	}
	Conn struct {
		MaxIdleConns    int
		MaxOpenConns    int
		ConnMaxLifetime time.Duration
	}
	Log struct {
		LogLevel int
	}
}

RDBMS - relational database variables

type REDIS

type REDIS struct {
	Activate string
	Env      struct {
		Host string
		Port string
	}
	Conn struct {
		PoolSize int
		ConnTTL  int
	}
}

REDIS - redis database variables

type SecurityConfig

type SecurityConfig struct {
	UserPassMinLength int

	MustBasicAuth string
	BasicAuth     struct {
		Username string
		Password string
	}

	MustJWT string
	JWT     middleware.JWTParameters

	MustHash string
	HashPass lib.HashPassConfig

	VerifyEmail bool
	RecoverPass bool

	MustFW   string
	Firewall struct {
		ListType string
		IP       string
	}

	MustCORS string
	CORS     []middleware.CORSPolicy

	TrustedPlatform string

	Must2FA string
	TwoFA   struct {
		Issuer string
		Crypto crypto.Hash
		Digits int

		Status Status2FA
		PathQR string
	}
}

SecurityConfig ...

type ServerConfig

type ServerConfig struct {
	ServerPort string // public port of server
	ServerEnv  string
}

ServerConfig ...

type Status2FA

type Status2FA struct {
	Verified string
	On       string
	Off      string
	Invalid  string
}

Status2FA - user's 2FA statuses

type ViewConfig

type ViewConfig struct {
	Activate  string
	Directory string
}

ViewConfig - HTML renderer