joker

Documentation

Overview

Package joker implements a DNS provider for solving the DNS-01 challenge using joker.com.

Index

• Constants
• func NewDNSProvider() (challenge.ProviderTimeout, error)
• func NewDNSProviderConfig(config *Config) (challenge.ProviderTimeout, error)
• type Config
  • func NewDefaultConfig() *Config

Constants

const (
	EnvAPIKey   = envNamespace + "API_KEY"
	EnvUsername = envNamespace + "USERNAME"
	EnvPassword = envNamespace + "PASSWORD"
	EnvDebug    = envNamespace + "DEBUG"
	EnvMode     = envNamespace + "API_MODE"

	EnvTTL                = envNamespace + "TTL"
	EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
	EnvPollingInterval    = envNamespace + "POLLING_INTERVAL"
	EnvSequenceInterval   = envNamespace + "SEQUENCE_INTERVAL"
	EnvHTTPTimeout        = envNamespace + "HTTP_TIMEOUT"
)

Environment variables names.

Functions

func NewDNSProvider

func NewDNSProvider() (challenge.ProviderTimeout, error)

NewDNSProvider returns a DNSProvider instance configured for Joker. Credentials must be passed in the environment variable JOKER_API_KEY.

func NewDNSProviderConfig

func NewDNSProviderConfig(config *Config) (challenge.ProviderTimeout, error)

NewDNSProviderConfig return a DNSProvider instance configured for Joker.

Types

type Config

type Config struct {
	Debug              bool
	APIKey             string
	Username           string
	Password           string
	APIMode            string
	PropagationTimeout time.Duration
	PollingInterval    time.Duration
	SequenceInterval   time.Duration
	TTL                int
	HTTPClient         *http.Client
}

Config is used to configure the creation of the DNSProvider.

func NewDefaultConfig

func NewDefaultConfig() *Config

NewDefaultConfig returns a default configuration for the DNSProvider.