console

Documentation

Index

• type Config
• type Console
  • func New(c *component.Component, config Config) (*Console, error)
  • func (console *Console) RegisterRoutes(server *web.Server)
• type FrontendConfig
• type StackConfig
• type UIConfig

Types

type Config

type Config struct {
	OAuth oauthclient.Config `name:"oauth"`
	Mount string             `name:"mount" description:"Path on the server where the Console will be served"`
	UI    UIConfig           `name:"ui"`
}

Config is the configuration for the Console.

type Console

type Console struct {
	*component.Component
	// contains filtered or unexported fields
}

Console is the Console component.

func New

func New(c *component.Component, config Config) (*Console, error)

New returns a new Console.

func (*Console) RegisterRoutes

func (console *Console) RegisterRoutes(server *web.Server)

RegisterRoutes implements web.Registerer. It registers the Console to the web server.

type FrontendConfig

type FrontendConfig struct {
	DocumentationBaseURL string `json:"documentation_base_url" name:"documentation-base-url" description:"The base URL for generating documentation links"`
	Language             string `json:"language" name:"-"`
	SupportLink          string `json:"support_link" name:"support-link" description:"The URI that the support button will point to"`
	StackConfig          `json:"stack_config" name:",squash"`
}

FrontendConfig is the configuration for the Console frontend.

type StackConfig

type StackConfig struct {
	IS   webui.APIConfig `json:"is" name:"is"`
	GS   webui.APIConfig `json:"gs" name:"gs"`
	NS   webui.APIConfig `json:"ns" name:"ns"`
	AS   webui.APIConfig `json:"as" name:"as"`
	JS   webui.APIConfig `json:"js" name:"js"`
	EDTC webui.APIConfig `json:"edtc" name:"edtc"`
	QRG  webui.APIConfig `json:"qrg" name:"qrg"`
}

StackConfig is the configuration of the stack components.

type UIConfig

type UIConfig struct {
	webui.TemplateData `name:",squash"`
	FrontendConfig     `name:",squash"`
}

UIConfig is the combined configuration for the Console UI.