config

package

Go to main page

Versions in this module

v0

v0.61.1

Dec 16, 2024

v0.61.0

Oct 17, 2024

v0.60.0

Aug 19, 2024

v0.59.0

Jul 9, 2024

v0.58.1

May 31, 2024

v0.58.0

May 7, 2024

v0.57.0

Apr 9, 2024

v0.56.0

Mar 21, 2024

Changes in this version

+ type NumberPair struct

+ First int64

+ Second int64

v0.55.1

Mar 12, 2024

v0.55.0

Mar 12, 2024

v0.54.0

Feb 1, 2024

Changes in this version

+ func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName

v0.53.2

Dec 21, 2023

v0.53.1

Dec 21, 2023

v0.53.0

Dec 14, 2023

Changes in this version

+ func RegisterClientCommonConfigFlags(cmd *cobra.Command, c *v1.ClientCommonConfig, opts ...RegisterFlagOption)

+ func RegisterProxyFlags(cmd *cobra.Command, c v1.ProxyConfigurer, opts ...RegisterFlagOption)

+ func RegisterServerConfigFlags(cmd *cobra.Command, c *v1.ServerConfig, opts ...RegisterFlagOption)

+ func RegisterVisitorFlags(cmd *cobra.Command, c v1.VisitorConfigurer, opts ...RegisterFlagOption)

+ type BandwidthQuantityFlag struct

+ V *types.BandwidthQuantity

+ func (f *BandwidthQuantityFlag) Set(s string) error

+ func (f *BandwidthQuantityFlag) String() string

+ func (f *BandwidthQuantityFlag) Type() string

+ type BoolFuncFlag struct

+ FalseFunc func()

+ TrueFunc func()

+ func (f *BoolFuncFlag) Set(s string) error

+ func (f *BoolFuncFlag) String() string

+ func (f *BoolFuncFlag) Type() string

+ type PortsRangeSliceFlag struct

+ V *[]types.PortsRange

+ func (f *PortsRangeSliceFlag) Set(s string) error

+ func (f *PortsRangeSliceFlag) String() string

+ func (f *PortsRangeSliceFlag) Type() string

+ type RegisterFlagOption func(*registerFlagOptions)

+ func WithSSHMode() RegisterFlagOption

v0.52.3

Oct 24, 2023

v0.52.2

Oct 23, 2023

v0.52.1

Oct 11, 2023

v0.52.0

Oct 10, 2023

Changes in this version

+ func DetectLegacyINIFormat(content []byte) bool

+ func DetectLegacyINIFormatFromFile(path string) bool

+ func LoadAdditionalClientConfigs(paths []string, isLegacyFormat bool) ([]v1.ProxyConfigurer, []v1.VisitorConfigurer, error)

+ func LoadClientConfig(path string) (*v1.ClientCommonConfig, []v1.ProxyConfigurer, []v1.VisitorConfigurer, bool, ...)

+ func LoadConfigure(b []byte, c any) error

+ func LoadConfigureFromFile(path string, c any) error

+ func LoadFileContentWithTemplate(path string, values *Values) ([]byte, error)

+ func LoadServerConfig(path string) (*v1.ServerConfig, bool, error)

+ func NewProxyConfigurerFromMsg(m *msg.NewProxy, serverCfg *v1.ServerConfig) (v1.ProxyConfigurer, error)

+ func RenderWithTemplate(in []byte, values *Values) ([]byte, error)

v0.51.3

Aug 14, 2023

v0.51.2

Jul 25, 2023

v0.51.1

Jul 20, 2023

v0.51.0

Jul 5, 2023

v0.50.0

Jun 26, 2023

Changes in this version

type BaseProxyConf

+ func (cfg *BaseProxyConf) GetBaseConfig() *BaseProxyConf

+ func (cfg *BaseProxyConf) SetDefaultValues()

type BaseVisitorConf

+ ServerUser string

+ func (cfg *BaseVisitorConf) GetBaseConfig() *BaseVisitorConf

