web

Documentation

Overview

Package web provides the Tailscale client for web.

Index

• type Server
  • func NewServer(ctx context.Context, opts ServerOpts) (s *Server, cleanup func())
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type ServerOpts

Types

type Server

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

Server is the backend server for a Tailscale web client.

func NewServer

func NewServer(ctx context.Context, opts ServerOpts) (s *Server, cleanup func())

NewServer constructs a new Tailscale web client server. The provided context should live for the duration of the Server's lifetime.

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP processes all requests for the Tailscale web client.

type ServerOpts

type ServerOpts struct {
	DevMode bool

	// CGIMode indicates if the server is running as a CGI script.
	CGIMode bool

	// PathPrefix is the URL prefix added to requests by CGI or reverse proxy.
	PathPrefix string

	// LocalClient is the tailscale.LocalClient to use for this web server.
	// If nil, a new one will be created.
	LocalClient *tailscale.LocalClient
}

ServerOpts contains options for constructing a new Server.