config

Documentation

Index

• Constants
• func Set(cfg Config)
• type Config
  • func Get() Config
  • func ReadFromJson(path string) Config
  • func (c Config) GetIndexUrl() string
  • func (c Config) Index() string
  • func (c Config) IsLocalEnvironment() bool
  • func (c Config) IsProductionEnvironment() bool
  • func (c Config) IsTestEnvironment() bool
  • func (c Config) Prefix() string
  • func (c Config) PrefixFixSlash() string
  • func (c Config) Url(suffix string) string
  • func (c Config) UrlRemovePrefix(u string) string
• type Database
• type DatabaseList
  • func (d DatabaseList) Add(key string, db Database)
  • func (d DatabaseList) GetDefault() Database
  • func (d DatabaseList) GroupByDriver() map[string]DatabaseList
• type FileUploadEngine
• type Store

Constants

const (
	EnvTest  = "test"
	EnvLocal = "local"
	EnvProd  = "prod"

	DriverMysql      = "mysql"
	DriverSqlite     = "sqlite"
	DriverPostgresql = "postgresql"
	DriverMssql      = "mssql"
)

Functions

func Set

func Set(cfg Config)

Set sets the config.

Types

type Config

type Config struct {
	// An map supports multi database connection. The first
	// element of Databases is the default connection. See the
	// file connection.go.
	Databases DatabaseList `json:"database"`

	// The cookie domain used in the auth modules. see
	// the session.go.
	Domain string `json:"domain"`

	// Used to set as the localize language which show in the
	// interface.
	Language string `json:"language"`

	// The global url prefix.
	UrlPrefix string `json:"prefix"`

	// The theme name of template.
	Theme string `json:"theme"`

	// The path where files will be stored into.
	Store Store `json:"store"`

	// The title of web page.
	Title string `json:"title"`

	// Logo is the top text in the sidebar.
	Logo template.HTML `json:"logo"`

	// Mini-logo is the top text in the sidebar when folding.
	MiniLogo template.HTML `json:"mini_logo"`

	// The url redirect to after login.
	IndexUrl string `json:"index"`

	// Debug mode
	Debug bool `json:"debug"`

	// Env is the environment, which maybe local, test, prod.
	Env string `json:"env"`

	// Info log path.
	InfoLogPath string `json:"info_log"`

	// Error log path.
	ErrorLogPath string `json:"error_log"`

	// Access log path.
	AccessLogPath string `json:"access_log"`

	// Sql operator record log switch.
	SqlLog bool `json:"sql_log"`

	AccessLogOff bool `json:"access_log_off"`
	InfoLogOff   bool `json:"info_log_off"`
	ErrorLogOff  bool `json:"error_log_off"`

	// Color scheme.
	ColorScheme string `json:"color_scheme"`

	// Session valid time duration, units are seconds.
	SessionLifeTime int `json:"session_life_time"`

	// Assets visit link.
	AssetUrl string `json:"asset_url"`

	// File upload engine, default "local"
	FileUploadEngine FileUploadEngine `json:"file_upload_engine"`

	// Custom html in the tag head.
	CustomHeadHtml template.HTML `json:"custom_head_html"`

	// Custom html after body.
	CustomFootHtml template.HTML `json:"custom_foot_html"`

	// Login page title
	LoginTitle string `json:"login_title"`

	// Login page logo
	LoginLogo template.HTML `json:"login_logo"`
	// contains filtered or unexported fields
}

Config type is the global config of goAdmin. It will be initialized in the engine.

func Get

func Get() Config

Get gets the config.

func ReadFromJson

func ReadFromJson(path string) Config

func (Config) GetIndexUrl

func (c Config) GetIndexUrl() string

func (Config) Index

func (c Config) Index() string

func (Config) IsLocalEnvironment

func (c Config) IsLocalEnvironment() bool

func (Config) IsProductionEnvironment

func (c Config) IsProductionEnvironment() bool

func (Config) IsTestEnvironment

func (c Config) IsTestEnvironment() bool

func (Config) Prefix

func (c Config) Prefix() string

func (Config) PrefixFixSlash

func (c Config) PrefixFixSlash() string

func (Config) Url

func (c Config) Url(suffix string) string

func (Config) UrlRemovePrefix

func (c Config) UrlRemovePrefix(u string) string

type Database

type Database struct {
	Host       string `json:"host"`
	Port       string `json:"port"`
	User       string `json:"user"`
	Pwd        string `json:"pwd"`
	Name       string `json:"name"`
	MaxIdleCon int    `json:"max_idle_con"`
	MaxOpenCon int    `json:"max_open_con"`
	Driver     string `json:"driver"`
	File       string `json:"file"`
}

Database is a type of database connection config. Because a little difference of different database driver. The Config has multiple options but may be not used. Such as the sqlite driver only use the File option which can be ignored when the driver is mysql.

type DatabaseList

type DatabaseList map[string]Database

func (DatabaseList) Add

func (d DatabaseList) Add(key string, db Database)

func (DatabaseList) GetDefault

func (d DatabaseList) GetDefault() Database

func (DatabaseList) GroupByDriver

func (d DatabaseList) GroupByDriver() map[string]DatabaseList

type FileUploadEngine

type FileUploadEngine struct {
	Name   string
	Config map[string]interface{}
}

type Store

type Store struct {
	Path   string
	Prefix string
}

Store is the file store config. Path is the local store path. and prefix is the url prefix used to visit it.