type HTTPProxyConf

+ func (cfg *HTTPProxyConf) ValidateForClient() (err error)

+ func (cfg *HTTPProxyConf) ValidateForServer(serverCfg ServerCommonConf) (err error)

type HTTPSProxyConf

+ func (cfg *HTTPSProxyConf) ValidateForClient() (err error)

+ func (cfg *HTTPSProxyConf) ValidateForServer(serverCfg ServerCommonConf) (err error)

type ProxyConf

+ GetBaseConfig func() *BaseProxyConf

+ SetDefaultValues func()

+ ValidateForClient func() error

+ ValidateForServer func(ServerCommonConf) error

+ type RoleServerCommonConf struct

+ AllowUsers []string

+ Role string

+ Sk string

type STCPProxyConf

+ func (cfg *STCPProxyConf) SetDefaultValues()

+ func (cfg *STCPProxyConf) ValidateForClient() (err error)

+ func (cfg *STCPProxyConf) ValidateForServer(serverCfg ServerCommonConf) error

type STCPVisitorConf

+ func (cfg *STCPVisitorConf) Validate() (err error)

type SUDPProxyConf

+ func (cfg *SUDPProxyConf) SetDefaultValues()

+ func (cfg *SUDPProxyConf) ValidateForClient() (err error)

+ func (cfg *SUDPProxyConf) ValidateForServer(serverCfg ServerCommonConf) error

type SUDPVisitorConf

+ func (cfg *SUDPVisitorConf) Validate() (err error)

type TCPMuxProxyConf

+ func (cfg *TCPMuxProxyConf) ValidateForClient() (err error)

+ func (cfg *TCPMuxProxyConf) ValidateForServer(serverCfg ServerCommonConf) (err error)

type TCPProxyConf

+ func (cfg *TCPProxyConf) ValidateForClient() (err error)

+ func (cfg *TCPProxyConf) ValidateForServer(serverCfg ServerCommonConf) error

type UDPProxyConf

+ func (cfg *UDPProxyConf) ValidateForClient() (err error)

+ func (cfg *UDPProxyConf) ValidateForServer(serverCfg ServerCommonConf) error

type VisitorConf

+ GetBaseConfig func() *BaseVisitorConf

+ Validate func() error

type XTCPProxyConf

+ func (cfg *XTCPProxyConf) SetDefaultValues()

+ func (cfg *XTCPProxyConf) ValidateForClient() (err error)

+ func (cfg *XTCPProxyConf) ValidateForServer(serverCfg ServerCommonConf) error

type XTCPVisitorConf

+ FallbackTimeoutMs int

+ FallbackTo string

+ func (cfg *XTCPVisitorConf) Validate() (err error)

v0.49.0

May 28, 2023

Changes in this version

type ClientCommonConf

+ NatHoleSTUNServer string

type ServerCommonConf

+ NatHoleAnalysisDataReserveHours int64

type XTCPVisitorConf

+ KeepTunnelOpen bool

+ MaxRetriesAnHour int

+ MinRetryInterval int

+ Protocol string

v0.48.0

Mar 8, 2023

Changes in this version

type ServerCommonConf

+ AllowPortsStr string

type TCPMuxProxyConf

+ HTTPPwd string

+ HTTPUser string

v0.47.0

Feb 9, 2023

Changes in this version

+ const BandwidthLimitModeClient

+ const BandwidthLimitModeServer

type BaseProxyConf

+ BandwidthLimitMode string

v0.46.1

Jan 10, 2023

v0.46.0

Dec 18, 2022

Changes in this version

type ClientCommonConf

+ QUICKeepalivePeriod int

+ QUICMaxIdleTimeout int

+ QUICMaxIncomingStreams int

type ServerCommonConf

+ QUICBindPort int

+ QUICKeepalivePeriod int

+ QUICMaxIdleTimeout int

+ QUICMaxIncomingStreams int

v0.45.0

Oct 26, 2022

