clientconfig

package

v0.2.0-rc.5 Latest Latest Go to latest Published: Jul 23, 2026 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cloudapp3/vmflow

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Package clientconfig stores the local management credentials used by the bundled CLI and TUI. The profile is deliberately limited to loopback management addresses because vmflow's control listener is local-only.

Index ¶

func DefaultPath() (string, error)
func Save(path string, profile Profile) error
type Profile
- func Load(path string) (Profile, error)
- func LoadDefault() (Profile, string, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DefaultPath ¶

func DefaultPath() (string, error)

DefaultPath returns the client profile path. VMFLOW_CLIENT_CONFIG is mainly useful for isolated deployments and tests; relative overrides are rejected.

func Save ¶

func Save(path string, profile Profile) error

Save atomically writes a client profile with mode 0600.

Types ¶

type Profile ¶

type Profile struct {
	Version    int    `yaml:"version"`
	Address    string `yaml:"address"`
	Token      string `yaml:"token"`
	ConfigPath string `yaml:"config_path,omitempty"`
}

Profile identifies one local daemon and the bearer token used to manage it.

func Load ¶

func Load(path string) (Profile, error)

Load reads and validates a client profile without following a symlink at the final path component.

func LoadDefault ¶

func LoadDefault() (Profile, string, error)

LoadDefault loads the default profile and returns its resolved path.

Source Files ¶

View all Source files

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