common

Documentation

Index

• Constants
• func GetAppEnvFile() (output string)
• func GetAppHealthPort() (output string)
• func GetAppHealthPortEnabled() (output string)
• func GetAppMetricsEnabled() (output string)
• func GetAppMetricsPort() (output string)
• func GetAppMinioAccessKey() (output string)
• func GetAppMinioBucket() (output string)
• func GetAppMinioHost() (output string)
• func GetAppMinioSecretKey() (output string)
• func GetAppMinioUseSSL() (output string)
• func GetAppPort() (output string)
• func GetAppRealIPHeader() (output string)
• func GetAppSiteTitle() (output string)
• func GetEnvOrDefault(envName string, defaultValue string) (output string)
• func GetRequestIP(r *http.Request) (requestIP string)
• func Logging(next http.Handler) http.Handler

Constants

const (
	AppBuildVersion = "0.0.0"
	AppBuildHash    = "???"
	AppBuildDate    = "???"
	AppBuildMode    = "???"
)

AppBuild metadata

Functions

func GetAppEnvFile

func GetAppEnvFile() (output string)

GetAppEnvFile ... location of an env file to load

func GetAppHealthPort

func GetAppHealthPort() (output string)

GetAppHealthPort ... the port to bind the health service to

func GetAppHealthPortEnabled

func GetAppHealthPortEnabled() (output string)

GetAppHealthPortEnabled ... enable the binding of a health port

func GetAppMetricsEnabled

func GetAppMetricsEnabled() (output string)

GetAppMetricsEnabled ... serve metrics endpoint

func GetAppMetricsPort

func GetAppMetricsPort() (output string)

GetAppMetricsPort ... return the port which the app should serve metrics on

func GetAppMinioAccessKey

func GetAppMinioAccessKey() (output string)

GetAppMinioAccessKey ... return the accessKey for file storage

func GetAppMinioBucket

func GetAppMinioBucket() (output string)

GetAppMinioBucket ... return the bucket for file storage

func GetAppMinioHost

func GetAppMinioHost() (output string)

GetAppMinioHost ... return the host for file storage

func GetAppMinioSecretKey

func GetAppMinioSecretKey() (output string)

GetAppMinioSecretKey ... return the secretKey for file storage

func GetAppMinioUseSSL

func GetAppMinioUseSSL() (output string)

GetAppMinioUseSSL ... return if the file storage should use SSL

func GetAppPort

func GetAppPort() (output string)

GetAppPort ... the port to serve web traffic on

func GetAppRealIPHeader

func GetAppRealIPHeader() (output string)

GetAppRealIPHeader ... the header to use instead of r.RemoteAddr

func GetAppSiteTitle

func GetAppSiteTitle() (output string)

GetAppSiteTitle ... site title to template in

func GetEnvOrDefault

func GetEnvOrDefault(envName string, defaultValue string) (output string)

GetEnvOrDefault ... given an env var return it's value, else return a default

func GetRequestIP

func GetRequestIP(r *http.Request) (requestIP string)

GetRequestIP ... returns r.RemoteAddr unless RealIPHeader is set

func Logging

func Logging(next http.Handler) http.Handler

Logging ... a basic middleware for logging