v0.44.0

Jul 10, 2022

Changes in this version

type ServerCommonConf

+ DashboardTLSCertFile string

+ DashboardTLSKeyFile string

+ DashboardTLSMode bool

v0.43.0

May 27, 2022

Changes in this version

type HTTPProxyConf

+ RouteByHTTPUser string

type ServerCommonConf

+ TCPMuxPassthrough bool

type TCPMuxProxyConf

+ RouteByHTTPUser string

v0.42.0

Apr 22, 2022

v0.41.0

Mar 23, 2022

Changes in this version

type ClientCommonConf

+ DialServerKeepAlive int64

+ PprofEnable bool

type ServerCommonConf

+ PprofEnable bool

+ TCPKeepAlive int64

v0.40.0

Mar 11, 2022

Changes in this version

type ClientCommonConf

+ DialServerTimeout int64

v0.39.1

Feb 9, 2022

v0.39.0

Jan 26, 2022

Changes in this version

type ClientCommonConf

+ ConnectServerLocalIP string

+ TCPMuxKeepaliveInterval int64

type ServerCommonConf

+ TCPMuxKeepaliveInterval int64

v0.38.0

Oct 25, 2021

Changes in this version

type ClientCommonConf

+ DisableCustomTLSFirstByte bool

v0.37.1

Aug 3, 2021

v0.37.0

Jun 2, 2021

Changes in this version

type ClientCommonConf

+ IncludeConfigFiles []string

+ func ParseClientConfig(filePath string) (cfg ClientCommonConf, pxyCfgs map[string]ProxyConf, ...)

v0.36.2

Mar 22, 2021

Changes in this version

type ClientCommonConf

+ func (cfg *ClientCommonConf) Complete()

+ func (cfg *ClientCommonConf) Validate() error

type ServerCommonConf

+ func (cfg *ServerCommonConf) Complete()

+ func (cfg *ServerCommonConf) Validate() error

v0.36.1

Mar 18, 2021

v0.36.0

Mar 17, 2021

Changes in this version

+ func GetMapByPrefix(set map[string]string, prefix string) map[string]string

+ func GetMapWithoutPrefix(set map[string]string, prefix string) map[string]string

+ func LoadAllProxyConfsFromIni(prefix string, source interface{}, start []string) (map[string]ProxyConf, map[string]VisitorConf, error)

type BandwidthQuantity

+ func MustBandwidthQuantity(s string) BandwidthQuantity

type ClientCommonConf

+ TLSServerName string

type ProxyConf

+ func DefaultProxyConf(proxyType string) ProxyConf

type TCPProxyConf

+ RemotePort int

type UDPProxyConf

+ RemotePort int

type VisitorConf

+ func DefaultVisitorConf(visitorType string) VisitorConf

v0.35.1

Jan 25, 2021

v0.35.0

Jan 19, 2021

Changes in this version

type ClientCommonConf

+ HeartbeatInterval int64

+ HeartbeatTimeout int64

type ServerCommonConf

+ HeartbeatTimeout int64

v0.34.3

Nov 20, 2020

v0.34.2

Nov 6, 2020

v0.34.1

Sep 30, 2020

Changes in this version

+ const KB

+ const MB

+ func GetRenderedConfFromFile(path string) (out string, err error)

+ func LoadAllConfFromIni(prefix string, content string, startProxy map[string]struct{}) (proxyConfs map[string]ProxyConf, visitorConfs map[string]VisitorConf, ...)

+ func ParseRangeSection(name string, section ini.Section) (sections map[string]ini.Section, err error)

+ func RenderContent(in string) (out string, err error)

+ func UnmarshalPluginsFromIni(sections ini.File, cfg *ServerCommonConf)

+ type BandwidthQuantity struct

+ func NewBandwidthQuantity(s string) (BandwidthQuantity, error)

+ func (q *BandwidthQuantity) Bytes() int64

+ func (q *BandwidthQuantity) Equal(u *BandwidthQuantity) bool

