brand

package
v0.2.0-beta Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 12, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package brand provides the branding indirection layer this project requires: no product name is ever hardcoded in source.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Brand

type Brand struct {
	Name         string `yaml:"name"`
	ShortName    string `yaml:"short_name"`
	BinaryName   string `yaml:"binary_name"`
	Domain       string `yaml:"domain"`
	SupportURL   string `yaml:"support_url"`
	PrimaryColor string `yaml:"primary_color"`
	LogoSVG      string `yaml:"logo_svg"`
	DocsURL      string `yaml:"docs_url"`
}

Brand holds every user-visible identity string for the running binary. Nothing outside this package should reference a product name directly.

func Load

func Load(path string) (*Brand, error)

Load reads brand.yaml from path, then applies APP_BRAND_* environment overrides on top. Env vars win over the file so a deployment can be rebranded without a rebuild. The prefix is deliberately generic rather than tied to the current name, matching the same rebrandability rule this package exists to enforce.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL