server

package

v0.59.13 Latest Latest Go to latest Published: Nov 13, 2025 License: BSD-3-Clause, AGPL-3.0 Imports: 57 Imported by: 0

Details

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

Repository

github.com/netbirdio/netbird

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Create[T any](s Server, createFunc func() T) T
func CreateNamed[T any](s Server, name string, createFunc func() T) T
func Inject[T any](c Server, thing T)
func InjectNamed[T any](c Server, name string, thing T)
type BaseServer
- func NewServer(config *nbconfig.Config, dnsDomain, mgmtSingleAccModeDomain string, ...) *BaseServer
type Server

Constants ¶

View Source

const ManagementLegacyPort = 33073

ManagementLegacyPort is the port that was used before by the Management gRPC server. It is used for backward compatibility now.

Variables ¶

This section is empty.

Functions ¶

func Create ¶

func Create[T any](s Server, createFunc func() T) T

Create a dependency and add it to the BaseServer's container. A string key identifier will be based on its type definition.

func CreateNamed ¶

func CreateNamed[T any](s Server, name string, createFunc func() T) T

CreateNamed is the same as Create but will suffix the dependency string key identifier with a custom name. Useful if you want to have multiple named instances of the same object type.

func Inject ¶

func Inject[T any](c Server, thing T)

Inject lets you override a specific service from outside the BaseServer itself. This is useful for tests

func InjectNamed ¶

func InjectNamed[T any](c Server, name string, thing T)

InjectNamed is like Inject() but with a custom name.

Types ¶

type BaseServer ¶

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

Server holds the HTTP BaseServer instance. Add any additional fields you need, such as database connections, config, etc.

func NewServer ¶

func NewServer(config *nbconfig.Config, dnsDomain, mgmtSingleAccModeDomain string, mgmtPort, mgmtMetricsPort int, disableMetrics, disableGeoliteUpdate, userDeleteFromIDPEnabled bool) *BaseServer

NewServer initializes and configures a new Server instance

func (*BaseServer) APIHandler ¶

func (s *BaseServer) APIHandler() http.Handler

func (*BaseServer) AccountManager ¶

func (s *BaseServer) AccountManager() account.Manager

func (*BaseServer) AccountRequestBuffer ¶ added in v0.59.13

func (s *BaseServer) AccountRequestBuffer() *server.AccountRequestBuffer

func (*BaseServer) AfterInit ¶

func (s *BaseServer) AfterInit(fn func(s *BaseServer))

func (*BaseServer) AuthManager ¶

func (s *BaseServer) AuthManager() auth.Manager

func (*BaseServer) EphemeralManager ¶

func (s *BaseServer) EphemeralManager() ephemeral.Manager

func (*BaseServer) Errors ¶

func (s *BaseServer) Errors() <-chan error

Done returns a channel that is closed when the server stops

func (*BaseServer) EventStore ¶

func (s *BaseServer) EventStore() activity.Store

func (*BaseServer) GRPCServer ¶

func (s *BaseServer) GRPCServer() *grpc.Server

func (*BaseServer) GeoLocationManager ¶

func (s *BaseServer) GeoLocationManager() geolocation.Geolocation

func (*BaseServer) GetContainer ¶

func (s *BaseServer) GetContainer(key string) (any, bool)

GetContainer retrieves a dependency from the BaseServer's container by its key

func (*BaseServer) GroupsManager ¶

func (s *BaseServer) GroupsManager() groups.Manager

func (*BaseServer) IdpManager ¶

func (s *BaseServer) IdpManager() idp.Manager

func (*BaseServer) IntegratedValidator ¶

func (s *BaseServer) IntegratedValidator() integrated_validator.IntegratedValidator

func (*BaseServer) Metrics ¶

func (s *BaseServer) Metrics() telemetry.AppMetrics

func (*BaseServer) NetworkMapController ¶ added in v0.59.13

func (s *BaseServer) NetworkMapController() network_map.Controller

func (*BaseServer) NetworksManager ¶

func (s *BaseServer) NetworksManager() networks.Manager

func (*BaseServer) PeersManager ¶

func (s *BaseServer) PeersManager() peers.Manager

func (*BaseServer) PeersUpdateManager ¶

func (s *BaseServer) PeersUpdateManager() network_map.PeersUpdateManager

func (*BaseServer) PermissionsManager ¶

func (s *BaseServer) PermissionsManager() permissions.Manager

func (*BaseServer) ProxyController ¶

func (s *BaseServer) ProxyController() port_forwarding.Controller

func (*BaseServer) ResourcesManager ¶

func (s *BaseServer) ResourcesManager() resources.Manager

func (*BaseServer) RoutesManager ¶

func (s *BaseServer) RoutesManager() routers.Manager

func (*BaseServer) SecretsManager ¶

func (s *BaseServer) SecretsManager() *grpc.TimeBasedAuthSecretsManager

func (*BaseServer) SetContainer ¶

func (s *BaseServer) SetContainer(key string, container any)

SetContainer stores a dependency in the BaseServer's container with the specified key

func (*BaseServer) SettingsManager ¶

func (s *BaseServer) SettingsManager() settings.Manager

func (*BaseServer) Start ¶

func (s *BaseServer) Start(ctx context.Context) error

Start begins listening for HTTP requests on the configured address

func (*BaseServer) Stop ¶

func (s *BaseServer) Stop() error

Stop attempts a graceful shutdown, waiting up to 5 seconds for active connections to finish

func (*BaseServer) Store ¶

func (s *BaseServer) Store() store.Store

func (*BaseServer) UsersManager ¶

func (s *BaseServer) UsersManager() users.Manager

type Server ¶

type Server interface {
	Start(ctx context.Context) error
	Stop() error
	Errors() <-chan error
	GetContainer(key string) (any, bool)
	SetContainer(key string, container any)
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
config

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