+ func (q *BandwidthQuantity) MarshalJSON() ([]byte, error)

+ func (q *BandwidthQuantity) String() string

+ func (q *BandwidthQuantity) UnmarshalJSON(b []byte) error

+ func (q *BandwidthQuantity) UnmarshalString(s string) error

+ type BaseProxyConf struct

+ BandwidthLimit BandwidthQuantity

+ Group string

+ GroupKey string

+ Metas map[string]string

+ ProxyName string

+ ProxyProtocolVersion string

+ ProxyType string

+ UseCompression bool

+ UseEncryption bool

+ func (cfg *BaseProxyConf) GetBaseInfo() *BaseProxyConf

+ func (cfg *BaseProxyConf) MarshalToMsg(pMsg *msg.NewProxy)

+ func (cfg *BaseProxyConf) UnmarshalFromIni(prefix string, name string, section ini.Section) error

+ func (cfg *BaseProxyConf) UnmarshalFromMsg(pMsg *msg.NewProxy)

+ type BaseVisitorConf struct

+ BindAddr string

+ BindPort int

+ ProxyName string

+ ProxyType string

+ Role string

+ ServerName string

+ Sk string

+ UseCompression bool

+ UseEncryption bool

+ func (cfg *BaseVisitorConf) GetBaseInfo() *BaseVisitorConf

