config

package

v0.57.0 Latest Latest Go to latest Published: Apr 9, 2024 License: Apache-2.0 Imports: 21 Imported by: 33

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/fatedier/frp

Links

Open Source Insights

Documentation ¶

Index ¶

func DetectLegacyINIFormat(content []byte) bool
func DetectLegacyINIFormatFromFile(path string) bool
func LoadAdditionalClientConfigs(paths []string, isLegacyFormat bool, strict bool) ([]v1.ProxyConfigurer, []v1.VisitorConfigurer, error)
func LoadClientConfig(path string, strict bool) (*v1.ClientCommonConfig, []v1.ProxyConfigurer, []v1.VisitorConfigurer, bool, ...)
func LoadConfigure(b []byte, c any, strict bool) error
func LoadConfigureFromFile(path string, c any, strict bool) error
func LoadFileContentWithTemplate(path string, values *Values) ([]byte, error)
func LoadServerConfig(path string, strict bool) (*v1.ServerConfig, bool, error)
func NewProxyConfigurerFromMsg(m *msg.NewProxy, serverCfg *v1.ServerConfig) (v1.ProxyConfigurer, error)
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)
func RenderWithTemplate(in []byte, values *Values) ([]byte, error)
func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
type BandwidthQuantityFlag
- func (f *BandwidthQuantityFlag) Set(s string) error
- func (f *BandwidthQuantityFlag) String() string
- func (f *BandwidthQuantityFlag) Type() string
type BoolFuncFlag
- func (f *BoolFuncFlag) Set(s string) error
- func (f *BoolFuncFlag) String() string
- func (f *BoolFuncFlag) Type() string
type NumberPair
type PortsRangeSliceFlag
- func (f *PortsRangeSliceFlag) Set(s string) error
- func (f *PortsRangeSliceFlag) String() string
- func (f *PortsRangeSliceFlag) Type() string
type RegisterFlagOption
- func WithSSHMode() RegisterFlagOption
type Values
- func GetValues() *Values

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DetectLegacyINIFormat ¶ added in v0.52.0

func DetectLegacyINIFormat(content []byte) bool

func DetectLegacyINIFormatFromFile ¶ added in v0.52.0

func DetectLegacyINIFormatFromFile(path string) bool

func LoadAdditionalClientConfigs ¶ added in v0.52.0

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

func LoadClientConfig ¶ added in v0.52.0

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

func LoadConfigure ¶ added in v0.52.0

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

LoadConfigure loads configuration from bytes and unmarshal into c. Now it supports json, yaml and toml format.

func LoadConfigureFromFile ¶ added in v0.52.0

func LoadConfigureFromFile(path string, c any, strict bool) error

func LoadFileContentWithTemplate ¶ added in v0.52.0

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

func LoadServerConfig ¶ added in v0.52.0

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

func NewProxyConfigurerFromMsg ¶ added in v0.52.0

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

func RegisterClientCommonConfigFlags ¶ added in v0.53.0

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

func RegisterProxyFlags ¶ added in v0.53.0

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

func RegisterServerConfigFlags ¶ added in v0.53.0

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

func RegisterVisitorFlags ¶ added in v0.53.0

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

func RenderWithTemplate ¶ added in v0.52.0

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

func WordSepNormalizeFunc ¶ added in v0.54.0

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

WordSepNormalizeFunc changes all flags that contain "_" separators

Types ¶

type BandwidthQuantityFlag ¶ added in v0.53.0

type BandwidthQuantityFlag struct {
	V *types.BandwidthQuantity
}

func (*BandwidthQuantityFlag) Set ¶ added in v0.53.0

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

func (*BandwidthQuantityFlag) String ¶ added in v0.53.0

func (f *BandwidthQuantityFlag) String() string

func (*BandwidthQuantityFlag) Type ¶ added in v0.53.0

func (f *BandwidthQuantityFlag) Type() string

type BoolFuncFlag ¶ added in v0.53.0

type BoolFuncFlag struct {
	TrueFunc  func()
	FalseFunc func()
	// contains filtered or unexported fields
}

func (*BoolFuncFlag) Set ¶ added in v0.53.0

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

func (*BoolFuncFlag) String ¶ added in v0.53.0

func (f *BoolFuncFlag) String() string

func (*BoolFuncFlag) Type ¶ added in v0.53.0

func (f *BoolFuncFlag) Type() string

type NumberPair ¶ added in v0.56.0

type NumberPair struct {
	First  int64
	Second int64
}

type PortsRangeSliceFlag ¶ added in v0.53.0

type PortsRangeSliceFlag struct {
	V *[]types.PortsRange
}

func (*PortsRangeSliceFlag) Set ¶ added in v0.53.0

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

func (*PortsRangeSliceFlag) String ¶ added in v0.53.0

func (f *PortsRangeSliceFlag) String() string

func (*PortsRangeSliceFlag) Type ¶ added in v0.53.0

func (f *PortsRangeSliceFlag) Type() string

type RegisterFlagOption ¶ added in v0.53.0

type RegisterFlagOption func(*registerFlagOptions)

func WithSSHMode ¶ added in v0.53.0

func WithSSHMode() RegisterFlagOption

type Values ¶

type Values struct {
	Envs map[string]string // environment vars
}

func GetValues ¶

func GetValues() *Values

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
legacy
types
v1
validation

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