server

package

Go to main page

Versions in this module

v0

v0.6.0

Apr 15, 2026

Changes in this version

type Config

+ AuditBufferSize int

+ AuditEnabled bool

+ AuditPath string

+ AuditPersistence PersistenceType

+ ClusterNodeAddr string

+ ClusterNodeID string

+ ClusterRedisAddr string

+ ClusterRedisDB int

+ ClusterRedisPassword string

+ ClusterStateBackend string

+ OIDCClientID string

+ OIDCIssuer string

+ OIDCRoleClaim string

+ OIDCTeamClaim string

+ type MemoryStateStore struct

+ func NewMemoryStateStore() *MemoryStateStore

+ func (m *MemoryStateStore) Close() error

+ func (m *MemoryStateStore) EvictDeadNodes(olderThan time.Duration) error

+ func (m *MemoryStateStore) GetNodes() ([]NodeInfo, error)

+ func (m *MemoryStateStore) ListRoutes() ([]RouteEntry, error)

+ func (m *MemoryStateStore) LookupBySubdomain(subdomain string) (*RouteEntry, error)

+ func (m *MemoryStateStore) NodeHeartbeat(info NodeInfo) error

+ func (m *MemoryStateStore) RegisterRoute(entry RouteEntry) error

+ func (m *MemoryStateStore) UnregisterRoute(clientID string) error

+ type NodeInfo struct

+ LastHeartbeat time.Time

+ NodeAddr string

+ NodeID string

+ type RedisStateStore struct

+ func NewRedisStateStore(cfg RedisStateStoreConfig) (*RedisStateStore, error)

+ func (r *RedisStateStore) Close() error

+ func (r *RedisStateStore) EvictDeadNodes(_ time.Duration) error

+ func (r *RedisStateStore) GetNodes() ([]NodeInfo, error)

+ func (r *RedisStateStore) ListRoutes() ([]RouteEntry, error)

+ func (r *RedisStateStore) LookupBySubdomain(subdomain string) (*RouteEntry, error)

+ func (r *RedisStateStore) NodeHeartbeat(info NodeInfo) error

+ func (r *RedisStateStore) RegisterRoute(entry RouteEntry) error

+ func (r *RedisStateStore) UnregisterRoute(clientID string) error

+ type RedisStateStoreConfig struct

+ Addr string

+ DB int

+ Password string

+ type RouteEntry struct

+ ClientID string

+ NodeAddr string

+ NodeID string

+ RegisteredAt time.Time

+ Subdomain string

+ type StateStore interface

+ Close func() error

+ EvictDeadNodes func(olderThan time.Duration) error

+ GetNodes func() ([]NodeInfo, error)

+ ListRoutes func() ([]RouteEntry, error)

+ LookupBySubdomain func(subdomain string) (*RouteEntry, error)

+ NodeHeartbeat func(info NodeInfo) error

+ RegisterRoute func(entry RouteEntry) error

+ UnregisterRoute func(clientID string) error

v0.5.0

Apr 14, 2026

Changes in this version

type ClientSession

+ P2PTunnelID string

v0.4.4

Apr 11, 2026

v0.4.3

Apr 11, 2026

Changes in this version

type Config

+ EnableMetrics bool

+ type Metrics struct

+ ActiveClients prometheus.Gauge

+ ActiveTunnels prometheus.Gauge

+ AuthAttemptsTotal *prometheus.CounterVec

+ BytesTransferredTotal *prometheus.CounterVec

+ ConnectionsTotal prometheus.Counter

+ P2PConnectionsTotal *prometheus.CounterVec

+ RequestDurationSeconds prometheus.Histogram

+ RequestsTotal *prometheus.CounterVec

+ TunnelDurationSeconds prometheus.Histogram

+ func NewMetrics() *Metrics

+ func (m *Metrics) Registry() *prometheus.Registry

v0.4.2

Apr 11, 2026

v0.4.1

Apr 11, 2026

Changes in this version

type Config

+ MaxTunnelsPerClient int

type StatsResponse

+ MaxClients int

+ MaxTunnelsPerClient int

v0.4.0

Apr 11, 2026

Changes in this version

type Config

+ TunnelTLSEnabled bool

v0.3.1

Apr 10, 2026

v0.3.0

Apr 10, 2026

Changes in this version

+ type RevokeTeamTokensRequest struct

+ Team string

type TeamResponse

+ RevokedVersion int64

v0.2.0

Apr 10, 2026

Changes in this version

+ type AdminAPI struct

+ func NewAdminAPI(server *Server) *AdminAPI

+ func (a *AdminAPI) Handler() http.Handler

+ type ClientInfo struct

+ BytesIn uint64

+ BytesOut uint64

+ CreatedAt time.Time

+ ID string

+ LastSeen time.Time

+ RemoteAddr string

+ Subdomain string

