conf

Documentation

Index

• Variables
• func AppPath() string
• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func CheckRunUser(runUser string) (string, bool)
• func CurrentUsername() string
• func CustomDir() string
• func HomeDir() string
• func Init(customConf string) error
• func IsProdMode() bool
• func IsWindowsRuntime() bool
• func MustAsset(name string) []byte
• func WorkDir() string

Variables

var (
	// Application settings
	App struct {
		// ⚠️ WARNING: Should only be set by the main package (i.e. "facegit-web.go").
		Version string `ini:"-"`

		Name    string
		RunMode string
		RunUser string

		StaticFile embed.FS
	}

	// log
	Log struct {
		Format   string
		RootPath string
	}

	// Cache settings
	Cache struct {
		Adapter  string
		Interval int
		Host     string
	}

	// http settings
	Http struct {
		Port int `ini:"port"`
	}

	// Security settings
	Security struct {
		InstallLock bool
		SecretKey   string
	}
)

var File *ini.File

File is the configuration object.

Functions

func AppPath

func AppPath() string

AppPath returns the absolute path of the application's binary.

func Asset

func Asset(name string) ([]byte, error)

Asset is a wrapper for getting conf assets.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir is a wrapper for getting conf assets.

func CheckRunUser

func CheckRunUser(runUser string) (string, bool)

CheckRunUser returns false if configured run user does not match actual user that runs the app. The first return value is the actual user name. This check is ignored under Windows since SSH remote login is not the main method to login on Windows.

func CurrentUsername

func CurrentUsername() string

CurrentUsername returns the username of the current user.

func CustomDir

func CustomDir() string

CustomDir returns the absolute path of the custom directory that contains local overrides. It reads the value of environment variable GOGS_CUSTOM. When not set, it uses the work directory returned by WorkDir function.

func HomeDir

func HomeDir() string

HomeDir returns the home directory by reading environment variables. It may return empty string when environment variables are not set.

func Init

func Init(customConf string) error

func IsProdMode

func IsProdMode() bool

IsProdMode returns true if the application is running in production mode.

func IsWindowsRuntime

func IsWindowsRuntime() bool

IsWindowsRuntime returns true if the current runtime in Windows.

func MustAsset

func MustAsset(name string) []byte

MustAsset is a wrapper for getting conf assets.

func WorkDir

func WorkDir() string

WorkDir returns the absolute path of work directory. It reads the value of environment variable IMAIL_WORK_DIR. When not set, it uses the directory where the application's binary is located.