gdns

Documentation

Index

• Constants
• func FetchExternalIP() (*net.IP, error)
• func UpdateDNS(ctx context.Context, ip net.IP, name string, credentials *Credentials) error
• type Credentials
• type Cron
  • func NewCron(config *UpdateConfig, tickerRate time.Duration) Cron
• type DNSRecord
• type IpifyResponse
• type UpdateConfig

Constants

const (
	// GoogleDomainsUpdateAPI is the endpoint to update Dynamic DNS records
	GoogleDomainsUpdateAPI string = "https://domains.google.com/nic/update"
)

const (
	// IpifyAPI is the endpoint to get the external IP
	IpifyAPI string = "https://api.ipify.org"
)

Functions

func FetchExternalIP

func FetchExternalIP() (*net.IP, error)

func UpdateDNS

func UpdateDNS(ctx context.Context, ip net.IP, name string, credentials *Credentials) error

Types

type Credentials

type Credentials struct {
	Username string
	Password string
}

type Cron

type Cron interface {
	Start()
	Shutdown()
	Refresh(cfg *UpdateConfig) error
}

func NewCron

func NewCron(config *UpdateConfig, tickerRate time.Duration) Cron

type DNSRecord

type DNSRecord struct {
	Name     string
	Username string
	Password string
}

type IpifyResponse

type IpifyResponse struct {
	IP string `json:"ip"`
}

type UpdateConfig

type UpdateConfig struct {
	DNSRecords []DNSRecord
	IP         net.IP
}