webui

Documentation

Index

• Variables
• func GenerateNonce() string
• func RegisterHashedFile(original, hashed string)
• func RewriteScheme(rewrites map[string]string, baseURL string) []string
• func RewriteSchemes(rewrites map[string]string, baseURLs ...string) []string
• func WithAppConfig(r *http.Request, cfg any) *http.Request
• func WithNonce(r *http.Request) (*http.Request, string)
• func WithPageData(r *http.Request, pageData any) *http.Request
• func WithTemplateData(r *http.Request, data TemplateData) *http.Request
• type APIConfig
  • func (c APIConfig) MarshalJSON() ([]byte, error)
• type AppTemplate
  • func NewAppTemplate(t *template.Template) *AppTemplate
  • func (t *AppTemplate) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type ContentSecurityPolicy
  • func (csp ContentSecurityPolicy) Clean() ContentSecurityPolicy
  • func (csp ContentSecurityPolicy) Merge(others ...ContentSecurityPolicy) ContentSecurityPolicy
  • func (csp ContentSecurityPolicy) String() string
• type Data
• type TemplateData
  • func (t TemplateData) MountPath() string

Variables

var WebsocketSchemeRewrites = map[string]string{
	"http":  "ws",
	"https": "wss",
}

WebsocketSchemeRewrites contains the rewrite rules for websocket schemes.

Functions

func GenerateNonce

func GenerateNonce() string

GenerateNonce returns a nonce used for inline scripts.

func RegisterHashedFile

func RegisterHashedFile(original, hashed string)

RegisterHashedFile maps filenames to webpack generated hashed filenames

func RewriteScheme

func RewriteScheme(rewrites map[string]string, baseURL string) []string

RewriteScheme rewrites the scheme of the provided URL if it matches a rewrite rule.

func RewriteSchemes

func RewriteSchemes(rewrites map[string]string, baseURLs ...string) []string

RewriteSchemes rewrites the scheme of the provided URLs if they match a rewrite rule.

func WithAppConfig

func WithAppConfig(r *http.Request, cfg any) *http.Request

WithAppConfig constructs a *http.Request which has the provided app config attached.

func WithNonce

func WithNonce(r *http.Request) (*http.Request, string)

WithNonce constructs a *http.Request which has a nonce attached.

func WithPageData

func WithPageData(r *http.Request, pageData any) *http.Request

WithPageData constructs a *http.Request which has the provided page data attached.

func WithTemplateData

func WithTemplateData(r *http.Request, data TemplateData) *http.Request

WithTemplateData constructs a *http.Request which has the provided TemplateData attached.

Types

type APIConfig

type APIConfig struct {
	Enabled bool   `json:"enabled" name:"enabled" description:"Enable this API"`
	BaseURL string `json:"base_url" name:"base-url" description:"Base URL to the HTTP API"`
}

APIConfig for upstream APIs.

func (APIConfig) MarshalJSON

func (c APIConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

type AppTemplate

type AppTemplate struct {
	// contains filtered or unexported fields
}

AppTemplate wraps the application template for the web UI.

var Template *AppTemplate

Template for rendering the web UI. The context is expected to contain TemplateData as "template_data". The "app_config" will be rendered into the environment.

func NewAppTemplate

func NewAppTemplate(t *template.Template) *AppTemplate

NewAppTemplate instantiates a new application template for the web UI.

func (*AppTemplate) ServeHTTP

func (t *AppTemplate) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP renders the web UI.

type ContentSecurityPolicy

type ContentSecurityPolicy struct {
	ConnectionSource []string
	StyleSource      []string
	ScriptSource     []string
	BaseURI          []string
	FrameAncestors   []string
}

ContentSecurityPolicy contains the Content Security Policy.

func (ContentSecurityPolicy) Clean

func (csp ContentSecurityPolicy) Clean() ContentSecurityPolicy

Clean de-duplicates and removes empty entries from the policy.

func (ContentSecurityPolicy) Merge

func (csp ContentSecurityPolicy) Merge(others ...ContentSecurityPolicy) ContentSecurityPolicy

Merge merges the provided policies into the existing one.

func (ContentSecurityPolicy) String

func (csp ContentSecurityPolicy) String() string

String returns the policy in string form.

type Data

type Data struct {
	TemplateData
	AppConfig            any
	ExperimentalFeatures map[string]bool
	PageData             any
	CSPNonce             string
}

Data contains data to render templates.

type TemplateData

type TemplateData struct {
	SiteName        string   `name:"site-name" description:"The site name"`
	Title           string   `name:"title" description:"The page title"`
	SubTitle        string   `name:"sub-title" description:"The page sub-title"`
	Description     string   `name:"descriptions" description:"The page description"`
	Language        string   `name:"language" description:"The page language"`
	ThemeColor      string   `name:"theme-color" description:"The page theme color"`
	CanonicalURL    string   `name:"canonical-url" description:"The page canonical URL"`
	AssetsBaseURL   string   `name:"assets-base-url" description:"The base URL to the page assets"`
	BrandingBaseURL string   `name:"branding-base-url" description:"The base URL to the branding assets"`
	IconPrefix      string   `name:"icon-prefix" description:"The prefix to put before the page icons (favicon.ico, touch-icon.png, og-image.png)"`
	CSSFiles        []string `name:"css-file" description:"The names of the CSS files"`
	JSFiles         []string `name:"js-file" description:"The names of the JS files"`
	SentryDSN       string   `name:"sentry-dsn" description:"The Sentry DSN"`
	CSRFToken       string   `name:"-"`
}

TemplateData contains data to use in the App template.

func (TemplateData) MountPath

func (t TemplateData) MountPath() string

MountPath derives the mount path from the canonical URL of the config.