Help us shape the future of Go! Take the 2026 Go Developer Survey

agent

package
v1.1.13 Latest Latest
Warning

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

Go to latest
Published: Sep 28, 2026 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Index

Constants

View Source
const EnrollmentV = "1"
View Source
const RegistryV = "1"

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessPrivateRequest added in v1.0.1

type AccessPrivateRequest struct {
	Token           string   `json:"token"`
	BindAddress     string   `json:"bind_address"`
	AutoMode        bool     `json:"auto_mode"`
	AutoAddress     string   `json:"auto_address"`
	AutoStartPort   uint16   `json:"auto_start_port"`
	AutoEndPort     uint16   `json:"auto_end_port"`
	ResponseHeaders []string `json:"response_headers"`
}

type Agent

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

func NewAgent

func NewAgent(cfg *AgentConfig, root env_core.Root) (*Agent, error)

func (*Agent) AccessPrivate added in v1.0.1

func (a *Agent) AccessPrivate(req *AccessPrivateRequest) (frontendToken string, err error)

func (*Agent) Config

func (a *Agent) Config() *AgentConfig

func (*Agent) ReleaseAccess added in v1.0.1

func (a *Agent) ReleaseAccess(frontendToken string) error

func (*Agent) ReleaseShare added in v1.0.1

func (a *Agent) ReleaseShare(shareToken string) error

func (*Agent) ReloadRegistry added in v1.0.1

func (a *Agent) ReloadRegistry() error

func (*Agent) Run

func (a *Agent) Run() error

func (*Agent) SaveRegistry added in v1.0.1

func (a *Agent) SaveRegistry() error

func (*Agent) ShareHttpHealthcheck added in v1.0.7

func (a *Agent) ShareHttpHealthcheck(shareToken, endpoint, httpVerb string, expectedHttpResponse, timeoutMs int) error

func (*Agent) SharePrivate added in v1.0.1

func (a *Agent) SharePrivate(req *SharePrivateRequest) (shareToken string, err error)

func (*Agent) SharePublic added in v1.0.1

func (a *Agent) SharePublic(req *SharePublicRequest) (shareToken string, frontendEndpoint []string, err error)

func (*Agent) ShareReserved added in v1.0.1

func (a *Agent) ShareReserved(req *ShareReservedRequest) (*ShareReservedResponse, error)

func (*Agent) Shutdown

func (a *Agent) Shutdown()

type AgentConfig

type AgentConfig struct {
	ConsoleAddress   string
	ConsoleStartPort uint16
	ConsoleEndPort   uint16
	ConsoleEnabled   bool
	RequireRemoting  bool
}

func DefaultConfig

func DefaultConfig() *AgentConfig

type Enrollment added in v1.0.5

type Enrollment struct {
	V     string `json:"v"`
	Token string `json:"token"`
}

func LoadEnrollment added in v1.0.5

func LoadEnrollment(path string) (*Enrollment, error)

func NewEnrollment added in v1.0.5

func NewEnrollment(token string) *Enrollment

func (*Enrollment) Save added in v1.0.5

func (e *Enrollment) Save(path string) error

type Registry added in v1.0.1

type Registry struct {
	V               string                  `json:"v"`
	ReservedShares  []*ShareReservedRequest `json:"reserved_shares"`
	PrivateAccesses []*AccessPrivateRequest `json:"private_accesses"`
}

func LoadRegistry added in v1.0.1

func LoadRegistry(path string) (*Registry, error)

func (*Registry) Save added in v1.0.1

func (r *Registry) Save(path string) error

type SharePrivateRequest added in v1.0.1

type SharePrivateRequest struct {
	Target       string   `json:"target"`
	BackendMode  string   `json:"backend_mode"`
	Insecure     bool     `json:"insecure"`
	Closed       bool     `json:"closed"`
	AccessGrants []string `json:"access_grants"`
}

type SharePublicRequest added in v1.0.1

type SharePublicRequest struct {
	Target                    string   `json:"target"`
	BasicAuth                 []string `json:"basic_auth"`
	FrontendSelection         []string `json:"frontend_selection"`
	BackendMode               string   `json:"backend_mode"`
	Insecure                  bool     `json:"insecure"`
	OauthProvider             string   `json:"oauth_provider"`
	OauthEmailAddressPatterns []string `json:"oauth_email_address_patterns"`
	OauthCheckInterval        string   `json:"oauth_check_interval"`
	Closed                    bool     `json:"closed"`
	AccessGrants              []string `json:"access_grants"`
}

type ShareReservedRequest added in v1.0.1

type ShareReservedRequest struct {
	Token            string `json:"token"`
	OverrideEndpoint string `json:"override_endpoint"`
	Insecure         bool   `json:"insecure"`
}

type ShareReservedResponse added in v1.0.1

type ShareReservedResponse struct {
	Token             string
	BackendMode       string
	ShareMode         string
	FrontendEndpoints []string
	Target            string
}

Directories

Path Synopsis
Package agentGrpc is a reverse proxy.
Package agentGrpc is a reverse proxy.

Jump to

Keyboard shortcuts

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