conf

package
v0.0.0-...-099495b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 9, 2023 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	App struct {
		Version string `ini:"-"`
		Name    string
		RunUser string
		RunMode string
		Node    string
	}

	// log
	Log struct {
		Format   string
		RootPath string
	}

	// http settings
	Http struct {
		Port    int    `ini:"port"`
		Path    string `ini:"path"`
		Timeout int    `ini:"timeout"`
	}

	User struct {
		Enable bool
	}

	// Security settings
	Security struct {
		InstallLock             bool
		SecretKey               string
		LoginRememberDays       int
		CookieRememberName      string
		CookieUsername          string
		CookieSecure            bool
		EnableLoginStatusCookie bool
		LoginStatusCookieName   string
	}
)
View Source
var CustomConf string

CustomConf returns the absolute path of custom configuration file that is used.

View Source
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.

Types

type DatabaseOpts

type DatabaseOpts struct {
	Type         string
	Host         string
	Port         string
	Name         string
	User         string
	Password     string
	SslMode      string `ini:"ssl_mode"`
	Path         string
	Prefix       string
	Charset      string
	MaxOpenConns int
	MaxIdleConns int
}
var Database DatabaseOpts

Database settings

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL