docker

Documentation

Overview

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

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

Index

• Constants
• type Client
  • func New(log zerolog.Logger, name string, provider *config.DockerTargetProviderConfig) (*Client, error)
  • func (c *Client) AddTarget(id string) (*proxyconfig.Config, error)
  • func (c *Client) Close()
  • func (c *Client) DeleteProxy(id string) error
  • func (c *Client) GetDefaultProxyProviderName() string
  • func (c *Client) WatchEvents(ctx context.Context, eventsChan chan targetproviders.TargetEvent, ...)

Constants

const (
	// Constants to be used in container labels
	LabelPrefix    = "tsdproxy."
	LabelIsEnabled = LabelEnable + "=true"

	// Container config labels.
	LabelEnable             = LabelPrefix + "enable"
	LabelName               = LabelPrefix + "name"
	LabelContainerPort      = LabelPrefix + "container_port"
	LabelEphemeral          = LabelPrefix + "ephemeral"
	LabelRunWebClient       = LabelPrefix + "runwebclient"
	LabelTsnetVerbose       = LabelPrefix + "tsnet_verbose"
	LabelFunnel             = LabelPrefix + "funnel"
	LabelAuthKey            = LabelPrefix + "authkey"
	LabelAuthKeyFile        = LabelPrefix + "authkeyfile"
	LabelContainerAccessLog = LabelPrefix + "containeraccesslog"
	LabelProxyProvider      = LabelPrefix + "proxyprovider"
	LabelAutoDetect         = LabelPrefix + "autodetect"
	LabelScheme             = LabelPrefix + "scheme"
	LabelTLSValidate        = LabelPrefix + "tlsvalidate"

	// Dashboard config labels
	LabelDashboardPrefix  = LabelPrefix + "dash."
	LabelDashboardVisible = LabelDashboardPrefix + "visible"
	LabelDashboardLabel   = LabelDashboardPrefix + "label"
	LabelDashboardIcon    = LabelDashboardPrefix + "icon"

	// docker only defaults
	DefaultAutoDetect   = true
	DefaultTargetScheme = "http"
)

Types

type Client

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

Client struct implements TargetProvider

func New

func New(log zerolog.Logger, name string, provider *config.DockerTargetProviderConfig) (*Client, error)

New function returns a new Docker TargetProvider

func (*Client) AddTarget

func (c *Client) AddTarget(id string) (*proxyconfig.Config, error)

AddTarget method implements TargetProvider AddTarget method

func (*Client) Close

func (c *Client) Close()

Close method implements TargetProvider Close method.

func (*Client) DeleteProxy

func (c *Client) DeleteProxy(id string) error

DeleteProxy method implements TargetProvider DeleteProxy method

func (*Client) GetDefaultProxyProviderName

func (c *Client) GetDefaultProxyProviderName() string

GetDefaultProxyProviderName method implements TargetProvider GetDefaultProxyProviderName method

func (*Client) WatchEvents

func (c *Client) WatchEvents(ctx context.Context, eventsChan chan targetproviders.TargetEvent, errChan chan error)

WatchEvents method implements TargetProvider WatchEvents method