frp

Documentation

Index

• func GetFRPServerPort(host string) (string, error)
• func StartFRPCDockerContainer(ipaddress string, port string, Docker *docker.DockerVM) (*docker.DockerVM, error)
• func StartFRPClientForServer(ipaddress string, port string, localport string, remoteport string) (string, error)
• func StartFRPProxyFromRandom() (int, error)
• type Client
  • func (c *Client) StartFRPClient() error
• type ClientMapping
• type Server
  • func (s *Server) StartFRPServer() error

Functions

func GetFRPServerPort

func GetFRPServerPort(host string) (string, error)

GetFRPServerPort Gets the port no from the FRPServer to establish the FRP connection needed.

func StartFRPCDockerContainer

func StartFRPCDockerContainer(ipaddress string, port string, Docker *docker.DockerVM) (*docker.DockerVM, error)

func StartFRPClientForServer

func StartFRPClientForServer(ipaddress string, port string, localport string, remoteport string) (string, error)

StartFRPClientForServer Starts Server using FRP server returns back a port remote port is a custom external port a user would want to open. This under the assumption the user knows the exact port available in server doing the TURN connection.

func StartFRPProxyFromRandom

func StartFRPProxyFromRandom() (int, error)

StartFRPProxyFromRandom starts reverse proxy server based on a random port generated

Types

type Client

type Client struct {
	Name           string
	Server         *Server
	ClientMappings []ClientMapping
}

Client This struct stores client information with server proxy connected

func (*Client) StartFRPClient

func (c *Client) StartFRPClient() error

StartFRPClient Starts FRP client

type ClientMapping

type ClientMapping struct {
	LocalIP    string
	LocalPort  int
	RemotePort int
}

ClientMapping Stores client mapping ports to proxy server

type Server

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

func (*Server) StartFRPServer

func (s *Server) StartFRPServer() error

StartFRPServer The initial plan is only support reverse proxy for TCP ports This function starts a server that can act as a reverse proxy for nodes behind NAT.