Versions in this module Expand all Collapse all v1 v1.0.39 Oct 28, 2026 Changes in this version + type Backend struct + Host string + Port int type Config + HibernatedFavicon string + HibernatedMOTD string + type KnockAction int + const KnockNone + const KnockStart + const KnockStop type Manager + func (m *Manager) Apply(ctx context.Context, plan RoutePlan) error + type PlanAction int + const PlanDown + const PlanNone + const PlanRemove + const PlanUpsert + type PlanInput struct + Backend Backend + BackendErr error + HasProxies bool + Hostname string + Listener *db.ProxyListener + ListenerErr error + Node *db.Node + ProxyEnabled bool + Server *db.Server + type RoutePlan struct + Action PlanAction + Backend Backend + BackendErr error + Down bool + Hibernated bool + Hostname string + Knock KnockAction + ListenerErr error + ListenerPort int + Server *db.Server + ServerID string + ServerName string + func PlanFor(in PlanInput) RoutePlan v1.0.38 Oct 20, 2026 Changes in this version + const CommandLocal + const CommandProxy + const FamilyIPv4 + const FamilyIPv6 + const FamilyUnix + const FamilyUnspec + const MaxHandshakePacketLength + const TransportDgram + const TransportStream + const TransportUnspec + const ValkeyChannelRoutingEvents + const ValkeyRouteKeyPrefix + var ErrInvalidVersion = errors.New("unsupported PROXY protocol version (must be v2)") + var ErrTruncatedHeader = errors.New("truncated PROXY protocol v2 header") + var ProxyV2Signature = []byte + func GetContainerIP(cli DockerInspector, containerID string, networkName string) (string, error) + func NewMockValkeyClient() *routing.MockValkeyClient + func NewRespClient(addr string, password ...string) *routing.RespClient + func WriteHandshakePacket(w io.Writer, packet *HandshakePacket) error + func WriteProxyV2Header(w io.Writer, srcAddr, dstAddr net.Addr) error + func WriteVarInt(w io.Writer, value VarInt) error + type ActivityHandler func(serverID string) + type Config struct + AcceptsTransfers *bool + ActivityHandler ActivityHandler + ListenAddr string + Logger *logger.Logger + LoginRateLimit time.Duration + ProxyProtocol bool + SleepWakeHandler WakeHandler + WakeHandler WakeHandler + type DirectKnockManager struct + func NewDirectKnockManager(wakeHandler WakeHandler, log *logger.Logger) *DirectKnockManager + func (m *DirectKnockManager) HasKnock(serverID string) bool + func (m *DirectKnockManager) SetAcceptsTransfers(accept bool) + func (m *DirectKnockManager) SetWakeHandler(h WakeHandler) + func (m *DirectKnockManager) StartKnock(server *db.Server) error + func (m *DirectKnockManager) StopAll() + func (m *DirectKnockManager) StopKnock(serverID string) + type DockerInspector interface + ContainerInspect func(ctx context.Context, containerID string, ...) (client.ContainerInspectResult, error) + type HTTPProxy struct + func NewHTTPProxy(cfg *Config) *HTTPProxy + func (p *HTTPProxy) AddRoute(serverID, hostname, backendHost string, backendPort int) + func (p *HTTPProxy) GetRoutes() map[string]*Route + func (p *HTTPProxy) IsRunning() bool + func (p *HTTPProxy) RemoveRoute(hostname string) + func (p *HTTPProxy) ServeHTTP(w http.ResponseWriter, r *http.Request) + func (p *HTTPProxy) SetRouteDown(hostname string, down bool) + func (p *HTTPProxy) SetRouteHibernated(hostname string, hibernated bool) + func (p *HTTPProxy) Start() error + func (p *HTTPProxy) Stop() error + func (p *HTTPProxy) UpdateRoute(hostname, backendHost string, backendPort int) + type HandshakePacket struct + NextState VarInt + ProtocolVersion VarInt + ServerAddress string + ServerPort uint16 + func ReadHandshakePacket(r io.Reader) (*HandshakePacket, error) + type Manager struct + func NewManager(store *db.Store, cfg *config.Config, logger *logger.Logger, ...) *Manager + func (m *Manager) AddListener(listener *db.ProxyListener) error + func (m *Manager) AddModuleRoute(module *db.Module, server *db.Server) error + func (m *Manager) AllocateProxyPort(serverID string) (int, error) + func (m *Manager) EnsureDefaultListener() (*db.ProxyListener, error) + func (m *Manager) GetContainerIP(containerID string) (string, error) + func (m *Manager) GetDirectKnockManager() *DirectKnockManager + func (m *Manager) GetModuleRoutes() map[int]map[string]*Route + func (m *Manager) GetRoutes() map[string]*Route + func (m *Manager) InitDirectKnocks() + func (m *Manager) IsRunning() bool + func (m *Manager) RemoveListener(port int) error + func (m *Manager) RemoveModuleRoute(moduleID string) error + func (m *Manager) RemoveRouteByHostname(hostname string, listenerID string) error + func (m *Manager) RemoveServerRoute(serverID string) error + func (m *Manager) SetActivityHandler(h ActivityHandler) + func (m *Manager) SetSleepWakeHandler(h WakeHandler) + func (m *Manager) SetValkeySync(sync *ValkeySyncManager) + func (m *Manager) SetWakeHandler(h WakeHandler) + func (m *Manager) Start() error + func (m *Manager) Stop() error + func (m *Manager) StopDirectKnock(serverID string) + func (m *Manager) UpdateModuleRoute(module *db.Module, server *db.Server) error + func (m *Manager) UpdateServerRoute(server *db.Server) error + type MinecraftProxy struct + func NewMinecraftProxy(cfg *Config) *MinecraftProxy + func (p *MinecraftProxy) AddRoute(serverID, hostname, backendHost string, backendPort int) + func (p *MinecraftProxy) GetRoutes() map[string]*Route + func (p *MinecraftProxy) IsRunning() bool + func (p *MinecraftProxy) RemoveRoute(hostname string) + func (p *MinecraftProxy) SetActivityHandler(h ActivityHandler) + func (p *MinecraftProxy) SetRouteActive(hostname string, active bool) + func (p *MinecraftProxy) SetRouteDown(hostname string, down bool) + func (p *MinecraftProxy) SetRouteHibernated(hostname string, hibernated bool) + func (p *MinecraftProxy) SetSleepWakeHandler(h WakeHandler) + func (p *MinecraftProxy) SetWakeHandler(h WakeHandler) + func (p *MinecraftProxy) Start() error + func (p *MinecraftProxy) Stop() error + func (p *MinecraftProxy) UpdateRoute(hostname, backendHost string, backendPort int) + type MockValkeyClient = routing.MockValkeyClient + type Proxier interface + AddRoute func(serverID, hostname, backendHost string, backendPort int) + GetRoutes func() map[string]*Route + IsRunning func() bool + RemoveRoute func(hostname string) + SetRouteDown func(hostname string, down bool) + SetRouteHibernated func(hostname string, hibernated bool) + Start func() error + Stop func() error + UpdateRoute func(hostname, backendHost string, backendPort int) + type ProxyConn struct + func (c *ProxyConn) Read(b []byte) (int, error) + func (c *ProxyConn) RemoteAddr() net.Addr + type ProxyHeader struct + Command byte + DstAddr *net.TCPAddr + SrcAddr *net.TCPAddr + Transport byte + Version byte + func ParseProxyV2Header(r io.Reader) (*ProxyHeader, error) + func WrapConnWithProxyProtocol(conn net.Conn) (net.Conn, *ProxyHeader, error) + type RespClient = routing.RespClient + type Route struct + Active bool + BackendHost string + BackendPort int + Down bool + Hibernated bool + Hostname string + ServerID string + type RouteInfo = routing.RouteInfo + type RoutingEvent struct + Action string + BackendHost string + BackendPort int + Hostname string + OriginNode string + ProxyPort int + ServerID string + Timestamp int64 + type TCPProxy struct + func NewTCPProxy(cfg *Config) *TCPProxy + func (p *TCPProxy) AddRoute(serverID, hostname, backendHost string, backendPort int) + func (p *TCPProxy) GetRoutes() map[string]*Route + func (p *TCPProxy) IsRunning() bool + func (p *TCPProxy) RemoveRoute(hostname string) + func (p *TCPProxy) SetRouteDown(hostname string, down bool) + func (p *TCPProxy) SetRouteHibernated(hostname string, hibernated bool) + func (p *TCPProxy) Start() error + func (p *TCPProxy) Stop() error + func (p *TCPProxy) UpdateRoute(hostname, backendHost string, backendPort int) + type UDPProxy struct + func NewUDPProxy(cfg *Config) *UDPProxy + func (p *UDPProxy) AddRoute(serverID, hostname, backendHost string, backendPort int) + func (p *UDPProxy) GetRoutes() map[string]*Route + func (p *UDPProxy) IsRunning() bool + func (p *UDPProxy) RemoveRoute(hostname string) + func (p *UDPProxy) SetRouteDown(hostname string, down bool) + func (p *UDPProxy) SetRouteHibernated(hostname string, hibernated bool) + func (p *UDPProxy) Start() error + func (p *UDPProxy) Stop() error + func (p *UDPProxy) UpdateRoute(hostname, backendHost string, backendPort int) + type ValkeyClient = routing.ValkeyClient + type ValkeySyncManager struct + func NewValkeySyncManager(client ValkeyClient, nodeID string, log *logger.Logger) *ValkeySyncManager + func (v *ValkeySyncManager) BroadcastRouteAdd(ctx context.Context, serverID, hostname, backendHost string, ...) error + func (v *ValkeySyncManager) BroadcastRouteRemove(ctx context.Context, hostname string, proxyPort int) error + func (v *ValkeySyncManager) Close() error + func (v *ValkeySyncManager) SetRemoteHandler(handler func(event *RoutingEvent)) + func (v *ValkeySyncManager) Start(ctx context.Context) error + type VarInt int32 + func ReadVarInt(r io.Reader) (VarInt, error) + func (v VarInt) Len() int + type WakeHandler func(ctx context.Context, serverID string) error