instance

package
v0.64.2 Latest Latest
Warning

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

Go to latest
Published: Jan 27, 2026 License: BSD-3-Clause, AGPL-3.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DefaultManager

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

DefaultManager is the default implementation of Manager.

func (*DefaultManager) CreateOwnerUser

func (m *DefaultManager) CreateOwnerUser(ctx context.Context, email, password, name string) (*idp.UserData, error)

CreateOwnerUser creates the initial owner user in the embedded IDP.

func (*DefaultManager) GetVersionInfo added in v0.64.2

func (m *DefaultManager) GetVersionInfo(ctx context.Context) (*VersionInfo, error)

GetVersionInfo returns version information for NetBird components.

func (*DefaultManager) IsSetupRequired

func (m *DefaultManager) IsSetupRequired(_ context.Context) (bool, error)

IsSetupRequired checks if instance setup is required. Setup is required when: 1. Embedded IDP is enabled 2. No accounts exist in the store

type Manager

type Manager interface {
	// IsSetupRequired checks if instance setup is required.
	// Returns true if embedded IDP is enabled and no accounts exist.
	IsSetupRequired(ctx context.Context) (bool, error)

	// CreateOwnerUser creates the initial owner user in the embedded IDP.
	// This should only be called when IsSetupRequired returns true.
	CreateOwnerUser(ctx context.Context, email, password, name string) (*idp.UserData, error)

	// GetVersionInfo returns version information for NetBird components.
	GetVersionInfo(ctx context.Context) (*VersionInfo, error)
}

Manager handles instance-level operations like initial setup.

func NewManager

func NewManager(ctx context.Context, store store.Store, idpManager idp.Manager) (Manager, error)

NewManager creates a new instance manager. If idpManager is not an EmbeddedIdPManager, setup-related operations will return appropriate defaults.

type VersionInfo added in v0.64.2

type VersionInfo struct {
	// CurrentVersion is the running management server version
	CurrentVersion string
	// DashboardVersion is the latest available dashboard version from GitHub
	DashboardVersion string
	// ManagementVersion is the latest available management version from GitHub
	ManagementVersion string
	// ManagementUpdateAvailable indicates if a newer management version is available
	ManagementUpdateAvailable bool
}

VersionInfo contains version information for NetBird components

Jump to

Keyboard shortcuts

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