proxyconfig

Documentation

Overview

SPDX-FileCopyrightText: 2024 Paulo Almeida <almeidapaulopt@gmail.com> SPDX-License-Identifier: MIT

SPDX-FileCopyrightText: 2025 Paulo Almeida <almeidapaulopt@gmail.com> SPDX-License-Identifier: MIT

Index

• Constants
• func ProxyStateString(s ProxyState) string
• type Config
  • func NewConfig() (*Config, error)
• type Dashboard
• type ProxyState
• type Tailscale

Constants

const (
	// Default values to proxyconfig
	//
	DefaultProxyAccessLog = true
	DefaultProxyProvider  = ""
	DefaultTLSValidate    = true

	// tailscale defaults
	DefaultTailscaleEphemeral    = true
	DefaultTailscaleRunWebClient = false
	DefaultTailscaleVerbose      = false
	DefaultTailscaleFunnel       = false
	DefaultTailscaleControlURL   = ""

	// Dashboard defauts
	DefaultDashboardVisible = true
	DefaultDashboardIcon    = "tsdproxy"
)

Functions

func ProxyStateString

func ProxyStateString(s ProxyState) string

Types

type Config

type Config struct {
	Tailscale Tailscale `validate:"dive"`
	Dashboard Dashboard `validate:"dive"`
	// Global
	TargetProvider string
	TargetID       string
	ProxyProvider  string
	TargetURL      *url.URL
	ProxyURL       *url.URL
	Hostname       string
	ProxyAccessLog bool `default:"true" validate:"boolean"`
	TLSValidate    bool `default:"true" validate:"boolean"`
}

Config struct stores all the configuration for the proxy

func NewConfig

func NewConfig() (*Config, error)

type Dashboard

type Dashboard struct {
	Label   string `validate:"string" yaml:"label"`
	Icon    string `default:"tsdproxy" validate:"string" yaml:"icon"`
	Visible bool   `default:"true" validate:"boolean" yaml:"visible"`
}

type ProxyState

type ProxyState int32

const (
	ProxyStateInitializing ProxyState = iota
	ProxyStateStarting
	ProxyStateAuthenticating
	ProxyStateRunning
	ProxyStateStopping
	ProxyStateStopped
	ProxyStateError
)

type Tailscale

type Tailscale struct {
	AuthKey      string
	Ephemeral    bool `default:"true" validate:"boolean"`
	RunWebClient bool `default:"false" validate:"boolean"`
	Verbose      bool `default:"false" validate:"boolean"`
	Funnel       bool `default:"false" validate:"boolean"`
}

Tailscale struct stores the configuration for tailscale ProxyProvider