config

Documentation

Index

• func New(configPath string)
• type ApplicationSchema
• type DatabaseSchema
• type FacebookOauthSchema
• type FacebookSchema
• type GoogleOauthSchema
• type GoogleSchema
• type JWTSchema
• type ModuleLoginSchema
• type ModuleSchema
• type Schema
• type SecuritySchema

Functions

func New

func New(configPath string)

New initiates the application configuration

Types

type ApplicationSchema

type ApplicationSchema struct {
	Host                    string        `yaml:"host"`
	Port                    string        `yaml:"port"`
	ReadTimeout             time.Duration `yaml:"readTimeout"`
	WriteTimeout            time.Duration `yaml:"writeTimeout"`
	GracefulShutdownTimeout time.Duration `yaml:"gracefulShutdownTimeout"`
}

ApplicationSchema is a schema related with application configuration

type DatabaseSchema

type DatabaseSchema struct {
	Engine string `yaml:"engine"`
	URL    string `yaml:"url"`
}

DatabaseSchema is a schema related with database configuration

type FacebookOauthSchema

type FacebookOauthSchema struct {
	URL         string `yaml:"url"`
	RedirectURI string `yaml:"redirectUri"`
	Scope       string `yaml:"scope"`
	Fields      string `yaml:"fields"`
}

FacebookOauthSchema is a schema related with Facebook OAuth configuration

type FacebookSchema

type FacebookSchema struct {
	ClientID     string              `yaml:"clientId"`
	ClientSecret string              `yaml:"clientSecret"`
	GraphURL     string              `yaml:"graphUrl"`
	Oauth        FacebookOauthSchema `yaml:"oauth"`
}

FacebookSchema is a schema related with Facebook configuration

type GoogleOauthSchema

type GoogleOauthSchema struct {
	URL         string `yaml:"url"`
	TokenURL    string `yaml:"tokenUrl"`
	RedirectURI string `yaml:"redirectUri"`
	Scope       string `yaml:"scope"`
}

GoogleOauthSchema is a schema related with Google OAuth configuration

type GoogleSchema

type GoogleSchema struct {
	ClientID     string            `yaml:"clientId"`
	ClientSecret string            `yaml:"clientSecret"`
	APIURL       string            `yaml:"apiUrl"`
	Oauth        GoogleOauthSchema `yaml:"oauth"`
}

GoogleSchema is a schema related with Google configuration

type JWTSchema

type JWTSchema struct {
	Secret string `yaml:"secret"`
}

JWTSchema is a schema related with JWT configuration

type ModuleLoginSchema

type ModuleLoginSchema struct {
	IsRedirect  bool   `yaml:"isRedirect"`
	RedirectURI string `yaml:"redirectUri"`
}

ModuleLoginSchema is a schema related with login module configuration

type ModuleSchema

type ModuleSchema struct {
	Login ModuleLoginSchema `yaml:"login"`
}

ModuleSchema is a schema related with module configuration

type Schema

type Schema struct {
	Application ApplicationSchema `yaml:"application"`
	Database    DatabaseSchema    `yaml:"database"`
	Security    SecuritySchema    `yaml:"security"`
	Facebook    FacebookSchema    `yaml:"facebook"`
	Google      GoogleSchema      `yaml:"Google"`

	Module ModuleSchema `yaml:"module"`
}

Schema is a base schema for configuration

var C *Schema

C is a global variable to access the config

type SecuritySchema

type SecuritySchema struct {
	JWT JWTSchema `yaml:"jwt"`
}

SecuritySchema is a schema related with security configuration