env

Documentation

Index

• func Current() string
• func Etc(p ...string) string
• func GetEnvOrDefault(name string, defaultValue string) string
• func GetPublicIP() (string, error)
• func HasLegal() bool
• func IsDefined(name string) bool
• func IsDevelopment() bool
• func IsProduction() bool
• func IsSingleHostMode() bool
• func IsTest() bool
• func Mode() string
• func MultiTenantDomain() string
• func MustGet(name string) string
• func Path(p ...string) string
• func Subdomain(host string) string

Functions

func Current

func Current() string

Current returns current Fider environment

func Etc

func Etc(p ...string) string

Etc returns a path to a folder or file inside the /etc/ folder

func GetEnvOrDefault

func GetEnvOrDefault(name string, defaultValue string) string

GetEnvOrDefault retrieves the value of the environment variable named by the key. It returns the value if available, otherwise returns defaultValue

func GetPublicIP

func GetPublicIP() (string, error)

GetPublicIP returns the public IP of current hosting server

func HasLegal

func HasLegal() bool

HasLegal returns true if current instance contains legal documents: privacy.md and terms.md

func IsDefined

func IsDefined(name string) bool

IsDefined returns true if given environment variable is defined

func IsDevelopment

func IsDevelopment() bool

IsDevelopment returns true on Fider production environment

func IsProduction

func IsProduction() bool

IsProduction returns true on Fider production environment

func IsSingleHostMode

func IsSingleHostMode() bool

IsSingleHostMode returns true if host mode is set to single tenant

func IsTest

func IsTest() bool

IsTest returns true on Fider test environment

func Mode

func Mode() string

Mode returns HOST_MODE or its default value

func MultiTenantDomain

func MultiTenantDomain() string

MultiTenantDomain returns domain name of current instance for multi tenant hosts

func MustGet

func MustGet(name string) string

MustGet returns environment variable or panic

func Path

func Path(p ...string) string

Path returns root path of project + given path

func Subdomain

func Subdomain(host string) string

Subdomain returns the Fider subdomain (if available) from given host