config

Documentation

Index

• type Asset
• type Config
  • func New() *Config
• type Debug
• type ExternalApp
• type ExternalAppConfig
• type HTTP
• type Log
• type OIDC
• type Phoenix
• type PhoenixConfig
• type Tracing

Types

type Asset

type Asset struct {
	Path string
}

Asset defines the available asset configuration.

type Config

type Config struct {
	File    string
	Log     Log
	Debug   Debug
	HTTP    HTTP
	Tracing Tracing
	Asset   Asset
	OIDC    OIDC
	Phoenix Phoenix
}

Config combines all available configuration parts.

func New

func New() *Config

New initializes a new configuration with or without defaults.

type Debug

type Debug struct {
	Addr   string
	Token  string
	Pprof  bool
	Zpages bool
}

Debug defines the available debug configuration.

type ExternalApp

type ExternalApp struct {
	ID   string `json:"id,omitempty"`
	Path string `json:"path,omitempty"`
	// Config is completely dynamic, because it depends on the extension
	Config map[string]interface{} `json:"config,omitempty"`
}

ExternalApp defines an external phoenix app.

{
	"name": "hello",
	"path": "http://localhost:9105/hello.js",
	  "config": {
	    "url": "http://localhost:9105"
	  }
 }

type ExternalAppConfig

type ExternalAppConfig struct {
	URL string `json:"url,omitempty"`
}

ExternalAppConfig defines an external phoenix app configuration.

type HTTP

type HTTP struct {
	Addr      string
	Root      string
	Namespace string
	CacheTTL  int
}

HTTP defines the available http configuration.

type Log

type Log struct {
	Level  string
	Pretty bool
	Color  bool
}

Log defines the available logging configuration.

type OIDC

type OIDC struct {
	MetadataURL  string `json:"metadata_url,omitempty"`
	Authority    string `json:"authority,omitempty"`
	ClientID     string `json:"client_id,omitempty"`
	ResponseType string `json:"response_type,omitempty"`
	Scope        string `json:"scope,omitempty"`
}

OIDC defines the available oidc configuration

type Phoenix

type Phoenix struct {
	Path   string
	Config PhoenixConfig
}

Phoenix defines the available phoenix configuration.

type PhoenixConfig

type PhoenixConfig struct {
	Server        string                 `json:"server,omitempty"`
	Theme         string                 `json:"theme,omitempty"`
	Version       string                 `json:"version,omitempty"` // TODO what is version used for?
	OpenIDConnect OIDC                   `json:"openIdConnect,omitempty"`
	Apps          []string               `json:"apps"` // TODO add nilasempty when https://go-review.googlesource.com/c/go/+/205897/ is released
	ExternalApps  []ExternalApp          `json:"external_apps,omitempty"`
	Options       map[string]interface{} `json:"options,omitempty"`
}

PhoenixConfig defines the available phoenix configuration for a dynamically rendered config.json.

type Tracing

type Tracing struct {
	Enabled   bool
	Type      string
	Endpoint  string
	Collector string
	Service   string
}

Tracing defines the available tracing configuration.