devtunnel

Documentation

Index

• Variables
• func New(ctx context.Context, logger slog.Logger, customTunnelHost string) (*tunnelsdk.Tunnel, error)
• func NewWithConfig(ctx context.Context, logger slog.Logger, cfg Config) (*tunnelsdk.Tunnel, error)
• type Config
  • func GenerateConfig(customTunnelHost string) (Config, error)
• type Node
  • func FindClosestNode(nodes []Node) (Node, error)
  • func Nodes(customTunnelHost string) ([]Node, error)
• type Region

Variables

var Regions = []Region{
	{
		ID:           0,
		LocationName: "US East Pittsburgh",
		Nodes: []Node{
			{
				ID:            1,
				RegionID:      0,
				HostnameHTTPS: "pit-1.try.coder.app",
			},
		},
	},
}

Functions

func New

func New(ctx context.Context, logger slog.Logger, customTunnelHost string) (*tunnelsdk.Tunnel, error)

New creates a tunnel with a public URL and returns a listener for incoming connections on that URL. Connections are made over the wireguard protocol. Tunnel configuration is cached in the user's config directory. Successive calls to New will always use the same URL. If multiple public URLs in parallel are required, use NewWithConfig.

This uses https://github.com/coder/wgtunnel as the server and client implementation.

func NewWithConfig

func NewWithConfig(ctx context.Context, logger slog.Logger, cfg Config) (*tunnelsdk.Tunnel, error)

NewWithConfig calls New with the given config. For documentation, see New.

Types

type Config

type Config struct {
	Version    tunnelsdk.TunnelVersion `json:"version"`
	PrivateKey device.NoisePrivateKey  `json:"private_key"`
	PublicKey  device.NoisePublicKey   `json:"public_key"`

	Tunnel Node `json:"tunnel"`

	// Used in testing.  Normally this is nil, indicating to use DefaultClient.
	HTTPClient *http.Client `json:"-"`
}

func GenerateConfig

func GenerateConfig(customTunnelHost string) (Config, error)

type Node

type Node struct {
	ID            int    `json:"id"`
	RegionID      int    `json:"region_id"`
	HostnameHTTPS string `json:"hostname_https"`

	AvgLatency time.Duration `json:"-"`
}

func FindClosestNode

func FindClosestNode(nodes []Node) (Node, error)

FindClosestNode pings each node and returns the one with the lowest latency.

func Nodes

func Nodes(customTunnelHost string) ([]Node, error)

Nodes returns a list of nodes to use for the tunnel. It will pick a random node from each region.

If a customNode is provided, it will be returned as the only node with ID 9999.

type Region

type Region struct {
	ID           int
	LocationName string
	Nodes        []Node
}