settings

Documentation

Index

• Constants
• Variables
• type Settings
  • func (settings Settings) IsValid() (bool, error)

Constants

const (
	Debug   string = "debug"
	Release string = "release"
	Test    string = "test"
)

Variables

var ErrSettingDuplicatedServerPorts = errors.New("duplicated ports has been found: port number fields in setting.yml should have different values.")

var ErrSettingInvalidEnvironment = errors.New("configs.environment field value is invalid.")

var ErrSettingNameEmpty = errors.New("global.name field is required.")

Types

type Settings

type Settings struct {
	Global struct {
		Name              string        `yaml:"name" env:"GLOBAL_NAME" env-default:"maani" env-description:"Instance Name"`
		ReadTimeout       time.Duration `yaml:"readTimeout" env:"GLOBAL_READ_TIMEOUT" env-default:"2m" env-description:"Read timeout of http server"`
		ReadHeaderTimeout time.Duration `` /* 127-byte string literal not displayed */
		WriteTimeout      time.Duration `yaml:"writeTimeout" env:"GLOBAL_WRITE_TIMEOUT" env-default:"2m" env-description:"Write timeout of http server"`
		IdleTimeout       time.Duration `yaml:"idleTimeout" env:"GLOBAL_IDLE_TIMEOUT" env-default:"2m" env-description:"Idle timeout of http server"`
		MaxHeaderBytes    int           `yaml:"maxHeaderBytes" env:"GLOBAL_MAX_HEADER_BYTES" env-default:"8196" env-description:"Max header bytes of http server"`
		BackendPort       int           `yaml:"backendPort" env:"GLOBAL_BACKEND_PORT" env-default:"9000" env-description:"Port of backend server"`
		AdminPort         int           `yaml:"adminPort" env:"GLOBAL_ADMIN_PORT" env-default:"9001" env-description:"Port of admin server"`
		GatewayPort       int           `yaml:"gatewayPort" env:"GLOBAL_GATEWAY_PORT" env-default:"8000" env-description:"Port of gateway server"`
		Environment       string        `yaml:"environment" env:"CONFIG_MODE" env-default:"file" env-description:"Execution mode of Gin framework"`
	} `yaml:"global"`
	Database struct {
		Type                string        `yaml:"type" env:"CONFIG_DB_TYPE" env-default:"pgsql" env-description:"Postgres connection mode"`
		SSLMode             string        `yaml:"sslMode" env:"CONFIG_DB_SSL_MODE" env-default:"disable" env-description:"Database connection mode"`
		Host                string        `yaml:"host" env:"CONFIG_DB_HOST" env-default:"127.0.0.1" env-description:"Database connection host"`
		User                string        `yaml:"user" env:"CONFIG_DB_USER" env-default:"postgres" env-description:"Database connection user"`
		DatabaseName        string        `yaml:"databaseName" env:"CONFIG_DB_DATABASE" env-default:"postgres" env-description:"Database name"`
		Password            string        `yaml:"password" env:"CONFIG_DB_PASSWORD" env-description:"Database connection password"`
		Port                int           `yaml:"port" env:"CONFIG_DB_PORT" env-default:"5432" env-description:"Database connection port"`
		QueryTimeout        time.Duration `yaml:"queryTimeout" env:"CONFIG_DB_QUERY_TIMEOUT" env-default:"5s" env-description:"Database query timeout"`
		SyncInterval        time.Duration `yaml:"syncInterval" env:"CONFIG_DB_SYNC_INTERVAL" env-default:"60s" env-description:"Sync interval of Configs in db mode"`
		MaxOpenConnections  int           `` /* 148-byte string literal not displayed */
		MaxIdleConnections  int           `` /* 148-byte string literal not displayed */
		ConnMaxLifetime     time.Duration `` /* 146-byte string literal not displayed */
		ConnMaxIdleTime     time.Duration `` /* 144-byte string literal not displayed */
		StatusCheckInterval time.Duration `` /* 141-byte string literal not displayed */
	} `yaml:"database"`
	GatewayServer struct {
		StoreHost           string        `yaml:"storeHost" env:"STORE_HOST" env-default:"http://store" env-description:"Host for request to store servers"`
		SecretKey           string        `env:"GATEWAY_API_SECRET_KEY" env-default:"gatewaySecret" env-description:"Secret key for gateway server api authentication"`
		TokenTimeout        time.Duration `yaml:"tokenTimeout" env:"API_TOKEN_TIMEOUT" env-default:"1h" env-description:"Timeout of token for api authentication"`
		RefreshTokenTimeout time.Duration `` /* 141-byte string literal not displayed */
		UserIdHeaderKey     string        `` /* 145-byte string literal not displayed */
	} `yaml:"retreival"`
	BackendServer struct {
		EncryptKey       string `yaml:"encryptKey" env:"ENCRYPT_KEY" env-default:"files-secret-key"  env-description:"Key for encrypting file"`
		FilePath         string `yaml:"filePath" env:"FILE_PATH" env-default:"/opt/files" env-description:"Path for new file to save"`
		MaxFilesSizeByte int    `` /* 132-byte string literal not displayed */
	} `yaml:"store"`
}

func (Settings) IsValid

func (settings Settings) IsValid() (bool, error)