devtunnel

Documentation

Index

• Variables
• type Config
  • func GenerateConfig() (Config, error)
• type Node
  • func FindClosestNode() (Node, error)
• type Region
• type ServerResponse
• type Tunnel
  • func New(ctx context.Context, logger slog.Logger) (*Tunnel, <-chan error, error)
  • func NewWithConfig(ctx context.Context, logger slog.Logger, cfg Config) (*Tunnel, <-chan error, error)

Variables

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

Types

type Config

type Config struct {
	Version    int                    `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() (Config, error)

type Node

type Node struct {
	ID                int    `json:"id"`
	RegionID          int    `json:"region_id"`
	HostnameHTTPS     string `json:"hostname_https"`
	HostnameWireguard string `json:"hostname_wireguard"`
	WireguardPort     uint16 `json:"wireguard_port"`

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

func FindClosestNode

func FindClosestNode() (Node, error)

type Region

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

type ServerResponse

type ServerResponse struct {
	Hostname        string     `json:"hostname"`
	ServerIP        netip.Addr `json:"server_ip"`
	ServerPublicKey string     `json:"server_public_key"` // hex
	ClientIP        netip.Addr `json:"client_ip"`
}

type Tunnel

type Tunnel struct {
	URL      string
	Listener net.Listener
}

func New

func New(ctx context.Context, logger slog.Logger) (*Tunnel, <-chan error, 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.

func NewWithConfig

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

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