Documentation

Overview

    Package alidns implements a DNS provider for solving the DNS-01 challenge using Alibaba Cloud DNS.

    Index

    Constants

    View Source
    const (
    	EnvAccessKey = envNamespace + "ACCESS_KEY"
    	EnvSecretKey = envNamespace + "SECRET_KEY"
    	EnvRegionID  = envNamespace + "REGION_ID"
    
    	EnvTTL                = envNamespace + "TTL"
    	EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
    	EnvPollingInterval    = envNamespace + "POLLING_INTERVAL"
    	EnvHTTPTimeout        = envNamespace + "HTTP_TIMEOUT"
    )

      Environment variables names.

      Variables

      This section is empty.

      Functions

      This section is empty.

      Types

      type Config

      type Config struct {
      	APIKey             string
      	SecretKey          string
      	RegionID           string
      	PropagationTimeout time.Duration
      	PollingInterval    time.Duration
      	TTL                int
      	HTTPTimeout        time.Duration
      }

        Config is used to configure the creation of the DNSProvider.

        func NewDefaultConfig

        func NewDefaultConfig() *Config

          NewDefaultConfig returns a default configuration for the DNSProvider.

          type DNSProvider

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

            DNSProvider implements the challenge.Provider interface.

            func NewDNSProvider

            func NewDNSProvider() (*DNSProvider, error)

              NewDNSProvider returns a DNSProvider instance configured for Alibaba Cloud DNS. Credentials must be passed in the environment variables: ALICLOUD_ACCESS_KEY and ALICLOUD_SECRET_KEY.

              func NewDNSProviderConfig

              func NewDNSProviderConfig(config *Config) (*DNSProvider, error)

                NewDNSProviderConfig return a DNSProvider instance configured for alidns.

                func (*DNSProvider) CleanUp

                func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error

                  CleanUp removes the TXT record matching the specified parameters.

                  func (*DNSProvider) Present

                  func (d *DNSProvider) Present(domain, token, keyAuth string) error

                    Present creates a TXT record to fulfill the dns-01 challenge.

                    func (*DNSProvider) Timeout

                    func (d *DNSProvider) Timeout() (timeout, interval time.Duration)

                      Timeout returns the timeout and interval to use when checking for DNS propagation. Adjusting here to cope with spikes in propagation times.

                      Source Files