tunnel

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 30, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package tunnel provides tunnel implementations for exposing local servers.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsCloudflaredInstalled

func IsCloudflaredInstalled() bool

IsCloudflaredInstalled checks if cloudflared is available in PATH.

Types

type CloudflaredTunnel

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

CloudflaredTunnel implements the Tunnel interface using cloudflared.

func NewCloudflaredTunnel

func NewCloudflaredTunnel(localURL string) *CloudflaredTunnel

NewCloudflaredTunnel creates a new cloudflared tunnel.

func (*CloudflaredTunnel) GetPublicURL

func (t *CloudflaredTunnel) GetPublicURL() string

GetPublicURL returns the current public URL.

func (*CloudflaredTunnel) Start

func (t *CloudflaredTunnel) Start(ctx context.Context) (string, error)

Start starts the cloudflared tunnel and returns the public URL.

func (*CloudflaredTunnel) Status

func (t *CloudflaredTunnel) Status() ports.TunnelStatus

Status returns the current tunnel status.

func (*CloudflaredTunnel) StatusMessage

func (t *CloudflaredTunnel) StatusMessage() string

StatusMessage returns a human-readable status message.

func (*CloudflaredTunnel) Stop

func (t *CloudflaredTunnel) Stop() error

Stop stops the cloudflared tunnel.

Jump to

Keyboard shortcuts

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