+ func (cfg *BaseVisitorConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

+ type BindInfoConf struct

+ RemotePort int

+ func (cfg *BindInfoConf) MarshalToMsg(pMsg *msg.NewProxy)

+ func (cfg *BindInfoConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

+ func (cfg *BindInfoConf) UnmarshalFromMsg(pMsg *msg.NewProxy)

+ type ClientCommonConf struct

+ AdminAddr string

+ AdminPort int

+ AdminPwd string

+ AdminUser string

+ AssetsDir string

+ DNSServer string

+ DisableLogColor bool

+ HTTPProxy string

+ HeartBeatInterval int64

+ HeartBeatTimeout int64

+ LogFile string

+ LogLevel string

+ LogMaxDays int64

+ LogWay string

+ LoginFailExit bool

+ Metas map[string]string

+ PoolCount int

+ Protocol string

+ ServerAddr string

+ ServerPort int

+ Start map[string]struct{}

+ TCPMux bool

+ TLSCertFile string

+ TLSEnable bool

+ TLSKeyFile string

+ TLSTrustedCaFile string

+ UDPPacketSize int64

+ User string

+ func GetDefaultClientConf() ClientCommonConf

+ func UnmarshalClientConfFromIni(content string) (cfg ClientCommonConf, err error)

+ func (cfg *ClientCommonConf) Check() (err error)

+ type DomainConf struct

+ CustomDomains []string

+ SubDomain string

+ func (cfg *DomainConf) MarshalToMsg(pMsg *msg.NewProxy)

+ func (cfg *DomainConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

+ func (cfg *DomainConf) UnmarshalFromMsg(pMsg *msg.NewProxy)

+ type HTTPProxyConf struct

+ HTTPPwd string

+ HTTPUser string

+ Headers map[string]string

+ HostHeaderRewrite string

+ Locations []string

+ func (cfg *HTTPProxyConf) CheckForCli() (err error)

+ func (cfg *HTTPProxyConf) CheckForSvr(serverCfg ServerCommonConf) (err error)

+ func (cfg *HTTPProxyConf) Compare(cmp ProxyConf) bool

+ func (cfg *HTTPProxyConf) MarshalToMsg(pMsg *msg.NewProxy)

+ func (cfg *HTTPProxyConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

+ func (cfg *HTTPProxyConf) UnmarshalFromMsg(pMsg *msg.NewProxy)

+ type HTTPSProxyConf struct

+ func (cfg *HTTPSProxyConf) CheckForCli() (err error)

+ func (cfg *HTTPSProxyConf) CheckForSvr(serverCfg ServerCommonConf) (err error)

+ func (cfg *HTTPSProxyConf) Compare(cmp ProxyConf) bool

+ func (cfg *HTTPSProxyConf) MarshalToMsg(pMsg *msg.NewProxy)

+ func (cfg *HTTPSProxyConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

+ func (cfg *HTTPSProxyConf) UnmarshalFromMsg(pMsg *msg.NewProxy)

+ type HealthCheckConf struct

+ HealthCheckAddr string

+ HealthCheckIntervalS int

+ HealthCheckMaxFailed int

+ HealthCheckTimeoutS int

+ HealthCheckType string

+ HealthCheckURL string

+ func (cfg *HealthCheckConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

+ type LocalSvrConf struct

+ LocalIP string

+ LocalPort int

+ Plugin string

+ PluginParams map[string]string

+ func (cfg *LocalSvrConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

+ type ProxyConf interface

+ CheckForCli func() error

+ CheckForSvr func(serverCfg ServerCommonConf) error

+ Compare func(conf ProxyConf) bool

+ GetBaseInfo func() *BaseProxyConf

+ MarshalToMsg func(pMsg *msg.NewProxy)

+ UnmarshalFromIni func(prefix string, name string, conf ini.Section) error

+ UnmarshalFromMsg func(pMsg *msg.NewProxy)

+ func NewConfByType(proxyType string) ProxyConf

+ func NewProxyConfFromIni(prefix string, name string, section ini.Section) (cfg ProxyConf, err error)

+ func NewProxyConfFromMsg(pMsg *msg.NewProxy, serverCfg ServerCommonConf) (cfg ProxyConf, err error)

+ type STCPProxyConf struct

+ Role string

+ Sk string

+ func (cfg *STCPProxyConf) CheckForCli() (err error)

+ func (cfg *STCPProxyConf) CheckForSvr(serverCfg ServerCommonConf) (err error)

+ func (cfg *STCPProxyConf) Compare(cmp ProxyConf) bool

+ func (cfg *STCPProxyConf) MarshalToMsg(pMsg *msg.NewProxy)

+ func (cfg *STCPProxyConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

+ func (cfg *STCPProxyConf) UnmarshalFromMsg(pMsg *msg.NewProxy)

+ type STCPVisitorConf struct

+ func (cfg *STCPVisitorConf) Check() (err error)

+ func (cfg *STCPVisitorConf) Compare(cmp VisitorConf) bool

+ func (cfg *STCPVisitorConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

+ type SUDPProxyConf struct

+ Role string

+ Sk string

+ func (cfg *SUDPProxyConf) CheckForCli() (err error)

+ func (cfg *SUDPProxyConf) CheckForSvr(serverCfg ServerCommonConf) (err error)

+ func (cfg *SUDPProxyConf) Compare(cmp ProxyConf) bool

+ func (cfg *SUDPProxyConf) MarshalToMsg(pMsg *msg.NewProxy)

+ func (cfg *SUDPProxyConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

+ func (cfg *SUDPProxyConf) UnmarshalFromMsg(pMsg *msg.NewProxy)

+ type SUDPVisitorConf struct

+ func (cfg *SUDPVisitorConf) Check() (err error)

+ func (cfg *SUDPVisitorConf) Compare(cmp VisitorConf) bool

+ func (cfg *SUDPVisitorConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

+ type ServerCommonConf struct

+ AllowPorts map[int]struct{}

+ AssetsDir string

+ BindAddr string

+ BindPort int

+ BindUDPPort int

+ Custom404Page string

+ DashboardAddr string

+ DashboardPort int

+ DashboardPwd string

+ DashboardUser string

+ DetailedErrorsToClient bool

+ DisableLogColor bool

+ EnablePrometheus bool

+ HTTPPlugins map[string]plugin.HTTPPluginOptions

+ HeartBeatTimeout int64

+ KCPBindPort int

+ LogFile string

+ LogLevel string

+ LogMaxDays int64

+ LogWay string

+ MaxPoolCount int64

+ MaxPortsPerClient int64

+ ProxyBindAddr string

+ SubDomainHost string

+ TCPMux bool

+ TCPMuxHTTPConnectPort int

+ TLSCertFile string

+ TLSKeyFile string

+ TLSOnly bool

+ TLSTrustedCaFile string

+ UDPPacketSize int64

+ UserConnTimeout int64

+ VhostHTTPPort int

+ VhostHTTPSPort int

+ VhostHTTPTimeout int64

+ func GetDefaultServerConf() ServerCommonConf

+ func UnmarshalServerConfFromIni(content string) (cfg ServerCommonConf, err error)

+ func (cfg *ServerCommonConf) Check() error

+ type TCPMuxProxyConf struct

+ Multiplexer string

+ func (cfg *TCPMuxProxyConf) CheckForCli() (err error)

+ func (cfg *TCPMuxProxyConf) CheckForSvr(serverCfg ServerCommonConf) (err error)

+ func (cfg *TCPMuxProxyConf) Compare(cmp ProxyConf) bool

+ func (cfg *TCPMuxProxyConf) MarshalToMsg(pMsg *msg.NewProxy)

+ func (cfg *TCPMuxProxyConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

+ func (cfg *TCPMuxProxyConf) UnmarshalFromMsg(pMsg *msg.NewProxy)

+ type TCPProxyConf struct

+ func (cfg *TCPProxyConf) CheckForCli() (err error)

+ func (cfg *TCPProxyConf) CheckForSvr(serverCfg ServerCommonConf) error

+ func (cfg *TCPProxyConf) Compare(cmp ProxyConf) bool

+ func (cfg *TCPProxyConf) MarshalToMsg(pMsg *msg.NewProxy)

+ func (cfg *TCPProxyConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

+ func (cfg *TCPProxyConf) UnmarshalFromMsg(pMsg *msg.NewProxy)

+ type UDPProxyConf struct

+ func (cfg *UDPProxyConf) CheckForCli() (err error)

+ func (cfg *UDPProxyConf) CheckForSvr(serverCfg ServerCommonConf) error

+ func (cfg *UDPProxyConf) Compare(cmp ProxyConf) bool

+ func (cfg *UDPProxyConf) MarshalToMsg(pMsg *msg.NewProxy)

+ func (cfg *UDPProxyConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

+ func (cfg *UDPProxyConf) UnmarshalFromMsg(pMsg *msg.NewProxy)

+ type Values struct

+ Envs map[string]string

+ func GetValues() *Values

+ type VisitorConf interface

+ Check func() error

+ Compare func(cmp VisitorConf) bool

+ GetBaseInfo func() *BaseVisitorConf

+ UnmarshalFromIni func(prefix string, name string, section ini.Section) error

+ func NewVisitorConfByType(cfgType string) VisitorConf

+ func NewVisitorConfFromIni(prefix string, name string, section ini.Section) (cfg VisitorConf, err error)

+ type XTCPProxyConf struct

+ Role string

+ Sk string

+ func (cfg *XTCPProxyConf) CheckForCli() (err error)

+ func (cfg *XTCPProxyConf) CheckForSvr(serverCfg ServerCommonConf) (err error)

+ func (cfg *XTCPProxyConf) Compare(cmp ProxyConf) bool

+ func (cfg *XTCPProxyConf) MarshalToMsg(pMsg *msg.NewProxy)

+ func (cfg *XTCPProxyConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

+ func (cfg *XTCPProxyConf) UnmarshalFromMsg(pMsg *msg.NewProxy)

+ type XTCPVisitorConf struct

+ func (cfg *XTCPVisitorConf) Check() (err error)

+ func (cfg *XTCPVisitorConf) Compare(cmp VisitorConf) bool

+ func (cfg *XTCPVisitorConf) UnmarshalFromIni(prefix string, name string, section ini.Section) (err error)

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