config

Documentation

Index

• Constants
• Variables
• func CheckEnv() error
• func DomainOf(addr string) string
• func EnvOpt(key, fallback string) string
• func GetEnvOpt(key string) (string, bool)
• func GetLoadFactor() float64
• func IsEnabled(value string) bool
• func LoadEnv(envfiles []string)
• func MustEnv(key string) string
• func SafeFilename(f string) string
• func UserDirFilename(filename string) (string, error)
• func UserDirGet(filename string) ([]byte, error)
• func UserDirGetString(filename string) (string, error)
• func UserDirPath(suffix string) (string, error)
• func UserDirPut(filename string, data []byte) error
• type Backend
  • func NewBackend(host, secret string) *Backend
• type BackendsConfig
• type Frontend
  • func NewFrontend(key, secret string) *Frontend
• type FrontendsConfig
• type Properties
  • func ReadPropertiesFile(filename string) (Properties, error)
  • func (p Properties) Get(key string) (string, bool)

Constants

const (
	EnvDbURL                     = "B3SCALE_DB_URL"
	EnvDbPoolSize                = "B3SCALE_DB_POOL_SIZE"
	EnvLogLevel                  = "B3SCALE_LOG_LEVEL"
	EnvLogFormat                 = "B3SCALE_LOG_FORMAT"
	EnvListenHTTP                = "B3SCALE_LISTEN_HTTP"
	EnvReverseProxy              = "B3SCALE_REVERSE_PROXY_MODE"
	EnvLoadFactor                = "B3SCALE_LOAD_FACTOR"
	EnvJWTSecret                 = "B3SCALE_API_JWT_SECRET"
	EnvAPIURL                    = "B3SCALE_API_URL"
	EnvAPIAccessToken            = "B3SCALE_API_ACCESS_TOKEN"
	EnvBBBConfig                 = "BBB_CONFIG"
	EnvRecordingsPublishedPath   = "B3SCALE_RECORDINGS_PUBLISHED_PATH"
	EnvRecordingsUnpublishedPath = "B3SCALE_RECORDINGS_UNPUBLISHED_PATH"
	EnvRecordingsPlaybackHost    = "B3SCALE_RECORDINGS_PLAYBACK_HOST"
)

Well Known Environment Keys

const (
	EnvDbPoolSizeDefault   = "128"
	EnvDbURLDefault        = "postgres://postgres:postgres@localhost:5432/b3scale"
	EnvLogLevelDefault     = "info"
	EnvLogFormatDefault    = "structured"
	EnvListenHTTPDefault   = "127.0.0.1:42353" // :B3S
	EnvReverseProxyDefault = "false"
	EnvBBBConfigDefault    = "/etc/bigbluebutton/bbb-web.properties"
	EnvLoadFactorDefault   = "1.0"
)

Defaults

Variables

var (
	// ReMatchUnsafe matches everything not a-z, A-Z, 0-9
	// and '.' from a string.
	ReMatchUnsafe = regexp.MustCompile(`[^a-zA-Z0-9.]`)

	// ReMatchUnderscoreSeq matches underscore sequences
	ReMatchUnderscoreSeq = regexp.MustCompile(`__+`)
)

var (
	// Version is a public global overridden at compile time
	// with the current version.
	Version string = "HEAD"

	// Build is the short commit hash
	Build string = "0000000"
)

Functions

func CheckEnv

func CheckEnv() error

CheckEnv checks if the environment is configured

func DomainOf

func DomainOf(addr string) string

DomainOf returns the domain name (with TLD) of the given address or URL.

func EnvOpt

func EnvOpt(key, fallback string) string

EnvOpt gets a configuration from the environment with a default fallback.

func GetEnvOpt

func GetEnvOpt(key string) (string, bool)

GetEnvOpt gets a configuration from the environment, but will fail if the variable is not present.

func GetLoadFactor

func GetLoadFactor() float64

GetLoadFactor retrievs the load factor from the environment.

func IsEnabled

func IsEnabled(value string) bool

IsEnabled returns true if the input is trueish

func LoadEnv

func LoadEnv(envfiles []string)

LoadEnv loads the environment from a file and updates the os.Environment

func MustEnv

func MustEnv(key string) string

MustEnv gets a configuration from the environment and will panic if the variable is empty.

func SafeFilename

func SafeFilename(f string) string

SafeFilename creates an urlsafe filename by stripping unsafe characters.

func UserDirFilename

func UserDirFilename(filename string) (string, error)

UserDirFilename gets the full path to a filename in the userdir

func UserDirGet

func UserDirGet(filename string) ([]byte, error)

UserDirGet retrievs content from a file in the b3scale user config directory

func UserDirGetString

func UserDirGetString(filename string) (string, error)

UserDirGetString retrievs a string from a file in the b3scale user config directory

func UserDirPath

func UserDirPath(suffix string) (string, error)

UserDirPath joins the file name with the full b3scale config path

func UserDirPut

func UserDirPut(filename string, data []byte) error

UserDirPut save a file in the b3scale config directory

Types

type Backend

type Backend struct {
	Host   string
	Secret string
}

Backend is the configuration of a cluster node

func NewBackend

func NewBackend(host, secret string) *Backend

NewBackend creates a new Backend configuration and normalizes the Host url

type BackendsConfig

type BackendsConfig interface {
	Load() ([]*Backend, error)
}

BackendsConfig interface

type Frontend

type Frontend struct {
	Key    string
	Secret string
}

Frontend is the configuration of a a cluster consumer.

func NewFrontend

func NewFrontend(key, secret string) *Frontend

NewFrontend creates a new frontend config

type FrontendsConfig

type FrontendsConfig interface {
	Load() ([]*Frontend, error)
}

FrontendsConfig interface

type Properties

type Properties map[string]string

Properties is a map of BBB properties. The map stores the raw data. Retriving values should be done through the accessor which will resolve refs.

func ReadPropertiesFile

func ReadPropertiesFile(filename string) (Properties, error)

ReadPropertiesFile consumes a BBB properties file

func (Properties) Get

func (p Properties) Get(key string) (string, bool)

Get retrievs a value from the properties map and will resolve a reference.