Multi-Provider Configuration Guide

GoDNS now supports configuring multiple DNS providers simultaneously, allowing you to manage domains across different DNS services from a single GoDNS instance.

Features

Multi-Provider Support: Configure multiple DNS providers (Cloudflare, DNSPod, DigitalOcean, etc.) in one config file
Per-Domain Provider: Specify different providers for different domains
Full Backward Compatibility: Existing single-provider configurations continue to work unchanged
Mixed Configuration: Combine legacy global provider with new per-domain providers
Provider-Specific Credentials: Each provider can have its own authentication credentials

Configuration Options

Option 1: Multi-Provider Configuration

Configure multiple providers with per-domain assignment:

{
  "providers": {
    "Cloudflare": {
      "email": "user@example.com",
      "password": "your-cloudflare-api-token"
    },
    "DNSPod": {
      "login_token": "your-dnspod-token"
    },
    "DigitalOcean": {
      "login_token": "your-digitalocean-api-token"
    }
  },
  "domains": [
    {
      "domain_name": "example.com",
      "sub_domains": ["www", "api"],
      "provider": "Cloudflare"
    },
    {
      "domain_name": "mysite.net",
      "sub_domains": ["mail", "ftp"], 
      "provider": "DNSPod"
    }
  ]
}

Option 2: Legacy Single-Provider (Backward Compatible)

Existing configurations continue to work unchanged:

{
  "provider": "DNSPod",
  "login_token": "your-dnspod-token",
  "domains": [
    {
      "domain_name": "example.com",
      "sub_domains": ["www", "test"]
    }
  ]
}

Option 3: Mixed Configuration

Combine global provider with specific per-domain providers:

{
  "provider": "DNSPod", 
  "login_token": "your-dnspod-token",
  "providers": {
    "Cloudflare": {
      "email": "user@example.com",
      "password": "your-cloudflare-api-token"
    }
  },
  "domains": [
    {
      "domain_name": "oldsite.com",
      "sub_domains": ["www", "mail"]
    },
    {
      "domain_name": "newsite.com", 
      "sub_domains": ["www", "api"],
      "provider": "Cloudflare"
    }
  ]
}

Provider Configuration Fields

Each provider in the providers section supports these common fields:

email: Email address for authentication (Cloudflare, etc.)
password: API token or password
password_file: Path to file containing password/token
login_token: Login token for token-based auth (DNSPod, etc.)
login_token_file: Path to file containing login token
app_key: Application key (provider-specific)
app_secret: Application secret (provider-specific)
consumer_key: Consumer key (provider-specific)

Domain Configuration

Domains support an optional provider field:

{
  "domain_name": "example.com",
  "sub_domains": ["www", "api", "@"],
  "provider": "Cloudflare"
}

If provider is omitted, the domain uses the global provider setting.

Supported Providers

All existing providers are supported in multi-provider mode. Use these exact provider names in your configuration:

Provider Name	Configuration Value	Authentication Methods
Cloudflare	`"Cloudflare"`	`email` + `password` OR `login_token`
DNSPod	`"DNSPod"`	`password` OR `login_token`
DigitalOcean	`"DigitalOcean"`	`login_token`
AliDNS	`"AliDNS"`	`email` + `password`
Google Domains	`"Google"`	`email` + `password`
Hurricane Electric	`"HE"`	`password`
Dreamhost	`"Dreamhost"`	`login_token`
Duck DNS	`"DuckDNS"`	`login_token`
NoIP	`"NoIP"`	`email` + `password`
Scaleway	`"Scaleway"`	`login_token`
DynV6	`"Dynv6"`	`login_token`
Linode	`"Linode"`	`login_token`
Strato	`"Strato"`	`password`
LoopiaSE	`"LoopiaSE"`	`password`
Infomaniak	`"Infomaniak"`	`password`
Hetzner	`"Hetzner"`	`login_token`
OVH	`"OVH"`	`app_key` + `app_secret` + `consumer_key`
Dynu	`"Dynu"`	`password`
IONOS	`"IONOS"`	`login_token`
TransIP	`"TransIP"`	`email` + `login_token`

Important: Provider names are case-sensitive. Use the exact values from the “Configuration Value” column.

Migration Guide

From Single to Multi-Provider

Keep existing config working: No changes needed for current setups

Add new providers gradually:

{
  "provider": "DNSPod",        // Keep existing
  "login_token": "old-token",
  "providers": {               // Add new providers
    "Cloudflare": {
      "email": "user@example.com",
      "password": "cf-token"
    }
  },
  "domains": [
    {
      "domain_name": "old-domain.com",
      "sub_domains": ["www"]    // Uses DNSPod (global provider)
    },
    {
      "domain_name": "new-domain.com", 
      "sub_domains": ["www"],
      "provider": "Cloudflare"  // Uses Cloudflare
    }
  ]
}

Complete migration: Remove global provider once all domains specify providers

Configuration Examples

See the example configuration files:

configs/config_multi_sample.json - Full multi-provider setup
configs/config_multi_sample.yaml - YAML version of multi-provider setup
configs/config_legacy_compatible.json - Shows backward compatibility
configs/config_mixed_sample.json - Mixed legacy + new provider configuration

Logging and Notifications

Multi-provider configurations include provider information in log messages and notifications:

INFO [2024-01-01T12:00:00Z] Initialized provider: cloudflare
INFO [2024-01-01T12:00:00Z] Initialized provider: dnspod  
INFO [2024-01-01T12:00:00Z] [ www, api ] of example.com (via cloudflare)

Benefits

Consolidation: Manage multiple DNS providers from one GoDNS instance
Flexibility: Use the best provider for each domain
Redundancy: Distribute domains across providers for resilience
Migration: Gradually move domains between providers
Cost Optimization: Use different providers based on pricing/features
Compliance: Meet requirements for geographic distribution

Troubleshooting

Provider Not Found Error

ERROR provider 'cloudflare' not found for domain example.com

Solution:

Ensure the provider is configured in the providers section
Check that you’re using the correct case-sensitive provider name (e.g., "Cloudflare" not "cloudflare")

Authentication Failures

ERROR failed to create provider Cloudflare: authentication failed

Solution: Verify credentials in the provider configuration section and ensure you’re using the correct authentication method for the provider.

Mixed Configuration Issues

If a domain doesn’t specify a provider field, it will use the global provider. Ensure:

Global provider is set when using mixed configuration
All required credentials are provided for the global provider