config

Documentation

Index

• Constants
• func CheckConfig(servConf ServConfig) int
• func FileExist(filepath string) bool
• type Content
• type Network
• type Recaptcha
• type Security
• type ServConfig
  • func LoadConfig(filePath string) (ServConfig, error)

Constants

const (
	CurrentVer string = "v1.0.2"
	CurrentDSN string = "https://72dd7f93900d4742a436a525692a13ed@sentry.io/2124482"
)

software version, sentry bug tracking id

Functions

func CheckConfig

func CheckConfig(servConf ServConfig) int

CheckConfig : detect uri validity, check needed config for recaptcha, check max expire, check cryptography requirement

func FileExist

func FileExist(filepath string) bool

FileExist : check if file exists, utils

Types

type Content

type Content struct {
	DetectAbuse bool `yaml:"detect_abuse"`
	ExpireHrs   int  `yaml:"expire_hrs"`
}

Content : subconfig about content abusing detection

type Network

type Network struct {
	Listen     string `yaml:"listen"`
	Host       string `yaml:"host"`
	MongodbURL string `yaml:"mongodb_url"`
}

Network : subconfig of ServConf

type Recaptcha

type Recaptcha struct {
	Enable    bool   `yaml:"enable"`
	SecretKey string `yaml:"secret_key,omitempty"`
	SiteKey   string `yaml:"site_key,omitempty"`
}

Recaptcha : subconfig of ServConf

type Security

type Security struct {
	MasterKey       string `yaml:"master_key"`
	EncryptionKey   string `yaml:"encryption_key"`
	EncryptionNonce string `yaml:"encryption_nonce"`
}

Security : subconfig about data encryption and administration must fulfill chacha20 standard

type ServConfig

type ServConfig struct {
	Network   Network   `yaml:"network"`
	Recaptcha Recaptcha `yaml:"recaptcha"`
	Security  Security  `yaml:"security"`
	Content   Content   `yaml:"content"`
}

ServConfig consists of 4 parts

var (
	ServConf ServConfig
)

global var for global server config read

func LoadConfig

func LoadConfig(filePath string) (ServConfig, error)

LoadConfig : config load function, read from file.