config

Documentation

Index

• Constants
• type ActivityConfig
• type AuthConfig
  • func (c AuthConfig) ClientCredentials() management.Option
  • func (c AuthConfig) IssuerURL() (u *url.URL, err error)
  • func (c AuthConfig) Validate() error
• type CacheConfig
  • func (c CacheConfig) Validate() error
• type Config
  • func New() (conf Config, err error)
  • func (c Config) GetLogLevel() zerolog.Level
  • func (c Config) IsZero() bool
  • func (c Config) Mark() (Config, error)
  • func (c Config) Validate() (err error)
• type DirectoryConfig
• type EmailConfig
  • func (c EmailConfig) Validate() error
• type MTLSConfig
  • func (c MTLSConfig) DialOption(endpoint string) (opt grpc.DialOption, err error)
  • func (c MTLSConfig) Validate() error
• type MembersConfig
  • func (c MembersConfig) Validate() error
• type NetworkConfig
  • func (c NetworkConfig) Validate() error

Constants

const (
	TestNet = "testnet"
	MainNet = "mainnet"
)

Types

type ActivityConfig

type ActivityConfig struct {
	Enabled bool   `split_words:"true" default:"false"`
	Topic   string `split_words:"true"`
	Ensign  ensign.Config
}

type AuthConfig

type AuthConfig struct {
	Domain        string        `split_words:"true" required:"true"`
	Issuer        string        `split_words:"true" required:"false"` // Set to the custom domain if enabled in Auth0 (ensure trailing slash is set if required!)
	Audience      string        `split_words:"true" required:"true"`
	ProviderCache time.Duration `split_words:"true" default:"5m"`
	ClientID      string        `split_words:"true"`
	ClientSecret  string        `split_words:"true"`
	Testing       bool          `split_words:"true" default:"false"` // If true a mock authenticator is used for testing
}

AuthConfig handles Auth0 configuration and authentication

func (AuthConfig) ClientCredentials

func (c AuthConfig) ClientCredentials() management.Option

func (AuthConfig) IssuerURL

func (c AuthConfig) IssuerURL() (u *url.URL, err error)

func (AuthConfig) Validate

func (c AuthConfig) Validate() error

type CacheConfig

type CacheConfig struct {
	Enabled    bool          `split_words:"true" default:"false"`
	Size       uint          `split_words:"true" default:"16384"`
	Expiration time.Duration `split_words:"true" default:"8h"`
}

func (CacheConfig) Validate

func (c CacheConfig) Validate() error

type Config

type Config struct {
	Maintenance  bool                `split_words:"true" default:"false"`
	BindAddr     string              `split_words:"true" default:":4437"`
	Mode         string              `split_words:"true" default:"release"`
	LogLevel     logger.LevelDecoder `split_words:"true" default:"info"`
	ConsoleLog   bool                `split_words:"true" default:"false"`
	AllowOrigins []string            `split_words:"true" default:"http://localhost,http://localhost:3000,http://localhost:3003"`
	RegisterURL  string              `split_words:"true" required:"true"` // Trailing slash is not allowed
	LoginURL     string              `split_words:"true" required:"true"` // Trailing slash is not allowed
	CookieDomain string              `split_words:"true"`
	ServeDocs    bool                `split_words:"true" default:"false"`
	UserCache    CacheConfig         `split_words:"true"`
	Auth0        AuthConfig
	TestNet      NetworkConfig
	MainNet      NetworkConfig
	Database     config.StoreConfig
	Email        EmailConfig
	Sentry       sentry.Config
	Activity     activity.Config
	// contains filtered or unexported fields
}

Config uses envconfig to load the required settings from the environment, parse and validate them in preparation for running the GDS BFF API service.

func New

func New() (conf Config, err error)

New creates a new Config object from environment variables prefixed with GDS_BFF.

func (Config) GetLogLevel

func (c Config) GetLogLevel() zerolog.Level

func (Config) IsZero

func (c Config) IsZero() bool

func (Config) Mark

func (c Config) Mark() (Config, error)

Mark a manually constructed as processed as long as it is validated.

func (Config) Validate

func (c Config) Validate() (err error)

Validate the config to make sure that it is usable to run the GDS BFF server.

type DirectoryConfig

type DirectoryConfig struct {
	Insecure bool          `split_words:"true" default:"true"`
	Endpoint string        `split_words:"true" required:"true"`
	Timeout  time.Duration `split_words:"true" default:"10s"`
}

DirectoryConfig is a generic configuration for connecting to a GDS service.

type EmailConfig

type EmailConfig struct {
	ServiceEmail   string `envconfig:"GDS_BFF_SERVICE_EMAIL" default:"TRISA Directory Service <admin@vaspdirectory.net>"`
	SendGridAPIKey string `envconfig:"SENDGRID_API_KEY" required:"false"`
	Testing        bool   `split_words:"true" default:"false"`
	Storage        string `split_words:"true" default:""`
}

EmailConfig defines how emails are sent from the BFF.

func (EmailConfig) Validate

func (c EmailConfig) Validate() error

type MTLSConfig

type MTLSConfig struct {
	Insecure bool   `split_words:"true"`
	CertPath string `split_words:"true"`
	PoolPath string `split_words:"true"`
}

func (MTLSConfig) DialOption

func (c MTLSConfig) DialOption(endpoint string) (opt grpc.DialOption, err error)

DialOption returns a configured dial option which can be directly used in a grpc.Dial or grpc.DialContext call to connect using mTLS.

func (MTLSConfig) Validate

func (c MTLSConfig) Validate() error

type MembersConfig

type MembersConfig struct {
	Endpoint string        `split_words:"true" required:"true"`
	Timeout  time.Duration `split_words:"true" default:"10s"`
	MTLS     MTLSConfig
}

MembersConfig is a configuration for connecting to a members service.

func (MembersConfig) Validate

func (c MembersConfig) Validate() error

type NetworkConfig

type NetworkConfig struct {
	Database  config.StoreConfig
	Directory DirectoryConfig
	Members   MembersConfig
}

NetworkConfig contains sub configurations for connecting to specific GDS and members services.

func (NetworkConfig) Validate

func (c NetworkConfig) Validate() error