+ Tunnels []TunnelJSON

+ type ClientSession struct

+ BytesIn uint64

+ BytesOut uint64

+ CreatedAt time.Time

+ ID string

+ LastSeen time.Time

+ Mux *tunnel.Mux

+ P2PLocalAddr string

+ P2PNATType string

+ P2PPublicAddr string

+ P2PPublicKey string

+ Role auth.Role

+ Subdomain string

+ TeamName string

+ Tunnels []*TunnelInfo

+ type Config struct

+ AdminAddr string

+ AdminToken string

+ AuthSecret string

+ AuthTimeout time.Duration

+ AuthTokens []string

+ AutoTLS bool

+ AutoTLSEmail string

+ Domain string

+ HTTPAddr string

+ IdleTimeout time.Duration

+ ListenAddr string

+ MaxClients int

+ MuxConfig tunnel.MuxConfig

+ Persistence PersistenceType

+ PersistencePath string

+ RateLimitBlockDuration time.Duration

+ RateLimitEnabled bool

+ RateLimitMaxFailures int

+ RateLimitWindow time.Duration

+ ReadTimeout time.Duration

+ RequireAuth bool

+ TCPPortRangeEnd int

+ TCPPortRangeStart int

+ TLSCertFile string

+ TLSEnabled bool

+ TLSKeyFile string

+ WriteTimeout time.Duration

+ func DefaultConfig() Config

+ type CreateTeamRequest struct

+ Name string

+ type ErrorResponse struct

+ Error string

+ type GenerateTokenRequest struct

+ Role string

+ Team string

+ type GenerateTokenResponse struct

+ Expires string

+ Role string

+ Team string

+ Token string

+ type HTTPHandler struct

+ func NewHTTPHandler(router *Router, server *Server) *HTTPHandler

+ func (h *HTTPHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type HealthResponse struct

+ Status string

+ Uptime string

+ Version string

+ type PersistenceType string

+ const PersistenceMemory

+ const PersistenceSQLite

+ type RateLimitResponse struct

+ BlockedIPs []string

+ Enabled bool

+ TrackedIPs int

+ type RefreshTokenRequest struct

+ ExtendBy string

+ RevokeOld bool

+ Token string

+ type RevokeTokenRequest struct

+ Token string

+ TokenID string

+ type Router struct

+ func NewRouter(domain string) *Router

+ func (r *Router) ActiveRoutes() int

+ func (r *Router) RegisterHostname(hostname string, client *ClientSession) error

+ func (r *Router) RegisterPath(pathPrefix string, client *ClientSession) error

+ func (r *Router) RegisterSubdomain(subdomain string, client *ClientSession) error

+ func (r *Router) Route(host, path string) *ClientSession

+ func (r *Router) SubdomainURL(subdomain string, useTLS bool) string

+ func (r *Router) Unregister(client *ClientSession)

+ type Server struct

+ func NewServer(config Config) *Server

+ func (s *Server) FindPeerForP2P(excludeClientID string) *ClientSession

+ func (s *Server) Shutdown() error

+ func (s *Server) Start(ctx context.Context) error

+ type Stats struct

+ ActiveClients uint64

+ ActiveTunnels uint64

+ BytesIn uint64

+ BytesOut uint64

+ Requests uint64

+ StartTime time.Time

+ TotalClients uint64

+ type StatsResponse struct

+ ActiveClients uint64

+ ActiveRoutes int

+ ActiveTunnels uint64

+ AllocatedPorts int

+ BytesIn uint64

+ BytesOut uint64

+ Requests uint64

+ TotalClients uint64

+ UptimeSeconds int64

+ type TCPPortAllocator struct

+ func NewTCPPortAllocator(start, end int) *TCPPortAllocator

+ func (a *TCPPortAllocator) Allocate(ctx context.Context) (int, net.Listener, error)

+ func (a *TCPPortAllocator) AllocatedPorts() int

+ func (a *TCPPortAllocator) CloseAll()

+ func (a *TCPPortAllocator) Release(port int)

+ type TLSManager struct

+ func NewTLSManager(config Config) *TLSManager

+ func (m *TLSManager) HTTPChallengeHandler() http.Handler

+ func (m *TLSManager) TLSConfig() (*tls.Config, error)

+ func (m *TLSManager) WrapListener(ln net.Listener) net.Listener

+ type TeamResponse struct

+ CreatedAt string

+ Name string

+ Tokens int

+ type TunnelInfo struct

+ CreatedAt time.Time

+ ID string

+ LocalPort uint32

+ Protocol proto.Protocol

+ PublicURL string

+ TCPPort uint32

+ type TunnelJSON struct

+ CreatedAt string

+ ID string

+ LocalPort uint32

+ Protocol string

+ PublicURL string

+ TCPPort uint32

+ type UnblockRequest struct

+ IP string

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