1package cmd 2 3// CODE GENERATED AUTOMATICALLY 4// THIS FILE MUST NOT BE EDITED BY HAND 5 6import ( 7 "fmt" 8 "os" 9 "sort" 10 "strings" 11 "text/tabwriter" 12) 13 14func allDNSCodes() string { 15 providers := []string{ 16 "manual", 17 "acme-dns", 18 "alidns", 19 "allinkl", 20 "arvancloud", 21 "auroradns", 22 "autodns", 23 "azure", 24 "bindman", 25 "bluecat", 26 "checkdomain", 27 "clouddns", 28 "cloudflare", 29 "cloudns", 30 "cloudxns", 31 "conoha", 32 "constellix", 33 "desec", 34 "designate", 35 "digitalocean", 36 "dnsimple", 37 "dnsmadeeasy", 38 "dnspod", 39 "dode", 40 "domeneshop", 41 "dreamhost", 42 "duckdns", 43 "dyn", 44 "dynu", 45 "easydns", 46 "edgedns", 47 "epik", 48 "exec", 49 "exoscale", 50 "freemyip", 51 "gandi", 52 "gandiv5", 53 "gcloud", 54 "gcore", 55 "glesys", 56 "godaddy", 57 "hetzner", 58 "hostingde", 59 "hosttech", 60 "httpreq", 61 "hurricane", 62 "hyperone", 63 "ibmcloud", 64 "iij", 65 "infoblox", 66 "infomaniak", 67 "internetbs", 68 "inwx", 69 "ionos", 70 "joker", 71 "lightsail", 72 "linode", 73 "liquidweb", 74 "loopia", 75 "luadns", 76 "mydnsjp", 77 "mythicbeasts", 78 "namecheap", 79 "namedotcom", 80 "namesilo", 81 "netcup", 82 "netlify", 83 "nicmanager", 84 "nifcloud", 85 "njalla", 86 "ns1", 87 "oraclecloud", 88 "otc", 89 "ovh", 90 "pdns", 91 "porkbun", 92 "rackspace", 93 "regru", 94 "rfc2136", 95 "rimuhosting", 96 "route53", 97 "sakuracloud", 98 "scaleway", 99 "selectel", 100 "servercow", 101 "simply", 102 "sonic", 103 "stackpath", 104 "transip", 105 "vegadns", 106 "versio", 107 "vinyldns", 108 "vscale", 109 "vultr", 110 "wedos", 111 "yandex", 112 "zoneee", 113 "zonomi", 114 } 115 sort.Strings(providers) 116 return strings.Join(providers, ", ") 117} 118 119func displayDNSHelp(name string) error { 120 w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0) 121 ew := &errWriter{w: w} 122 123 switch name { 124 case "acme-dns": 125 // generated from: providers/dns/acmedns/acmedns.toml 126 ew.writeln(`Configuration for Joohoi's ACME-DNS.`) 127 ew.writeln(`Code: 'acme-dns'`) 128 ew.writeln(`Since: 'v1.1.0'`) 129 ew.writeln() 130 131 ew.writeln(`Credentials:`) 132 ew.writeln(` - "ACME_DNS_API_BASE": The ACME-DNS API address`) 133 ew.writeln(` - "ACME_DNS_STORAGE_PATH": The ACME-DNS JSON account data file. A per-domain account will be registered/persisted to this file and used for TXT updates.`) 134 ew.writeln() 135 136 ew.writeln() 137 ew.writeln(`More information: https://go-acme.github.io/lego/dns/acme-dns`) 138 139 case "alidns": 140 // generated from: providers/dns/alidns/alidns.toml 141 ew.writeln(`Configuration for Alibaba Cloud DNS.`) 142 ew.writeln(`Code: 'alidns'`) 143 ew.writeln(`Since: 'v1.1.0'`) 144 ew.writeln() 145 146 ew.writeln(`Credentials:`) 147 ew.writeln(` - "ALICLOUD_ACCESS_KEY": Access key ID`) 148 ew.writeln(` - "ALICLOUD_RAM_ROLE": Your instance RAM role (https://www.alibabacloud.com/help/doc-detail/54579.htm)`) 149 ew.writeln(` - "ALICLOUD_SECRET_KEY": Access Key secret`) 150 ew.writeln(` - "ALICLOUD_SECURITY_TOKEN": STS Security Token (optional)`) 151 ew.writeln() 152 153 ew.writeln(`Additional Configuration:`) 154 ew.writeln(` - "ALICLOUD_HTTP_TIMEOUT": API request timeout`) 155 ew.writeln(` - "ALICLOUD_POLLING_INTERVAL": Time between DNS propagation check`) 156 ew.writeln(` - "ALICLOUD_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 157 ew.writeln(` - "ALICLOUD_TTL": The TTL of the TXT record used for the DNS challenge`) 158 159 ew.writeln() 160 ew.writeln(`More information: https://go-acme.github.io/lego/dns/alidns`) 161 162 case "allinkl": 163 // generated from: providers/dns/allinkl/allinkl.toml 164 ew.writeln(`Configuration for all-inkl.`) 165 ew.writeln(`Code: 'allinkl'`) 166 ew.writeln(`Since: 'v4.5.0'`) 167 ew.writeln() 168 169 ew.writeln(`Credentials:`) 170 ew.writeln(` - "ALL_INKL_API_KEY": API login`) 171 ew.writeln(` - "ALL_INKL_PASSWORD": API password`) 172 ew.writeln() 173 174 ew.writeln(`Additional Configuration:`) 175 ew.writeln(` - "ALL_INKL_HTTP_TIMEOUT": API request timeout`) 176 ew.writeln(` - "ALL_INKL_POLLING_INTERVAL": Time between DNS propagation check`) 177 ew.writeln(` - "ALL_INKL_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 178 179 ew.writeln() 180 ew.writeln(`More information: https://go-acme.github.io/lego/dns/allinkl`) 181 182 case "arvancloud": 183 // generated from: providers/dns/arvancloud/arvancloud.toml 184 ew.writeln(`Configuration for ArvanCloud.`) 185 ew.writeln(`Code: 'arvancloud'`) 186 ew.writeln(`Since: 'v3.8.0'`) 187 ew.writeln() 188 189 ew.writeln(`Credentials:`) 190 ew.writeln(` - "ARVANCLOUD_API_KEY": API key`) 191 ew.writeln() 192 193 ew.writeln(`Additional Configuration:`) 194 ew.writeln(` - "ARVANCLOUD_HTTP_TIMEOUT": API request timeout`) 195 ew.writeln(` - "ARVANCLOUD_POLLING_INTERVAL": Time between DNS propagation check`) 196 ew.writeln(` - "ARVANCLOUD_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 197 ew.writeln(` - "ARVANCLOUD_TTL": The TTL of the TXT record used for the DNS challenge`) 198 199 ew.writeln() 200 ew.writeln(`More information: https://go-acme.github.io/lego/dns/arvancloud`) 201 202 case "auroradns": 203 // generated from: providers/dns/auroradns/auroradns.toml 204 ew.writeln(`Configuration for Aurora DNS.`) 205 ew.writeln(`Code: 'auroradns'`) 206 ew.writeln(`Since: 'v0.4.0'`) 207 ew.writeln() 208 209 ew.writeln(`Credentials:`) 210 ew.writeln(` - "AURORA_KEY": User API key`) 211 ew.writeln(` - "AURORA_USER_ID": User ID`) 212 ew.writeln() 213 214 ew.writeln(`Additional Configuration:`) 215 ew.writeln(` - "AURORA_ENDPOINT": API endpoint URL`) 216 ew.writeln(` - "AURORA_POLLING_INTERVAL": Time between DNS propagation check`) 217 ew.writeln(` - "AURORA_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 218 ew.writeln(` - "AURORA_TTL": The TTL of the TXT record used for the DNS challenge`) 219 220 ew.writeln() 221 ew.writeln(`More information: https://go-acme.github.io/lego/dns/auroradns`) 222 223 case "autodns": 224 // generated from: providers/dns/autodns/autodns.toml 225 ew.writeln(`Configuration for Autodns.`) 226 ew.writeln(`Code: 'autodns'`) 227 ew.writeln(`Since: 'v3.2.0'`) 228 ew.writeln() 229 230 ew.writeln(`Credentials:`) 231 ew.writeln(` - "AUTODNS_API_PASSWORD": User Password`) 232 ew.writeln(` - "AUTODNS_API_USER": Username`) 233 ew.writeln() 234 235 ew.writeln(`Additional Configuration:`) 236 ew.writeln(` - "AUTODNS_CONTEXT": API context (4 for production, 1 for testing. Defaults to 4)`) 237 ew.writeln(` - "AUTODNS_ENDPOINT": API endpoint URL, defaults to https://api.autodns.com/v1/`) 238 ew.writeln(` - "AUTODNS_HTTP_TIMEOUT": API request timeout, defaults to 30 seconds`) 239 ew.writeln(` - "AUTODNS_POLLING_INTERVAL": Time between DNS propagation check`) 240 ew.writeln(` - "AUTODNS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 241 ew.writeln(` - "AUTODNS_TTL": The TTL of the TXT record used for the DNS challenge`) 242 243 ew.writeln() 244 ew.writeln(`More information: https://go-acme.github.io/lego/dns/autodns`) 245 246 case "azure": 247 // generated from: providers/dns/azure/azure.toml 248 ew.writeln(`Configuration for Azure.`) 249 ew.writeln(`Code: 'azure'`) 250 ew.writeln(`Since: 'v0.4.0'`) 251 ew.writeln() 252 253 ew.writeln(`Credentials:`) 254 ew.writeln(` - "AZURE_CLIENT_ID": Client ID`) 255 ew.writeln(` - "AZURE_CLIENT_SECRET": Client secret`) 256 ew.writeln(` - "AZURE_ENVIRONMENT": Azure environment, one of: public, usgovernment, german, and china`) 257 ew.writeln(` - "AZURE_RESOURCE_GROUP": Resource group`) 258 ew.writeln(` - "AZURE_SUBSCRIPTION_ID": Subscription ID`) 259 ew.writeln(` - "AZURE_TENANT_ID": Tenant ID`) 260 ew.writeln(` - "instance metadata service": If the credentials are **not** set via the environment, then it will attempt to get a bearer token via the [instance metadata service](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/instance-metadata-service).`) 261 ew.writeln() 262 263 ew.writeln(`Additional Configuration:`) 264 ew.writeln(` - "AZURE_METADATA_ENDPOINT": Metadata Service endpoint URL`) 265 ew.writeln(` - "AZURE_POLLING_INTERVAL": Time between DNS propagation check`) 266 ew.writeln(` - "AZURE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 267 ew.writeln(` - "AZURE_TTL": The TTL of the TXT record used for the DNS challenge`) 268 ew.writeln(` - "AZURE_ZONE_NAME": Zone name to use inside Azure DNS service to add the TXT record in`) 269 270 ew.writeln() 271 ew.writeln(`More information: https://go-acme.github.io/lego/dns/azure`) 272 273 case "bindman": 274 // generated from: providers/dns/bindman/bindman.toml 275 ew.writeln(`Configuration for Bindman.`) 276 ew.writeln(`Code: 'bindman'`) 277 ew.writeln(`Since: 'v2.6.0'`) 278 ew.writeln() 279 280 ew.writeln(`Credentials:`) 281 ew.writeln(` - "BINDMAN_MANAGER_ADDRESS": The server URL, should have scheme, hostname, and port (if required) of the Bindman-DNS Manager server`) 282 ew.writeln() 283 284 ew.writeln(`Additional Configuration:`) 285 ew.writeln(` - "BINDMAN_HTTP_TIMEOUT": API request timeout`) 286 ew.writeln(` - "BINDMAN_POLLING_INTERVAL": Time between DNS propagation check`) 287 ew.writeln(` - "BINDMAN_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 288 289 ew.writeln() 290 ew.writeln(`More information: https://go-acme.github.io/lego/dns/bindman`) 291 292 case "bluecat": 293 // generated from: providers/dns/bluecat/bluecat.toml 294 ew.writeln(`Configuration for Bluecat.`) 295 ew.writeln(`Code: 'bluecat'`) 296 ew.writeln(`Since: 'v0.5.0'`) 297 ew.writeln() 298 299 ew.writeln(`Credentials:`) 300 ew.writeln(` - "BLUECAT_CONFIG_NAME": Configuration name`) 301 ew.writeln(` - "BLUECAT_DNS_VIEW": External DNS View Name`) 302 ew.writeln(` - "BLUECAT_PASSWORD": API password`) 303 ew.writeln(` - "BLUECAT_SERVER_URL": The server URL, should have scheme, hostname, and port (if required) of the authoritative Bluecat BAM serve`) 304 ew.writeln(` - "BLUECAT_USER_NAME": API username`) 305 ew.writeln() 306 307 ew.writeln(`Additional Configuration:`) 308 ew.writeln(` - "BLUECAT_HTTP_TIMEOUT": API request timeout`) 309 ew.writeln(` - "BLUECAT_POLLING_INTERVAL": Time between DNS propagation check`) 310 ew.writeln(` - "BLUECAT_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 311 ew.writeln(` - "BLUECAT_TTL": The TTL of the TXT record used for the DNS challenge`) 312 313 ew.writeln() 314 ew.writeln(`More information: https://go-acme.github.io/lego/dns/bluecat`) 315 316 case "checkdomain": 317 // generated from: providers/dns/checkdomain/checkdomain.toml 318 ew.writeln(`Configuration for Checkdomain.`) 319 ew.writeln(`Code: 'checkdomain'`) 320 ew.writeln(`Since: 'v3.3.0'`) 321 ew.writeln() 322 323 ew.writeln(`Credentials:`) 324 ew.writeln(` - "CHECKDOMAIN_TOKEN": API token`) 325 ew.writeln() 326 327 ew.writeln(`Additional Configuration:`) 328 ew.writeln(` - "CHECKDOMAIN_ENDPOINT": API endpoint URL, defaults to https://api.checkdomain.de`) 329 ew.writeln(` - "CHECKDOMAIN_HTTP_TIMEOUT": API request timeout, defaults to 30 seconds`) 330 ew.writeln(` - "CHECKDOMAIN_POLLING_INTERVAL": Time between DNS propagation check`) 331 ew.writeln(` - "CHECKDOMAIN_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 332 ew.writeln(` - "CHECKDOMAIN_TTL": The TTL of the TXT record used for the DNS challenge`) 333 334 ew.writeln() 335 ew.writeln(`More information: https://go-acme.github.io/lego/dns/checkdomain`) 336 337 case "clouddns": 338 // generated from: providers/dns/clouddns/clouddns.toml 339 ew.writeln(`Configuration for CloudDNS.`) 340 ew.writeln(`Code: 'clouddns'`) 341 ew.writeln(`Since: 'v3.6.0'`) 342 ew.writeln() 343 344 ew.writeln(`Credentials:`) 345 ew.writeln(` - "CLOUDDNS_CLIENT_ID": Client ID`) 346 ew.writeln(` - "CLOUDDNS_EMAIL": Account email`) 347 ew.writeln(` - "CLOUDDNS_PASSWORD": Account password`) 348 ew.writeln() 349 350 ew.writeln(`Additional Configuration:`) 351 ew.writeln(` - "CLOUDDNS_HTTP_TIMEOUT": API request timeout`) 352 ew.writeln(` - "CLOUDDNS_POLLING_INTERVAL": Time between DNS propagation check`) 353 ew.writeln(` - "CLOUDDNS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 354 ew.writeln(` - "CLOUDDNS_TTL": The TTL of the TXT record used for the DNS challenge`) 355 356 ew.writeln() 357 ew.writeln(`More information: https://go-acme.github.io/lego/dns/clouddns`) 358 359 case "cloudflare": 360 // generated from: providers/dns/cloudflare/cloudflare.toml 361 ew.writeln(`Configuration for Cloudflare.`) 362 ew.writeln(`Code: 'cloudflare'`) 363 ew.writeln(`Since: 'v0.3.0'`) 364 ew.writeln() 365 366 ew.writeln(`Credentials:`) 367 ew.writeln(` - "CF_API_EMAIL": Account email`) 368 ew.writeln(` - "CF_API_KEY": API key`) 369 ew.writeln(` - "CF_DNS_API_TOKEN": API token with DNS:Edit permission (since v3.1.0)`) 370 ew.writeln(` - "CF_ZONE_API_TOKEN": API token with Zone:Read permission (since v3.1.0)`) 371 ew.writeln(` - "CLOUDFLARE_API_KEY": Alias to CF_API_KEY`) 372 ew.writeln(` - "CLOUDFLARE_DNS_API_TOKEN": Alias to CF_DNS_API_TOKEN`) 373 ew.writeln(` - "CLOUDFLARE_EMAIL": Alias to CF_API_EMAIL`) 374 ew.writeln(` - "CLOUDFLARE_ZONE_API_TOKEN": Alias to CF_ZONE_API_TOKEN`) 375 ew.writeln() 376 377 ew.writeln(`Additional Configuration:`) 378 ew.writeln(` - "CLOUDFLARE_HTTP_TIMEOUT": API request timeout`) 379 ew.writeln(` - "CLOUDFLARE_POLLING_INTERVAL": Time between DNS propagation check`) 380 ew.writeln(` - "CLOUDFLARE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 381 ew.writeln(` - "CLOUDFLARE_TTL": The TTL of the TXT record used for the DNS challenge`) 382 383 ew.writeln() 384 ew.writeln(`More information: https://go-acme.github.io/lego/dns/cloudflare`) 385 386 case "cloudns": 387 // generated from: providers/dns/cloudns/cloudns.toml 388 ew.writeln(`Configuration for ClouDNS.`) 389 ew.writeln(`Code: 'cloudns'`) 390 ew.writeln(`Since: 'v2.3.0'`) 391 ew.writeln() 392 393 ew.writeln(`Credentials:`) 394 ew.writeln(` - "CLOUDNS_AUTH_ID": The API user ID`) 395 ew.writeln(` - "CLOUDNS_AUTH_PASSWORD": The password for API user ID`) 396 ew.writeln() 397 398 ew.writeln(`Additional Configuration:`) 399 ew.writeln(` - "CLOUDNS_HTTP_TIMEOUT": API request timeout`) 400 ew.writeln(` - "CLOUDNS_POLLING_INTERVAL": Time between DNS propagation check`) 401 ew.writeln(` - "CLOUDNS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 402 ew.writeln(` - "CLOUDNS_SUB_AUTH_ID": The API sub user ID`) 403 ew.writeln(` - "CLOUDNS_TTL": The TTL of the TXT record used for the DNS challenge`) 404 405 ew.writeln() 406 ew.writeln(`More information: https://go-acme.github.io/lego/dns/cloudns`) 407 408 case "cloudxns": 409 // generated from: providers/dns/cloudxns/cloudxns.toml 410 ew.writeln(`Configuration for CloudXNS.`) 411 ew.writeln(`Code: 'cloudxns'`) 412 ew.writeln(`Since: 'v0.5.0'`) 413 ew.writeln() 414 415 ew.writeln(`Credentials:`) 416 ew.writeln(` - "CLOUDXNS_API_KEY": The API key`) 417 ew.writeln(` - "CLOUDXNS_SECRET_KEY": The API secret key`) 418 ew.writeln() 419 420 ew.writeln(`Additional Configuration:`) 421 ew.writeln(` - "CLOUDXNS_HTTP_TIMEOUT": API request timeout`) 422 ew.writeln(` - "CLOUDXNS_POLLING_INTERVAL": Time between DNS propagation check`) 423 ew.writeln(` - "CLOUDXNS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 424 ew.writeln(` - "CLOUDXNS_TTL": The TTL of the TXT record used for the DNS challenge`) 425 426 ew.writeln() 427 ew.writeln(`More information: https://go-acme.github.io/lego/dns/cloudxns`) 428 429 case "conoha": 430 // generated from: providers/dns/conoha/conoha.toml 431 ew.writeln(`Configuration for ConoHa.`) 432 ew.writeln(`Code: 'conoha'`) 433 ew.writeln(`Since: 'v1.2.0'`) 434 ew.writeln() 435 436 ew.writeln(`Credentials:`) 437 ew.writeln(` - "CONOHA_API_PASSWORD": The API password`) 438 ew.writeln(` - "CONOHA_API_USERNAME": The API username`) 439 ew.writeln(` - "CONOHA_TENANT_ID": Tenant ID`) 440 ew.writeln() 441 442 ew.writeln(`Additional Configuration:`) 443 ew.writeln(` - "CONOHA_HTTP_TIMEOUT": API request timeout`) 444 ew.writeln(` - "CONOHA_POLLING_INTERVAL": Time between DNS propagation check`) 445 ew.writeln(` - "CONOHA_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 446 ew.writeln(` - "CONOHA_REGION": The region`) 447 ew.writeln(` - "CONOHA_TTL": The TTL of the TXT record used for the DNS challenge`) 448 449 ew.writeln() 450 ew.writeln(`More information: https://go-acme.github.io/lego/dns/conoha`) 451 452 case "constellix": 453 // generated from: providers/dns/constellix/constellix.toml 454 ew.writeln(`Configuration for Constellix.`) 455 ew.writeln(`Code: 'constellix'`) 456 ew.writeln(`Since: 'v3.4.0'`) 457 ew.writeln() 458 459 ew.writeln(`Credentials:`) 460 ew.writeln(` - "CONSTELLIX_API_KEY": User API key`) 461 ew.writeln(` - "CONSTELLIX_SECRET_KEY": User secret key`) 462 ew.writeln() 463 464 ew.writeln(`Additional Configuration:`) 465 ew.writeln(` - "CONSTELLIX_HTTP_TIMEOUT": API request timeout`) 466 ew.writeln(` - "CONSTELLIX_POLLING_INTERVAL": Time between DNS propagation check`) 467 ew.writeln(` - "CONSTELLIX_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 468 ew.writeln(` - "CONSTELLIX_TTL": The TTL of the TXT record used for the DNS challenge`) 469 470 ew.writeln() 471 ew.writeln(`More information: https://go-acme.github.io/lego/dns/constellix`) 472 473 case "desec": 474 // generated from: providers/dns/desec/desec.toml 475 ew.writeln(`Configuration for deSEC.io.`) 476 ew.writeln(`Code: 'desec'`) 477 ew.writeln(`Since: 'v3.7.0'`) 478 ew.writeln() 479 480 ew.writeln(`Credentials:`) 481 ew.writeln(` - "DESEC_TOKEN": Domain token`) 482 ew.writeln() 483 484 ew.writeln(`Additional Configuration:`) 485 ew.writeln(` - "DESEC_HTTP_TIMEOUT": API request timeout`) 486 ew.writeln(` - "DESEC_POLLING_INTERVAL": Time between DNS propagation check`) 487 ew.writeln(` - "DESEC_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 488 ew.writeln(` - "DESEC_TTL": The TTL of the TXT record used for the DNS challenge`) 489 490 ew.writeln() 491 ew.writeln(`More information: https://go-acme.github.io/lego/dns/desec`) 492 493 case "designate": 494 // generated from: providers/dns/designate/designate.toml 495 ew.writeln(`Configuration for Designate DNSaaS for Openstack.`) 496 ew.writeln(`Code: 'designate'`) 497 ew.writeln(`Since: 'v2.2.0'`) 498 ew.writeln() 499 500 ew.writeln(`Credentials:`) 501 ew.writeln(` - "OS_APPLICATION_CREDENTIAL_ID": Application credential ID`) 502 ew.writeln(` - "OS_APPLICATION_CREDENTIAL_NAME": Application credential name`) 503 ew.writeln(` - "OS_APPLICATION_CREDENTIAL_SECRET": Application credential secret`) 504 ew.writeln(` - "OS_AUTH_URL": Identity endpoint URL`) 505 ew.writeln(` - "OS_PASSWORD": Password`) 506 ew.writeln(` - "OS_PROJECT_NAME": Project name`) 507 ew.writeln(` - "OS_REGION_NAME": Region name`) 508 ew.writeln(` - "OS_USERNAME": Username`) 509 ew.writeln(` - "OS_USER_ID": User ID`) 510 ew.writeln() 511 512 ew.writeln(`Additional Configuration:`) 513 ew.writeln(` - "DESIGNATE_POLLING_INTERVAL": Time between DNS propagation check`) 514 ew.writeln(` - "DESIGNATE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 515 ew.writeln(` - "DESIGNATE_TTL": The TTL of the TXT record used for the DNS challenge`) 516 ew.writeln(` - "OS_PROJECT_ID": Project ID`) 517 ew.writeln(` - "OS_TENANT_NAME": Tenant name (deprecated see OS_PROJECT_NAME and OS_PROJECT_ID)`) 518 519 ew.writeln() 520 ew.writeln(`More information: https://go-acme.github.io/lego/dns/designate`) 521 522 case "digitalocean": 523 // generated from: providers/dns/digitalocean/digitalocean.toml 524 ew.writeln(`Configuration for Digital Ocean.`) 525 ew.writeln(`Code: 'digitalocean'`) 526 ew.writeln(`Since: 'v0.3.0'`) 527 ew.writeln() 528 529 ew.writeln(`Credentials:`) 530 ew.writeln(` - "DO_AUTH_TOKEN": Authentication token`) 531 ew.writeln() 532 533 ew.writeln(`Additional Configuration:`) 534 ew.writeln(` - "DO_HTTP_TIMEOUT": API request timeout`) 535 ew.writeln(` - "DO_POLLING_INTERVAL": Time between DNS propagation check`) 536 ew.writeln(` - "DO_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 537 ew.writeln(` - "DO_TTL": The TTL of the TXT record used for the DNS challenge`) 538 539 ew.writeln() 540 ew.writeln(`More information: https://go-acme.github.io/lego/dns/digitalocean`) 541 542 case "dnsimple": 543 // generated from: providers/dns/dnsimple/dnsimple.toml 544 ew.writeln(`Configuration for DNSimple.`) 545 ew.writeln(`Code: 'dnsimple'`) 546 ew.writeln(`Since: 'v0.3.0'`) 547 ew.writeln() 548 549 ew.writeln(`Credentials:`) 550 ew.writeln(` - "DNSIMPLE_OAUTH_TOKEN": OAuth token`) 551 ew.writeln() 552 553 ew.writeln(`Additional Configuration:`) 554 ew.writeln(` - "DNSIMPLE_BASE_URL": API endpoint URL`) 555 ew.writeln(` - "DNSIMPLE_POLLING_INTERVAL": Time between DNS propagation check`) 556 ew.writeln(` - "DNSIMPLE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 557 ew.writeln(` - "DNSIMPLE_TTL": The TTL of the TXT record used for the DNS challenge`) 558 559 ew.writeln() 560 ew.writeln(`More information: https://go-acme.github.io/lego/dns/dnsimple`) 561 562 case "dnsmadeeasy": 563 // generated from: providers/dns/dnsmadeeasy/dnsmadeeasy.toml 564 ew.writeln(`Configuration for DNS Made Easy.`) 565 ew.writeln(`Code: 'dnsmadeeasy'`) 566 ew.writeln(`Since: 'v0.4.0'`) 567 ew.writeln() 568 569 ew.writeln(`Credentials:`) 570 ew.writeln(` - "DNSMADEEASY_API_KEY": The API key`) 571 ew.writeln(` - "DNSMADEEASY_API_SECRET": The API Secret key`) 572 ew.writeln() 573 574 ew.writeln(`Additional Configuration:`) 575 ew.writeln(` - "DNSMADEEASY_HTTP_TIMEOUT": API request timeout`) 576 ew.writeln(` - "DNSMADEEASY_POLLING_INTERVAL": Time between DNS propagation check`) 577 ew.writeln(` - "DNSMADEEASY_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 578 ew.writeln(` - "DNSMADEEASY_SANDBOX": Activate the sandbox (boolean)`) 579 ew.writeln(` - "DNSMADEEASY_TTL": The TTL of the TXT record used for the DNS challenge`) 580 581 ew.writeln() 582 ew.writeln(`More information: https://go-acme.github.io/lego/dns/dnsmadeeasy`) 583 584 case "dnspod": 585 // generated from: providers/dns/dnspod/dnspod.toml 586 ew.writeln(`Configuration for DNSPod.`) 587 ew.writeln(`Code: 'dnspod'`) 588 ew.writeln(`Since: 'v0.4.0'`) 589 ew.writeln() 590 591 ew.writeln(`Credentials:`) 592 ew.writeln(` - "DNSPOD_API_KEY": The user token`) 593 ew.writeln() 594 595 ew.writeln(`Additional Configuration:`) 596 ew.writeln(` - "DNSPOD_HTTP_TIMEOUT": API request timeout`) 597 ew.writeln(` - "DNSPOD_POLLING_INTERVAL": Time between DNS propagation check`) 598 ew.writeln(` - "DNSPOD_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 599 ew.writeln(` - "DNSPOD_TTL": The TTL of the TXT record used for the DNS challenge`) 600 601 ew.writeln() 602 ew.writeln(`More information: https://go-acme.github.io/lego/dns/dnspod`) 603 604 case "dode": 605 // generated from: providers/dns/dode/dode.toml 606 ew.writeln(`Configuration for Domain Offensive (do.de).`) 607 ew.writeln(`Code: 'dode'`) 608 ew.writeln(`Since: 'v2.4.0'`) 609 ew.writeln() 610 611 ew.writeln(`Credentials:`) 612 ew.writeln(` - "DODE_TOKEN": API token`) 613 ew.writeln() 614 615 ew.writeln(`Additional Configuration:`) 616 ew.writeln(` - "DODE_HTTP_TIMEOUT": API request timeout`) 617 ew.writeln(` - "DODE_POLLING_INTERVAL": Time between DNS propagation check`) 618 ew.writeln(` - "DODE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 619 ew.writeln(` - "DODE_SEQUENCE_INTERVAL": Time between sequential requests`) 620 ew.writeln(` - "DODE_TTL": The TTL of the TXT record used for the DNS challenge`) 621 622 ew.writeln() 623 ew.writeln(`More information: https://go-acme.github.io/lego/dns/dode`) 624 625 case "domeneshop": 626 // generated from: providers/dns/domeneshop/domeneshop.toml 627 ew.writeln(`Configuration for Domeneshop.`) 628 ew.writeln(`Code: 'domeneshop'`) 629 ew.writeln(`Since: 'v4.3.0'`) 630 ew.writeln() 631 632 ew.writeln(`Credentials:`) 633 ew.writeln(` - "DOMENESHOP_API_SECRET": API secret`) 634 ew.writeln(` - "DOMENESHOP_API_TOKEN": API token`) 635 ew.writeln() 636 637 ew.writeln(`Additional Configuration:`) 638 ew.writeln(` - "DOMENESHOP_HTTP_TIMEOUT": API request timeout`) 639 ew.writeln(` - "DOMENESHOP_POLLING_INTERVAL": Time between DNS propagation check`) 640 ew.writeln(` - "DOMENESHOP_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 641 642 ew.writeln() 643 ew.writeln(`More information: https://go-acme.github.io/lego/dns/domeneshop`) 644 645 case "dreamhost": 646 // generated from: providers/dns/dreamhost/dreamhost.toml 647 ew.writeln(`Configuration for DreamHost.`) 648 ew.writeln(`Code: 'dreamhost'`) 649 ew.writeln(`Since: 'v1.1.0'`) 650 ew.writeln() 651 652 ew.writeln(`Credentials:`) 653 ew.writeln(` - "DREAMHOST_API_KEY": The API key`) 654 ew.writeln() 655 656 ew.writeln(`Additional Configuration:`) 657 ew.writeln(` - "DREAMHOST_HTTP_TIMEOUT": API request timeout`) 658 ew.writeln(` - "DREAMHOST_POLLING_INTERVAL": Time between DNS propagation check`) 659 ew.writeln(` - "DREAMHOST_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 660 ew.writeln(` - "DREAMHOST_TTL": The TTL of the TXT record used for the DNS challenge`) 661 662 ew.writeln() 663 ew.writeln(`More information: https://go-acme.github.io/lego/dns/dreamhost`) 664 665 case "duckdns": 666 // generated from: providers/dns/duckdns/duckdns.toml 667 ew.writeln(`Configuration for Duck DNS.`) 668 ew.writeln(`Code: 'duckdns'`) 669 ew.writeln(`Since: 'v0.5.0'`) 670 ew.writeln() 671 672 ew.writeln(`Credentials:`) 673 ew.writeln(` - "DUCKDNS_TOKEN": Account token`) 674 ew.writeln() 675 676 ew.writeln(`Additional Configuration:`) 677 ew.writeln(` - "DUCKDNS_HTTP_TIMEOUT": API request timeout`) 678 ew.writeln(` - "DUCKDNS_POLLING_INTERVAL": Time between DNS propagation check`) 679 ew.writeln(` - "DUCKDNS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 680 ew.writeln(` - "DUCKDNS_SEQUENCE_INTERVAL": Time between sequential requests`) 681 ew.writeln(` - "DUCKDNS_TTL": The TTL of the TXT record used for the DNS challenge`) 682 683 ew.writeln() 684 ew.writeln(`More information: https://go-acme.github.io/lego/dns/duckdns`) 685 686 case "dyn": 687 // generated from: providers/dns/dyn/dyn.toml 688 ew.writeln(`Configuration for Dyn.`) 689 ew.writeln(`Code: 'dyn'`) 690 ew.writeln(`Since: 'v0.3.0'`) 691 ew.writeln() 692 693 ew.writeln(`Credentials:`) 694 ew.writeln(` - "DYN_CUSTOMER_NAME": Customer name`) 695 ew.writeln(` - "DYN_PASSWORD": Password`) 696 ew.writeln(` - "DYN_USER_NAME": User name`) 697 ew.writeln() 698 699 ew.writeln(`Additional Configuration:`) 700 ew.writeln(` - "DYN_HTTP_TIMEOUT": API request timeout`) 701 ew.writeln(` - "DYN_POLLING_INTERVAL": Time between DNS propagation check`) 702 ew.writeln(` - "DYN_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 703 ew.writeln(` - "DYN_TTL": The TTL of the TXT record used for the DNS challenge`) 704 705 ew.writeln() 706 ew.writeln(`More information: https://go-acme.github.io/lego/dns/dyn`) 707 708 case "dynu": 709 // generated from: providers/dns/dynu/dynu.toml 710 ew.writeln(`Configuration for Dynu.`) 711 ew.writeln(`Code: 'dynu'`) 712 ew.writeln(`Since: 'v3.5.0'`) 713 ew.writeln() 714 715 ew.writeln(`Credentials:`) 716 ew.writeln(` - "DYNU_API_KEY": API key`) 717 ew.writeln() 718 719 ew.writeln(`Additional Configuration:`) 720 ew.writeln(` - "DYNU_HTTP_TIMEOUT": API request timeout`) 721 ew.writeln(` - "DYNU_POLLING_INTERVAL": Time between DNS propagation check`) 722 ew.writeln(` - "DYNU_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 723 ew.writeln(` - "DYNU_TTL": The TTL of the TXT record used for the DNS challenge`) 724 725 ew.writeln() 726 ew.writeln(`More information: https://go-acme.github.io/lego/dns/dynu`) 727 728 case "easydns": 729 // generated from: providers/dns/easydns/easydns.toml 730 ew.writeln(`Configuration for EasyDNS.`) 731 ew.writeln(`Code: 'easydns'`) 732 ew.writeln(`Since: 'v2.6.0'`) 733 ew.writeln() 734 735 ew.writeln(`Credentials:`) 736 ew.writeln(` - "EASYDNS_KEY": API Key`) 737 ew.writeln(` - "EASYDNS_TOKEN": API Token`) 738 ew.writeln() 739 740 ew.writeln(`Additional Configuration:`) 741 ew.writeln(` - "EASYDNS_ENDPOINT": The endpoint URL of the API Server`) 742 ew.writeln(` - "EASYDNS_HTTP_TIMEOUT": API request timeout`) 743 ew.writeln(` - "EASYDNS_POLLING_INTERVAL": Time between DNS propagation check`) 744 ew.writeln(` - "EASYDNS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 745 ew.writeln(` - "EASYDNS_SEQUENCE_INTERVAL": Time between sequential requests`) 746 ew.writeln(` - "EASYDNS_TTL": The TTL of the TXT record used for the DNS challenge`) 747 748 ew.writeln() 749 ew.writeln(`More information: https://go-acme.github.io/lego/dns/easydns`) 750 751 case "edgedns": 752 // generated from: providers/dns/edgedns/edgedns.toml 753 ew.writeln(`Configuration for Akamai EdgeDNS.`) 754 ew.writeln(`Code: 'edgedns'`) 755 ew.writeln(`Since: 'v3.9.0'`) 756 ew.writeln() 757 758 ew.writeln(`Credentials:`) 759 ew.writeln(` - "AKAMAI_ACCESS_TOKEN": Access token, managed by the Akamai EdgeGrid client`) 760 ew.writeln(` - "AKAMAI_CLIENT_SECRET": Client secret, managed by the Akamai EdgeGrid client`) 761 ew.writeln(` - "AKAMAI_CLIENT_TOKEN": Client token, managed by the Akamai EdgeGrid client`) 762 ew.writeln(` - "AKAMAI_EDGERC": Path to the .edgerc file, managed by the Akamai EdgeGrid client`) 763 ew.writeln(` - "AKAMAI_EDGERC_SECTION": Configuration section, managed by the Akamai EdgeGrid client`) 764 ew.writeln(` - "AKAMAI_HOST": API host, managed by the Akamai EdgeGrid client`) 765 ew.writeln() 766 767 ew.writeln(`Additional Configuration:`) 768 ew.writeln(` - "AKAMAI_POLLING_INTERVAL": Time between DNS propagation check. Default: 15 seconds`) 769 ew.writeln(` - "AKAMAI_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation. Default: 3 minutes`) 770 ew.writeln(` - "AKAMAI_TTL": The TTL of the TXT record used for the DNS challenge`) 771 772 ew.writeln() 773 ew.writeln(`More information: https://go-acme.github.io/lego/dns/edgedns`) 774 775 case "epik": 776 // generated from: providers/dns/epik/epik.toml 777 ew.writeln(`Configuration for Epik.`) 778 ew.writeln(`Code: 'epik'`) 779 ew.writeln(`Since: 'v4.5.0'`) 780 ew.writeln() 781 782 ew.writeln(`Credentials:`) 783 ew.writeln(` - "EPIK_SIGNATURE": Epik API signature (https://registrar.epik.com/account/api-settings/)`) 784 ew.writeln() 785 786 ew.writeln(`Additional Configuration:`) 787 ew.writeln(` - "EPIK_HTTP_TIMEOUT": API request timeout`) 788 ew.writeln(` - "EPIK_POLLING_INTERVAL": Time between DNS propagation check`) 789 ew.writeln(` - "EPIK_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 790 ew.writeln(` - "EPIK_TTL": The TTL of the TXT record used for the DNS challenge`) 791 792 ew.writeln() 793 ew.writeln(`More information: https://go-acme.github.io/lego/dns/epik`) 794 795 case "exec": 796 // generated from: providers/dns/exec/exec.toml 797 ew.writeln(`Configuration for External program.`) 798 ew.writeln(`Code: 'exec'`) 799 ew.writeln(`Since: 'v0.5.0'`) 800 ew.writeln() 801 802 ew.writeln() 803 ew.writeln(`More information: https://go-acme.github.io/lego/dns/exec`) 804 805 case "exoscale": 806 // generated from: providers/dns/exoscale/exoscale.toml 807 ew.writeln(`Configuration for Exoscale.`) 808 ew.writeln(`Code: 'exoscale'`) 809 ew.writeln(`Since: 'v0.4.0'`) 810 ew.writeln() 811 812 ew.writeln(`Credentials:`) 813 ew.writeln(` - "EXOSCALE_API_KEY": API key`) 814 ew.writeln(` - "EXOSCALE_API_SECRET": API secret`) 815 ew.writeln() 816 817 ew.writeln(`Additional Configuration:`) 818 ew.writeln(` - "EXOSCALE_ENDPOINT": API endpoint URL`) 819 ew.writeln(` - "EXOSCALE_HTTP_TIMEOUT": API request timeout`) 820 ew.writeln(` - "EXOSCALE_POLLING_INTERVAL": Time between DNS propagation check`) 821 ew.writeln(` - "EXOSCALE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 822 ew.writeln(` - "EXOSCALE_TTL": The TTL of the TXT record used for the DNS challenge`) 823 824 ew.writeln() 825 ew.writeln(`More information: https://go-acme.github.io/lego/dns/exoscale`) 826 827 case "freemyip": 828 // generated from: providers/dns/freemyip/freemyip.toml 829 ew.writeln(`Configuration for freemyip.com.`) 830 ew.writeln(`Code: 'freemyip'`) 831 ew.writeln(`Since: 'v4.5.0'`) 832 ew.writeln() 833 834 ew.writeln(`Credentials:`) 835 ew.writeln(` - "FREEMYIP_TOKEN": Account token`) 836 ew.writeln() 837 838 ew.writeln(`Additional Configuration:`) 839 ew.writeln(` - "FREEMYIP_HTTP_TIMEOUT": API request timeout`) 840 ew.writeln(` - "FREEMYIP_POLLING_INTERVAL": Time between DNS propagation check`) 841 ew.writeln(` - "FREEMYIP_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 842 ew.writeln(` - "FREEMYIP_SEQUENCE_INTERVAL": Time between sequential requests`) 843 ew.writeln(` - "FREEMYIP_TTL": The TTL of the TXT record used for the DNS challenge`) 844 845 ew.writeln() 846 ew.writeln(`More information: https://go-acme.github.io/lego/dns/freemyip`) 847 848 case "gandi": 849 // generated from: providers/dns/gandi/gandi.toml 850 ew.writeln(`Configuration for Gandi.`) 851 ew.writeln(`Code: 'gandi'`) 852 ew.writeln(`Since: 'v0.3.0'`) 853 ew.writeln() 854 855 ew.writeln(`Credentials:`) 856 ew.writeln(` - "GANDI_API_KEY": API key`) 857 ew.writeln() 858 859 ew.writeln(`Additional Configuration:`) 860 ew.writeln(` - "GANDI_HTTP_TIMEOUT": API request timeout`) 861 ew.writeln(` - "GANDI_POLLING_INTERVAL": Time between DNS propagation check`) 862 ew.writeln(` - "GANDI_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 863 ew.writeln(` - "GANDI_TTL": The TTL of the TXT record used for the DNS challenge`) 864 865 ew.writeln() 866 ew.writeln(`More information: https://go-acme.github.io/lego/dns/gandi`) 867 868 case "gandiv5": 869 // generated from: providers/dns/gandiv5/gandiv5.toml 870 ew.writeln(`Configuration for Gandi Live DNS (v5).`) 871 ew.writeln(`Code: 'gandiv5'`) 872 ew.writeln(`Since: 'v0.5.0'`) 873 ew.writeln() 874 875 ew.writeln(`Credentials:`) 876 ew.writeln(` - "GANDIV5_API_KEY": API key`) 877 ew.writeln() 878 879 ew.writeln(`Additional Configuration:`) 880 ew.writeln(` - "GANDIV5_HTTP_TIMEOUT": API request timeout`) 881 ew.writeln(` - "GANDIV5_POLLING_INTERVAL": Time between DNS propagation check`) 882 ew.writeln(` - "GANDIV5_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 883 ew.writeln(` - "GANDIV5_TTL": The TTL of the TXT record used for the DNS challenge`) 884 885 ew.writeln() 886 ew.writeln(`More information: https://go-acme.github.io/lego/dns/gandiv5`) 887 888 case "gcloud": 889 // generated from: providers/dns/gcloud/gcloud.toml 890 ew.writeln(`Configuration for Google Cloud.`) 891 ew.writeln(`Code: 'gcloud'`) 892 ew.writeln(`Since: 'v0.3.0'`) 893 ew.writeln() 894 895 ew.writeln(`Credentials:`) 896 ew.writeln(` - "Application Default Credentials": [Documentation](https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application)`) 897 ew.writeln(` - "GCE_PROJECT": Project name (by default, the project name is auto-detected by using the metadata service)`) 898 ew.writeln(` - "GCE_SERVICE_ACCOUNT": Account`) 899 ew.writeln(` - "GCE_SERVICE_ACCOUNT_FILE": Account file path`) 900 ew.writeln() 901 902 ew.writeln(`Additional Configuration:`) 903 ew.writeln(` - "GCE_ALLOW_PRIVATE_ZONE": Allows requested domain to be in private DNS zone, works only with a private ACME server (by default: false)`) 904 ew.writeln(` - "GCE_POLLING_INTERVAL": Time between DNS propagation check`) 905 ew.writeln(` - "GCE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 906 ew.writeln(` - "GCE_TTL": The TTL of the TXT record used for the DNS challenge`) 907 908 ew.writeln() 909 ew.writeln(`More information: https://go-acme.github.io/lego/dns/gcloud`) 910 911 case "gcore": 912 // generated from: providers/dns/gcore/gcore.toml 913 ew.writeln(`Configuration for G-Core Labs.`) 914 ew.writeln(`Code: 'gcore'`) 915 ew.writeln(`Since: 'v4.5.0'`) 916 ew.writeln() 917 918 ew.writeln(`Credentials:`) 919 ew.writeln(` - "GCORE_PERMANENT_API_TOKEN": Permanent API tokene (https://gcorelabs.com/blog/permanent-api-token-explained/)`) 920 ew.writeln() 921 922 ew.writeln(`Additional Configuration:`) 923 ew.writeln(` - "GCORE_HTTP_TIMEOUT": API request timeout`) 924 ew.writeln(` - "GCORE_POLLING_INTERVAL": Time between DNS propagation check`) 925 ew.writeln(` - "GCORE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 926 ew.writeln(` - "GCORE_TTL": The TTL of the TXT record used for the DNS challenge`) 927 928 ew.writeln() 929 ew.writeln(`More information: https://go-acme.github.io/lego/dns/gcore`) 930 931 case "glesys": 932 // generated from: providers/dns/glesys/glesys.toml 933 ew.writeln(`Configuration for Glesys.`) 934 ew.writeln(`Code: 'glesys'`) 935 ew.writeln(`Since: 'v0.5.0'`) 936 ew.writeln() 937 938 ew.writeln(`Credentials:`) 939 ew.writeln(` - "GLESYS_API_KEY": API key`) 940 ew.writeln(` - "GLESYS_API_USER": API user`) 941 ew.writeln() 942 943 ew.writeln(`Additional Configuration:`) 944 ew.writeln(` - "GLESYS_HTTP_TIMEOUT": API request timeout`) 945 ew.writeln(` - "GLESYS_POLLING_INTERVAL": Time between DNS propagation check`) 946 ew.writeln(` - "GLESYS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 947 ew.writeln(` - "GLESYS_TTL": The TTL of the TXT record used for the DNS challenge`) 948 949 ew.writeln() 950 ew.writeln(`More information: https://go-acme.github.io/lego/dns/glesys`) 951 952 case "godaddy": 953 // generated from: providers/dns/godaddy/godaddy.toml 954 ew.writeln(`Configuration for Go Daddy.`) 955 ew.writeln(`Code: 'godaddy'`) 956 ew.writeln(`Since: 'v0.5.0'`) 957 ew.writeln() 958 959 ew.writeln(`Credentials:`) 960 ew.writeln(` - "GODADDY_API_KEY": API key`) 961 ew.writeln(` - "GODADDY_API_SECRET": API secret`) 962 ew.writeln() 963 964 ew.writeln(`Additional Configuration:`) 965 ew.writeln(` - "GODADDY_HTTP_TIMEOUT": API request timeout`) 966 ew.writeln(` - "GODADDY_POLLING_INTERVAL": Time between DNS propagation check`) 967 ew.writeln(` - "GODADDY_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 968 ew.writeln(` - "GODADDY_TTL": The TTL of the TXT record used for the DNS challenge`) 969 970 ew.writeln() 971 ew.writeln(`More information: https://go-acme.github.io/lego/dns/godaddy`) 972 973 case "hetzner": 974 // generated from: providers/dns/hetzner/hetzner.toml 975 ew.writeln(`Configuration for Hetzner.`) 976 ew.writeln(`Code: 'hetzner'`) 977 ew.writeln(`Since: 'v3.7.0'`) 978 ew.writeln() 979 980 ew.writeln(`Credentials:`) 981 ew.writeln(` - "HETZNER_API_KEY": API key`) 982 ew.writeln() 983 984 ew.writeln(`Additional Configuration:`) 985 ew.writeln(` - "HETZNER_HTTP_TIMEOUT": API request timeout`) 986 ew.writeln(` - "HETZNER_POLLING_INTERVAL": Time between DNS propagation check`) 987 ew.writeln(` - "HETZNER_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 988 ew.writeln(` - "HETZNER_TTL": The TTL of the TXT record used for the DNS challenge`) 989 990 ew.writeln() 991 ew.writeln(`More information: https://go-acme.github.io/lego/dns/hetzner`) 992 993 case "hostingde": 994 // generated from: providers/dns/hostingde/hostingde.toml 995 ew.writeln(`Configuration for Hosting.de.`) 996 ew.writeln(`Code: 'hostingde'`) 997 ew.writeln(`Since: 'v1.1.0'`) 998 ew.writeln() 999 1000 ew.writeln(`Credentials:`) 1001 ew.writeln(` - "HOSTINGDE_API_KEY": API key`) 1002 ew.writeln() 1003 1004 ew.writeln(`Additional Configuration:`) 1005 ew.writeln(` - "HOSTINGDE_HTTP_TIMEOUT": API request timeout`) 1006 ew.writeln(` - "HOSTINGDE_POLLING_INTERVAL": Time between DNS propagation check`) 1007 ew.writeln(` - "HOSTINGDE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1008 ew.writeln(` - "HOSTINGDE_TTL": The TTL of the TXT record used for the DNS challenge`) 1009 ew.writeln(` - "HOSTINGDE_ZONE_NAME": Zone name in ACE format`) 1010 1011 ew.writeln() 1012 ew.writeln(`More information: https://go-acme.github.io/lego/dns/hostingde`) 1013 1014 case "hosttech": 1015 // generated from: providers/dns/hosttech/hosttech.toml 1016 ew.writeln(`Configuration for Hosttech.`) 1017 ew.writeln(`Code: 'hosttech'`) 1018 ew.writeln(`Since: 'v4.5.0'`) 1019 ew.writeln() 1020 1021 ew.writeln(`Credentials:`) 1022 ew.writeln(` - "HOSTTECH_API_KEY": API login`) 1023 ew.writeln(` - "HOSTTECH_PASSWORD": API password`) 1024 ew.writeln() 1025 1026 ew.writeln(`Additional Configuration:`) 1027 ew.writeln(` - "HOSTTECH_HTTP_TIMEOUT": API request timeout`) 1028 ew.writeln(` - "HOSTTECH_POLLING_INTERVAL": Time between DNS propagation check`) 1029 ew.writeln(` - "HOSTTECH_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1030 ew.writeln(` - "HOSTTECH_TTL": The TTL of the TXT record used for the DNS challenge`) 1031 1032 ew.writeln() 1033 ew.writeln(`More information: https://go-acme.github.io/lego/dns/hosttech`) 1034 1035 case "httpreq": 1036 // generated from: providers/dns/httpreq/httpreq.toml 1037 ew.writeln(`Configuration for HTTP request.`) 1038 ew.writeln(`Code: 'httpreq'`) 1039 ew.writeln(`Since: 'v2.0.0'`) 1040 ew.writeln() 1041 1042 ew.writeln(`Credentials:`) 1043 ew.writeln(` - "HTTPREQ_ENDPOINT": The URL of the server`) 1044 ew.writeln(` - "HTTPREQ_MODE": 'RAW', none`) 1045 ew.writeln() 1046 1047 ew.writeln(`Additional Configuration:`) 1048 ew.writeln(` - "HTTPREQ_HTTP_TIMEOUT": API request timeout`) 1049 ew.writeln(` - "HTTPREQ_PASSWORD": Basic authentication password`) 1050 ew.writeln(` - "HTTPREQ_POLLING_INTERVAL": Time between DNS propagation check`) 1051 ew.writeln(` - "HTTPREQ_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1052 ew.writeln(` - "HTTPREQ_USERNAME": Basic authentication username`) 1053 1054 ew.writeln() 1055 ew.writeln(`More information: https://go-acme.github.io/lego/dns/httpreq`) 1056 1057 case "hurricane": 1058 // generated from: providers/dns/hurricane/hurricane.toml 1059 ew.writeln(`Configuration for Hurricane Electric DNS.`) 1060 ew.writeln(`Code: 'hurricane'`) 1061 ew.writeln(`Since: 'v4.3.0'`) 1062 ew.writeln() 1063 1064 ew.writeln(`Credentials:`) 1065 ew.writeln(` - "HURRICANE_TOKENS": TXT record names and tokens`) 1066 ew.writeln() 1067 1068 ew.writeln() 1069 ew.writeln(`More information: https://go-acme.github.io/lego/dns/hurricane`) 1070 1071 case "hyperone": 1072 // generated from: providers/dns/hyperone/hyperone.toml 1073 ew.writeln(`Configuration for HyperOne.`) 1074 ew.writeln(`Code: 'hyperone'`) 1075 ew.writeln(`Since: 'v3.9.0'`) 1076 ew.writeln() 1077 1078 ew.writeln(`Additional Configuration:`) 1079 ew.writeln(` - "HYPERONE_API_URL": Allows to pass custom API Endpoint to be used in the challenge (default https://api.hyperone.com/v2)`) 1080 ew.writeln(` - "HYPERONE_LOCATION_ID": Specifies location (region) to be used in API calls. (default pl-waw-1)`) 1081 ew.writeln(` - "HYPERONE_PASSPORT_LOCATION": Allows to pass custom passport file location (default ~/.h1/passport.json)`) 1082 ew.writeln(` - "HYPERONE_POLLING_INTERVAL": Time between DNS propagation check`) 1083 ew.writeln(` - "HYPERONE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1084 ew.writeln(` - "HYPERONE_TTL": The TTL of the TXT record used for the DNS challenge`) 1085 1086 ew.writeln() 1087 ew.writeln(`More information: https://go-acme.github.io/lego/dns/hyperone`) 1088 1089 case "ibmcloud": 1090 // generated from: providers/dns/ibmcloud/ibmcloud.toml 1091 ew.writeln(`Configuration for IBM Cloud (SoftLayer).`) 1092 ew.writeln(`Code: 'ibmcloud'`) 1093 ew.writeln(`Since: 'v4.5.0'`) 1094 ew.writeln() 1095 1096 ew.writeln(`Credentials:`) 1097 ew.writeln(` - "SOFTLAYER_API_KEY": Classic Infrastructure API key`) 1098 ew.writeln(` - "SOFTLAYER_USERNAME": User name (IBM Cloud is <accountID>_<emailAddress>)`) 1099 ew.writeln() 1100 1101 ew.writeln(`Additional Configuration:`) 1102 ew.writeln(` - "SOFTLAYER_POLLING_INTERVAL": Time between DNS propagation check`) 1103 ew.writeln(` - "SOFTLAYER_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1104 ew.writeln(` - "SOFTLAYER_TIMEOUT": API request timeout`) 1105 ew.writeln(` - "SOFTLAYER_TTL": The TTL of the TXT record used for the DNS challenge`) 1106 1107 ew.writeln() 1108 ew.writeln(`More information: https://go-acme.github.io/lego/dns/ibmcloud`) 1109 1110 case "iij": 1111 // generated from: providers/dns/iij/iij.toml 1112 ew.writeln(`Configuration for Internet Initiative Japan.`) 1113 ew.writeln(`Code: 'iij'`) 1114 ew.writeln(`Since: 'v1.1.0'`) 1115 ew.writeln() 1116 1117 ew.writeln(`Credentials:`) 1118 ew.writeln(` - "IIJ_API_ACCESS_KEY": API access key`) 1119 ew.writeln(` - "IIJ_API_SECRET_KEY": API secret key`) 1120 ew.writeln(` - "IIJ_DO_SERVICE_CODE": DO service code`) 1121 ew.writeln() 1122 1123 ew.writeln(`Additional Configuration:`) 1124 ew.writeln(` - "IIJ_POLLING_INTERVAL": Time between DNS propagation check`) 1125 ew.writeln(` - "IIJ_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1126 ew.writeln(` - "IIJ_TTL": The TTL of the TXT record used for the DNS challenge`) 1127 1128 ew.writeln() 1129 ew.writeln(`More information: https://go-acme.github.io/lego/dns/iij`) 1130 1131 case "infoblox": 1132 // generated from: providers/dns/infoblox/infoblox.toml 1133 ew.writeln(`Configuration for Infoblox.`) 1134 ew.writeln(`Code: 'infoblox'`) 1135 ew.writeln(`Since: 'v4.4.0'`) 1136 ew.writeln() 1137 1138 ew.writeln(`Credentials:`) 1139 ew.writeln(` - "INFOBLOX_HOST": Host URI`) 1140 ew.writeln(` - "INFOBLOX_PASSWORD": Account Password`) 1141 ew.writeln(` - "INFOBLOX_USER": Account Username`) 1142 ew.writeln() 1143 1144 ew.writeln(`Additional Configuration:`) 1145 ew.writeln(` - "INFOBLOX_HTTP_TIMEOUT": HTTP request timeout`) 1146 ew.writeln(` - "INFOBLOX_POLLING_INTERVAL": Time between DNS propagation check`) 1147 ew.writeln(` - "INFOBLOX_PORT": The port for the infoblox grid manager, default: 443`) 1148 ew.writeln(` - "INFOBLOX_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1149 ew.writeln(` - "INFOBLOX_SSL_VERIFY": Whether or not to verify the TLS certificate, default: true`) 1150 ew.writeln(` - "INFOBLOX_TTL": The TTL of the TXT record used for the DNS challenge`) 1151 ew.writeln(` - "INFOBLOX_VIEW": The view for the TXT records, default: External`) 1152 ew.writeln(` - "INFOBLOX_WAPI_VERSION": The version of WAPI being used, default: 2.11`) 1153 1154 ew.writeln() 1155 ew.writeln(`More information: https://go-acme.github.io/lego/dns/infoblox`) 1156 1157 case "infomaniak": 1158 // generated from: providers/dns/infomaniak/infomaniak.toml 1159 ew.writeln(`Configuration for Infomaniak.`) 1160 ew.writeln(`Code: 'infomaniak'`) 1161 ew.writeln(`Since: 'v4.1.0'`) 1162 ew.writeln() 1163 1164 ew.writeln(`Credentials:`) 1165 ew.writeln(` - "INFOMANIAK_ACCESS_TOKEN": Access token`) 1166 ew.writeln() 1167 1168 ew.writeln(`Additional Configuration:`) 1169 ew.writeln(` - "INFOMANIAK_ENDPOINT": https://api.infomaniak.com`) 1170 ew.writeln(` - "INFOMANIAK_HTTP_TIMEOUT": API request timeout`) 1171 ew.writeln(` - "INFOMANIAK_POLLING_INTERVAL": Time between DNS propagation check`) 1172 ew.writeln(` - "INFOMANIAK_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1173 ew.writeln(` - "INFOMANIAK_TTL": The TTL of the TXT record used for the DNS challenge in seconds`) 1174 1175 ew.writeln() 1176 ew.writeln(`More information: https://go-acme.github.io/lego/dns/infomaniak`) 1177 1178 case "internetbs": 1179 // generated from: providers/dns/internetbs/internetbs.toml 1180 ew.writeln(`Configuration for Internet.bs.`) 1181 ew.writeln(`Code: 'internetbs'`) 1182 ew.writeln(`Since: 'v4.5.0'`) 1183 ew.writeln() 1184 1185 ew.writeln(`Credentials:`) 1186 ew.writeln(` - "INTERNET_BS_API_KEY": API key`) 1187 ew.writeln(` - "INTERNET_BS_PASSWORD": API password`) 1188 ew.writeln() 1189 1190 ew.writeln(`Additional Configuration:`) 1191 ew.writeln(` - "INTERNET_BS_HTTP_TIMEOUT": API request timeout`) 1192 ew.writeln(` - "INTERNET_BS_POLLING_INTERVAL": Time between DNS propagation check`) 1193 ew.writeln(` - "INTERNET_BS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1194 ew.writeln(` - "INTERNET_BS_TTL": The TTL of the TXT record used for the DNS challenge`) 1195 1196 ew.writeln() 1197 ew.writeln(`More information: https://go-acme.github.io/lego/dns/internetbs`) 1198 1199 case "inwx": 1200 // generated from: providers/dns/inwx/inwx.toml 1201 ew.writeln(`Configuration for INWX.`) 1202 ew.writeln(`Code: 'inwx'`) 1203 ew.writeln(`Since: 'v2.0.0'`) 1204 ew.writeln() 1205 1206 ew.writeln(`Credentials:`) 1207 ew.writeln(` - "INWX_PASSWORD": Password`) 1208 ew.writeln(` - "INWX_USERNAME": Username`) 1209 ew.writeln() 1210 1211 ew.writeln(`Additional Configuration:`) 1212 ew.writeln(` - "INWX_POLLING_INTERVAL": Time between DNS propagation check`) 1213 ew.writeln(` - "INWX_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation (default 360s)`) 1214 ew.writeln(` - "INWX_SANDBOX": Activate the sandbox (boolean)`) 1215 ew.writeln(` - "INWX_SHARED_SECRET": shared secret related to 2FA`) 1216 ew.writeln(` - "INWX_TTL": The TTL of the TXT record used for the DNS challenge`) 1217 1218 ew.writeln() 1219 ew.writeln(`More information: https://go-acme.github.io/lego/dns/inwx`) 1220 1221 case "ionos": 1222 // generated from: providers/dns/ionos/ionos.toml 1223 ew.writeln(`Configuration for Ionos.`) 1224 ew.writeln(`Code: 'ionos'`) 1225 ew.writeln(`Since: 'v4.2.0'`) 1226 ew.writeln() 1227 1228 ew.writeln(`Credentials:`) 1229 ew.writeln(` - "IONOS_API_KEY": API key '<prefix>.<secret>' https://developer.hosting.ionos.com/docs/getstarted`) 1230 ew.writeln() 1231 1232 ew.writeln(`Additional Configuration:`) 1233 ew.writeln(` - "IONOS_HTTP_TIMEOUT": API request timeout`) 1234 ew.writeln(` - "IONOS_POLLING_INTERVAL": Time between DNS propagation check`) 1235 ew.writeln(` - "IONOS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1236 ew.writeln(` - "IONOS_TTL": The TTL of the TXT record used for the DNS challenge`) 1237 1238 ew.writeln() 1239 ew.writeln(`More information: https://go-acme.github.io/lego/dns/ionos`) 1240 1241 case "joker": 1242 // generated from: providers/dns/joker/joker.toml 1243 ew.writeln(`Configuration for Joker.`) 1244 ew.writeln(`Code: 'joker'`) 1245 ew.writeln(`Since: 'v2.6.0'`) 1246 ew.writeln() 1247 1248 ew.writeln(`Credentials:`) 1249 ew.writeln(` - "JOKER_API_KEY": API key (only with DMAPI mode)`) 1250 ew.writeln(` - "JOKER_API_MODE": 'DMAPI' or 'SVC'. DMAPI is for resellers accounts. (Default: DMAPI)`) 1251 ew.writeln(` - "JOKER_PASSWORD": Joker.com password`) 1252 ew.writeln(` - "JOKER_USERNAME": Joker.com username`) 1253 ew.writeln() 1254 1255 ew.writeln(`Additional Configuration:`) 1256 ew.writeln(` - "JOKER_HTTP_TIMEOUT": API request timeout`) 1257 ew.writeln(` - "JOKER_POLLING_INTERVAL": Time between DNS propagation check`) 1258 ew.writeln(` - "JOKER_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1259 ew.writeln(` - "JOKER_SEQUENCE_INTERVAL": Time between sequential requests (only with 'SVC' mode)`) 1260 ew.writeln(` - "JOKER_TTL": The TTL of the TXT record used for the DNS challenge`) 1261 1262 ew.writeln() 1263 ew.writeln(`More information: https://go-acme.github.io/lego/dns/joker`) 1264 1265 case "lightsail": 1266 // generated from: providers/dns/lightsail/lightsail.toml 1267 ew.writeln(`Configuration for Amazon Lightsail.`) 1268 ew.writeln(`Code: 'lightsail'`) 1269 ew.writeln(`Since: 'v0.5.0'`) 1270 ew.writeln() 1271 1272 ew.writeln(`Credentials:`) 1273 ew.writeln(` - "AWS_ACCESS_KEY_ID": Managed by the AWS client. Access key ID ('AWS_ACCESS_KEY_ID_FILE' is not supported, use 'AWS_SHARED_CREDENTIALS_FILE' instead)`) 1274 ew.writeln(` - "AWS_SECRET_ACCESS_KEY": Managed by the AWS client. Secret access key ('AWS_SECRET_ACCESS_KEY_FILE' is not supported, use 'AWS_SHARED_CREDENTIALS_FILE' instead)`) 1275 ew.writeln(` - "DNS_ZONE": Domain name of the DNS zone`) 1276 ew.writeln() 1277 1278 ew.writeln(`Additional Configuration:`) 1279 ew.writeln(` - "AWS_SHARED_CREDENTIALS_FILE": Managed by the AWS client. Shared credentials file.`) 1280 ew.writeln(` - "LIGHTSAIL_POLLING_INTERVAL": Time between DNS propagation check`) 1281 ew.writeln(` - "LIGHTSAIL_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1282 1283 ew.writeln() 1284 ew.writeln(`More information: https://go-acme.github.io/lego/dns/lightsail`) 1285 1286 case "linode": 1287 // generated from: providers/dns/linode/linode.toml 1288 ew.writeln(`Configuration for Linode (v4).`) 1289 ew.writeln(`Code: 'linode'`) 1290 ew.writeln(`Since: 'v1.1.0'`) 1291 ew.writeln() 1292 1293 ew.writeln(`Credentials:`) 1294 ew.writeln(` - "LINODE_TOKEN": API token`) 1295 ew.writeln() 1296 1297 ew.writeln(`Additional Configuration:`) 1298 ew.writeln(` - "LINODE_HTTP_TIMEOUT": API request timeout`) 1299 ew.writeln(` - "LINODE_POLLING_INTERVAL": Time between DNS propagation check`) 1300 ew.writeln(` - "LINODE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1301 ew.writeln(` - "LINODE_TTL": The TTL of the TXT record used for the DNS challenge`) 1302 1303 ew.writeln() 1304 ew.writeln(`More information: https://go-acme.github.io/lego/dns/linode`) 1305 1306 case "liquidweb": 1307 // generated from: providers/dns/liquidweb/liquidweb.toml 1308 ew.writeln(`Configuration for Liquid Web.`) 1309 ew.writeln(`Code: 'liquidweb'`) 1310 ew.writeln(`Since: 'v3.1.0'`) 1311 ew.writeln() 1312 1313 ew.writeln(`Credentials:`) 1314 ew.writeln(` - "LIQUID_WEB_PASSWORD": Storm API Password`) 1315 ew.writeln(` - "LIQUID_WEB_USERNAME": Storm API Username`) 1316 ew.writeln(` - "LIQUID_WEB_ZONE": DNS Zone`) 1317 ew.writeln() 1318 1319 ew.writeln(`Additional Configuration:`) 1320 ew.writeln(` - "LIQUID_WEB_HTTP_TIMEOUT": Maximum waiting time for the DNS records to be created (not verified)`) 1321 ew.writeln(` - "LIQUID_WEB_POLLING_INTERVAL": Time between DNS propagation check`) 1322 ew.writeln(` - "LIQUID_WEB_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1323 ew.writeln(` - "LIQUID_WEB_TTL": The TTL of the TXT record used for the DNS challenge`) 1324 ew.writeln(` - "LIQUID_WEB_URL": Storm API endpoint`) 1325 1326 ew.writeln() 1327 ew.writeln(`More information: https://go-acme.github.io/lego/dns/liquidweb`) 1328 1329 case "loopia": 1330 // generated from: providers/dns/loopia/loopia.toml 1331 ew.writeln(`Configuration for Loopia.`) 1332 ew.writeln(`Code: 'loopia'`) 1333 ew.writeln(`Since: 'v4.2.0'`) 1334 ew.writeln() 1335 1336 ew.writeln(`Credentials:`) 1337 ew.writeln(` - "LOOPIA_API_PASSWORD": API password`) 1338 ew.writeln(` - "LOOPIA_API_USER": API username`) 1339 ew.writeln() 1340 1341 ew.writeln(`Additional Configuration:`) 1342 ew.writeln(` - "LOOPIA_HTTP_TIMEOUT": API request timeout`) 1343 ew.writeln(` - "LOOPIA_POLLING_INTERVAL": Time between DNS propagation check`) 1344 ew.writeln(` - "LOOPIA_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1345 ew.writeln(` - "LOOPIA_TTL": The TTL of the TXT record used for the DNS challenge`) 1346 1347 ew.writeln() 1348 ew.writeln(`More information: https://go-acme.github.io/lego/dns/loopia`) 1349 1350 case "luadns": 1351 // generated from: providers/dns/luadns/luadns.toml 1352 ew.writeln(`Configuration for LuaDNS.`) 1353 ew.writeln(`Code: 'luadns'`) 1354 ew.writeln(`Since: 'v3.7.0'`) 1355 ew.writeln() 1356 1357 ew.writeln(`Credentials:`) 1358 ew.writeln(` - "LUADNS_API_TOKEN": API token`) 1359 ew.writeln(` - "LUADNS_API_USERNAME": Username (your email)`) 1360 ew.writeln() 1361 1362 ew.writeln(`Additional Configuration:`) 1363 ew.writeln(` - "LUADNS_HTTP_TIMEOUT": API request timeout`) 1364 ew.writeln(` - "LUADNS_POLLING_INTERVAL": Time between DNS propagation check`) 1365 ew.writeln(` - "LUADNS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1366 ew.writeln(` - "LUADNS_TTL": The TTL of the TXT record used for the DNS challenge`) 1367 1368 ew.writeln() 1369 ew.writeln(`More information: https://go-acme.github.io/lego/dns/luadns`) 1370 1371 case "mydnsjp": 1372 // generated from: providers/dns/mydnsjp/mydnsjp.toml 1373 ew.writeln(`Configuration for MyDNS.jp.`) 1374 ew.writeln(`Code: 'mydnsjp'`) 1375 ew.writeln(`Since: 'v1.2.0'`) 1376 ew.writeln() 1377 1378 ew.writeln(`Credentials:`) 1379 ew.writeln(` - "MYDNSJP_MASTER_ID": Master ID`) 1380 ew.writeln(` - "MYDNSJP_PASSWORD": Password`) 1381 ew.writeln() 1382 1383 ew.writeln(`Additional Configuration:`) 1384 ew.writeln(` - "MYDNSJP_HTTP_TIMEOUT": API request timeout`) 1385 ew.writeln(` - "MYDNSJP_POLLING_INTERVAL": Time between DNS propagation check`) 1386 ew.writeln(` - "MYDNSJP_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1387 ew.writeln(` - "MYDNSJP_TTL": The TTL of the TXT record used for the DNS challenge`) 1388 1389 ew.writeln() 1390 ew.writeln(`More information: https://go-acme.github.io/lego/dns/mydnsjp`) 1391 1392 case "mythicbeasts": 1393 // generated from: providers/dns/mythicbeasts/mythicbeasts.toml 1394 ew.writeln(`Configuration for MythicBeasts.`) 1395 ew.writeln(`Code: 'mythicbeasts'`) 1396 ew.writeln(`Since: 'v0.3.7'`) 1397 ew.writeln() 1398 1399 ew.writeln(`Credentials:`) 1400 ew.writeln(` - "MYTHICBEASTS_PASSWORD": Password`) 1401 ew.writeln(` - "MYTHICBEASTS_USERNAME": User name`) 1402 ew.writeln() 1403 1404 ew.writeln(`Additional Configuration:`) 1405 ew.writeln(` - "MYTHICBEASTS_API_ENDPOINT": The endpoint for the API (must implement v2)`) 1406 ew.writeln(` - "MYTHICBEASTS_AUTH_API_ENDPOINT": The endpoint for Mythic Beasts' Authentication`) 1407 ew.writeln(` - "MYTHICBEASTS_HTTP_TIMEOUT": API request timeout`) 1408 ew.writeln(` - "MYTHICBEASTS_POLLING_INTERVAL": Time between DNS propagation check`) 1409 ew.writeln(` - "MYTHICBEASTS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1410 ew.writeln(` - "MYTHICBEASTS_TTL": The TTL of the TXT record used for the DNS challenge`) 1411 1412 ew.writeln() 1413 ew.writeln(`More information: https://go-acme.github.io/lego/dns/mythicbeasts`) 1414 1415 case "namecheap": 1416 // generated from: providers/dns/namecheap/namecheap.toml 1417 ew.writeln(`Configuration for Namecheap.`) 1418 ew.writeln(`Code: 'namecheap'`) 1419 ew.writeln(`Since: 'v0.3.0'`) 1420 ew.writeln() 1421 1422 ew.writeln(`Credentials:`) 1423 ew.writeln(` - "NAMECHEAP_API_KEY": API key`) 1424 ew.writeln(` - "NAMECHEAP_API_USER": API user`) 1425 ew.writeln() 1426 1427 ew.writeln(`Additional Configuration:`) 1428 ew.writeln(` - "NAMECHEAP_HTTP_TIMEOUT": API request timeout`) 1429 ew.writeln(` - "NAMECHEAP_POLLING_INTERVAL": Time between DNS propagation check`) 1430 ew.writeln(` - "NAMECHEAP_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1431 ew.writeln(` - "NAMECHEAP_SANDBOX": Activate the sandbox (boolean)`) 1432 ew.writeln(` - "NAMECHEAP_TTL": The TTL of the TXT record used for the DNS challenge`) 1433 1434 ew.writeln() 1435 ew.writeln(`More information: https://go-acme.github.io/lego/dns/namecheap`) 1436 1437 case "namedotcom": 1438 // generated from: providers/dns/namedotcom/namedotcom.toml 1439 ew.writeln(`Configuration for Name.com.`) 1440 ew.writeln(`Code: 'namedotcom'`) 1441 ew.writeln(`Since: 'v0.5.0'`) 1442 ew.writeln() 1443 1444 ew.writeln(`Credentials:`) 1445 ew.writeln(` - "NAMECOM_API_TOKEN": API token`) 1446 ew.writeln(` - "NAMECOM_USERNAME": Username`) 1447 ew.writeln() 1448 1449 ew.writeln(`Additional Configuration:`) 1450 ew.writeln(` - "NAMECOM_HTTP_TIMEOUT": API request timeout`) 1451 ew.writeln(` - "NAMECOM_POLLING_INTERVAL": Time between DNS propagation check`) 1452 ew.writeln(` - "NAMECOM_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1453 ew.writeln(` - "NAMECOM_TTL": The TTL of the TXT record used for the DNS challenge`) 1454 1455 ew.writeln() 1456 ew.writeln(`More information: https://go-acme.github.io/lego/dns/namedotcom`) 1457 1458 case "namesilo": 1459 // generated from: providers/dns/namesilo/namesilo.toml 1460 ew.writeln(`Configuration for Namesilo.`) 1461 ew.writeln(`Code: 'namesilo'`) 1462 ew.writeln(`Since: 'v2.7.0'`) 1463 ew.writeln() 1464 1465 ew.writeln(`Credentials:`) 1466 ew.writeln(` - "NAMESILO_API_KEY": Client ID`) 1467 ew.writeln() 1468 1469 ew.writeln(`Additional Configuration:`) 1470 ew.writeln(` - "NAMESILO_POLLING_INTERVAL": Time between DNS propagation check`) 1471 ew.writeln(` - "NAMESILO_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation, it is better to set larger than 15m`) 1472 ew.writeln(` - "NAMESILO_TTL": The TTL of the TXT record used for the DNS challenge, should be in [3600, 2592000]`) 1473 1474 ew.writeln() 1475 ew.writeln(`More information: https://go-acme.github.io/lego/dns/namesilo`) 1476 1477 case "netcup": 1478 // generated from: providers/dns/netcup/netcup.toml 1479 ew.writeln(`Configuration for Netcup.`) 1480 ew.writeln(`Code: 'netcup'`) 1481 ew.writeln(`Since: 'v1.1.0'`) 1482 ew.writeln() 1483 1484 ew.writeln(`Credentials:`) 1485 ew.writeln(` - "NETCUP_API_KEY": API key`) 1486 ew.writeln(` - "NETCUP_API_PASSWORD": API password`) 1487 ew.writeln(` - "NETCUP_CUSTOMER_NUMBER": Customer number`) 1488 ew.writeln() 1489 1490 ew.writeln(`Additional Configuration:`) 1491 ew.writeln(` - "NETCUP_HTTP_TIMEOUT": API request timeout`) 1492 ew.writeln(` - "NETCUP_POLLING_INTERVAL": Time between DNS propagation check`) 1493 ew.writeln(` - "NETCUP_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1494 ew.writeln(` - "NETCUP_TTL": The TTL of the TXT record used for the DNS challenge`) 1495 1496 ew.writeln() 1497 ew.writeln(`More information: https://go-acme.github.io/lego/dns/netcup`) 1498 1499 case "netlify": 1500 // generated from: providers/dns/netlify/netlify.toml 1501 ew.writeln(`Configuration for Netlify.`) 1502 ew.writeln(`Code: 'netlify'`) 1503 ew.writeln(`Since: 'v3.7.0'`) 1504 ew.writeln() 1505 1506 ew.writeln(`Credentials:`) 1507 ew.writeln(` - "NETLIFY_TOKEN": Token`) 1508 ew.writeln() 1509 1510 ew.writeln(`Additional Configuration:`) 1511 ew.writeln(` - "NETLIFY_HTTP_TIMEOUT": API request timeout`) 1512 ew.writeln(` - "NETLIFY_POLLING_INTERVAL": Time between DNS propagation check`) 1513 ew.writeln(` - "NETLIFY_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1514 ew.writeln(` - "NETLIFY_TTL": The TTL of the TXT record used for the DNS challenge`) 1515 1516 ew.writeln() 1517 ew.writeln(`More information: https://go-acme.github.io/lego/dns/netlify`) 1518 1519 case "nicmanager": 1520 // generated from: providers/dns/nicmanager/nicmanager.toml 1521 ew.writeln(`Configuration for Nicmanager.`) 1522 ew.writeln(`Code: 'nicmanager'`) 1523 ew.writeln(`Since: 'v4.5.0'`) 1524 ew.writeln() 1525 1526 ew.writeln(`Credentials:`) 1527 ew.writeln(` - "NICMANAGER_API_EMAIL": Email-based login`) 1528 ew.writeln(` - "NICMANAGER_API_LOGIN": Login, used for Username-based login`) 1529 ew.writeln(` - "NICMANAGER_API_PASSWORD": Password, always required`) 1530 ew.writeln(` - "NICMANAGER_API_USERNAME": Username, used for Username-based login`) 1531 ew.writeln() 1532 1533 ew.writeln(`Additional Configuration:`) 1534 ew.writeln(` - "NICMANAGER_API_MODE": mode: 'anycast' or 'zone' (default: 'anycast')`) 1535 ew.writeln(` - "NICMANAGER_API_OTP": TOTP Secret (optional)`) 1536 ew.writeln(` - "NICMANAGER_HTTP_TIMEOUT": API request timeout`) 1537 ew.writeln(` - "NICMANAGER_POLLING_INTERVAL": Time between DNS propagation check`) 1538 ew.writeln(` - "NICMANAGER_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1539 ew.writeln(` - "NICMANAGER_TTL": The TTL of the TXT record used for the DNS challenge`) 1540 1541 ew.writeln() 1542 ew.writeln(`More information: https://go-acme.github.io/lego/dns/nicmanager`) 1543 1544 case "nifcloud": 1545 // generated from: providers/dns/nifcloud/nifcloud.toml 1546 ew.writeln(`Configuration for NIFCloud.`) 1547 ew.writeln(`Code: 'nifcloud'`) 1548 ew.writeln(`Since: 'v1.1.0'`) 1549 ew.writeln() 1550 1551 ew.writeln(`Credentials:`) 1552 ew.writeln(` - "NIFCLOUD_ACCESS_KEY_ID": Access key`) 1553 ew.writeln(` - "NIFCLOUD_SECRET_ACCESS_KEY": Secret access key`) 1554 ew.writeln() 1555 1556 ew.writeln(`Additional Configuration:`) 1557 ew.writeln(` - "NIFCLOUD_HTTP_TIMEOUT": API request timeout`) 1558 ew.writeln(` - "NIFCLOUD_POLLING_INTERVAL": Time between DNS propagation check`) 1559 ew.writeln(` - "NIFCLOUD_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1560 ew.writeln(` - "NIFCLOUD_TTL": The TTL of the TXT record used for the DNS challenge`) 1561 1562 ew.writeln() 1563 ew.writeln(`More information: https://go-acme.github.io/lego/dns/nifcloud`) 1564 1565 case "njalla": 1566 // generated from: providers/dns/njalla/njalla.toml 1567 ew.writeln(`Configuration for Njalla.`) 1568 ew.writeln(`Code: 'njalla'`) 1569 ew.writeln(`Since: 'v4.3.0'`) 1570 ew.writeln() 1571 1572 ew.writeln(`Credentials:`) 1573 ew.writeln(` - "NJALLA_TOKEN": API token`) 1574 ew.writeln() 1575 1576 ew.writeln(`Additional Configuration:`) 1577 ew.writeln(` - "NJALLA_HTTP_TIMEOUT": API request timeout`) 1578 ew.writeln(` - "NJALLA_POLLING_INTERVAL": Time between DNS propagation check`) 1579 ew.writeln(` - "NJALLA_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1580 ew.writeln(` - "NJALLA_TTL": The TTL of the TXT record used for the DNS challenge`) 1581 1582 ew.writeln() 1583 ew.writeln(`More information: https://go-acme.github.io/lego/dns/njalla`) 1584 1585 case "ns1": 1586 // generated from: providers/dns/ns1/ns1.toml 1587 ew.writeln(`Configuration for NS1.`) 1588 ew.writeln(`Code: 'ns1'`) 1589 ew.writeln(`Since: 'v0.4.0'`) 1590 ew.writeln() 1591 1592 ew.writeln(`Credentials:`) 1593 ew.writeln(` - "NS1_API_KEY": API key`) 1594 ew.writeln() 1595 1596 ew.writeln(`Additional Configuration:`) 1597 ew.writeln(` - "NS1_HTTP_TIMEOUT": API request timeout`) 1598 ew.writeln(` - "NS1_POLLING_INTERVAL": Time between DNS propagation check`) 1599 ew.writeln(` - "NS1_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1600 ew.writeln(` - "NS1_TTL": The TTL of the TXT record used for the DNS challenge`) 1601 1602 ew.writeln() 1603 ew.writeln(`More information: https://go-acme.github.io/lego/dns/ns1`) 1604 1605 case "oraclecloud": 1606 // generated from: providers/dns/oraclecloud/oraclecloud.toml 1607 ew.writeln(`Configuration for Oracle Cloud.`) 1608 ew.writeln(`Code: 'oraclecloud'`) 1609 ew.writeln(`Since: 'v2.3.0'`) 1610 ew.writeln() 1611 1612 ew.writeln(`Credentials:`) 1613 ew.writeln(` - "OCI_COMPARTMENT_OCID": Compartment OCID`) 1614 ew.writeln(` - "OCI_PRIVKEY_FILE": Private key file`) 1615 ew.writeln(` - "OCI_PRIVKEY_PASS": Private key password`) 1616 ew.writeln(` - "OCI_PUBKEY_FINGERPRINT": Public key fingerprint`) 1617 ew.writeln(` - "OCI_REGION": Region`) 1618 ew.writeln(` - "OCI_TENANCY_OCID": Tenancy OCID`) 1619 ew.writeln(` - "OCI_USER_OCID": User OCID`) 1620 ew.writeln() 1621 1622 ew.writeln(`Additional Configuration:`) 1623 ew.writeln(` - "OCI_POLLING_INTERVAL": Time between DNS propagation check`) 1624 ew.writeln(` - "OCI_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1625 ew.writeln(` - "OCI_TTL": The TTL of the TXT record used for the DNS challenge`) 1626 1627 ew.writeln() 1628 ew.writeln(`More information: https://go-acme.github.io/lego/dns/oraclecloud`) 1629 1630 case "otc": 1631 // generated from: providers/dns/otc/otc.toml 1632 ew.writeln(`Configuration for Open Telekom Cloud.`) 1633 ew.writeln(`Code: 'otc'`) 1634 ew.writeln(`Since: 'v0.4.1'`) 1635 ew.writeln() 1636 1637 ew.writeln(`Credentials:`) 1638 ew.writeln(` - "OTC_DOMAIN_NAME": Domain name`) 1639 ew.writeln(` - "OTC_IDENTITY_ENDPOINT": Identity endpoint URL`) 1640 ew.writeln(` - "OTC_PASSWORD": Password`) 1641 ew.writeln(` - "OTC_PROJECT_NAME": Project name`) 1642 ew.writeln(` - "OTC_USER_NAME": User name`) 1643 ew.writeln() 1644 1645 ew.writeln(`Additional Configuration:`) 1646 ew.writeln(` - "OTC_HTTP_TIMEOUT": API request timeout`) 1647 ew.writeln(` - "OTC_POLLING_INTERVAL": Time between DNS propagation check`) 1648 ew.writeln(` - "OTC_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1649 ew.writeln(` - "OTC_TTL": The TTL of the TXT record used for the DNS challenge`) 1650 1651 ew.writeln() 1652 ew.writeln(`More information: https://go-acme.github.io/lego/dns/otc`) 1653 1654 case "ovh": 1655 // generated from: providers/dns/ovh/ovh.toml 1656 ew.writeln(`Configuration for OVH.`) 1657 ew.writeln(`Code: 'ovh'`) 1658 ew.writeln(`Since: 'v0.4.0'`) 1659 ew.writeln() 1660 1661 ew.writeln(`Credentials:`) 1662 ew.writeln(` - "OVH_APPLICATION_KEY": Application key`) 1663 ew.writeln(` - "OVH_APPLICATION_SECRET": Application secret`) 1664 ew.writeln(` - "OVH_CONSUMER_KEY": Consumer key`) 1665 ew.writeln(` - "OVH_ENDPOINT": Endpoint URL (ovh-eu or ovh-ca)`) 1666 ew.writeln() 1667 1668 ew.writeln(`Additional Configuration:`) 1669 ew.writeln(` - "OVH_HTTP_TIMEOUT": API request timeout`) 1670 ew.writeln(` - "OVH_POLLING_INTERVAL": Time between DNS propagation check`) 1671 ew.writeln(` - "OVH_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1672 ew.writeln(` - "OVH_TTL": The TTL of the TXT record used for the DNS challenge`) 1673 1674 ew.writeln() 1675 ew.writeln(`More information: https://go-acme.github.io/lego/dns/ovh`) 1676 1677 case "pdns": 1678 // generated from: providers/dns/pdns/pdns.toml 1679 ew.writeln(`Configuration for PowerDNS.`) 1680 ew.writeln(`Code: 'pdns'`) 1681 ew.writeln(`Since: 'v0.4.0'`) 1682 ew.writeln() 1683 1684 ew.writeln(`Credentials:`) 1685 ew.writeln(` - "PDNS_API_KEY": API key`) 1686 ew.writeln(` - "PDNS_API_URL": API URL`) 1687 ew.writeln() 1688 1689 ew.writeln(`Additional Configuration:`) 1690 ew.writeln(` - "PDNS_HTTP_TIMEOUT": API request timeout`) 1691 ew.writeln(` - "PDNS_POLLING_INTERVAL": Time between DNS propagation check`) 1692 ew.writeln(` - "PDNS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1693 ew.writeln(` - "PDNS_SERVER_NAME": Name of the server in the URL, 'localhost' by default`) 1694 ew.writeln(` - "PDNS_TTL": The TTL of the TXT record used for the DNS challenge`) 1695 1696 ew.writeln() 1697 ew.writeln(`More information: https://go-acme.github.io/lego/dns/pdns`) 1698 1699 case "porkbun": 1700 // generated from: providers/dns/porkbun/porkbun.toml 1701 ew.writeln(`Configuration for Porkbun.`) 1702 ew.writeln(`Code: 'porkbun'`) 1703 ew.writeln(`Since: 'v4.4.0'`) 1704 ew.writeln() 1705 1706 ew.writeln(`Credentials:`) 1707 ew.writeln(` - "PORKBUN_API_KEY": API key`) 1708 ew.writeln(` - "PORKBUN_SECRET_API_KEY": secret API key`) 1709 ew.writeln() 1710 1711 ew.writeln(`Additional Configuration:`) 1712 ew.writeln(` - "PORKBUN_HTTP_TIMEOUT": API request timeout`) 1713 ew.writeln(` - "PORKBUN_POLLING_INTERVAL": Time between DNS propagation check`) 1714 ew.writeln(` - "PORKBUN_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1715 ew.writeln(` - "PORKBUN_TTL": The TTL of the TXT record used for the DNS challenge`) 1716 1717 ew.writeln() 1718 ew.writeln(`More information: https://go-acme.github.io/lego/dns/porkbun`) 1719 1720 case "rackspace": 1721 // generated from: providers/dns/rackspace/rackspace.toml 1722 ew.writeln(`Configuration for Rackspace.`) 1723 ew.writeln(`Code: 'rackspace'`) 1724 ew.writeln(`Since: 'v0.4.0'`) 1725 ew.writeln() 1726 1727 ew.writeln(`Credentials:`) 1728 ew.writeln(` - "RACKSPACE_API_KEY": API key`) 1729 ew.writeln(` - "RACKSPACE_USER": API user`) 1730 ew.writeln() 1731 1732 ew.writeln(`Additional Configuration:`) 1733 ew.writeln(` - "RACKSPACE_HTTP_TIMEOUT": API request timeout`) 1734 ew.writeln(` - "RACKSPACE_POLLING_INTERVAL": Time between DNS propagation check`) 1735 ew.writeln(` - "RACKSPACE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1736 ew.writeln(` - "RACKSPACE_TTL": The TTL of the TXT record used for the DNS challenge`) 1737 1738 ew.writeln() 1739 ew.writeln(`More information: https://go-acme.github.io/lego/dns/rackspace`) 1740 1741 case "regru": 1742 // generated from: providers/dns/regru/regru.toml 1743 ew.writeln(`Configuration for reg.ru.`) 1744 ew.writeln(`Code: 'regru'`) 1745 ew.writeln(`Since: 'v3.5.0'`) 1746 ew.writeln() 1747 1748 ew.writeln(`Credentials:`) 1749 ew.writeln(` - "REGRU_PASSWORD": API password`) 1750 ew.writeln(` - "REGRU_USERNAME": API username`) 1751 ew.writeln() 1752 1753 ew.writeln(`Additional Configuration:`) 1754 ew.writeln(` - "REGRU_HTTP_TIMEOUT": API request timeout`) 1755 ew.writeln(` - "REGRU_POLLING_INTERVAL": Time between DNS propagation check`) 1756 ew.writeln(` - "REGRU_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1757 ew.writeln(` - "REGRU_TTL": The TTL of the TXT record used for the DNS challenge`) 1758 1759 ew.writeln() 1760 ew.writeln(`More information: https://go-acme.github.io/lego/dns/regru`) 1761 1762 case "rfc2136": 1763 // generated from: providers/dns/rfc2136/rfc2136.toml 1764 ew.writeln(`Configuration for RFC2136.`) 1765 ew.writeln(`Code: 'rfc2136'`) 1766 ew.writeln(`Since: 'v0.3.0'`) 1767 ew.writeln() 1768 1769 ew.writeln(`Credentials:`) 1770 ew.writeln(` - "RFC2136_NAMESERVER": Network address in the form "host" or "host:port"`) 1771 ew.writeln(` - "RFC2136_TSIG_ALGORITHM": TSIG algorithm. See [miekg/dns#tsig.go](https://github.com/miekg/dns/blob/master/tsig.go) for supported values. To disable TSIG authentication, leave the 'RFC2136_TSIG*' variables unset.`) 1772 ew.writeln(` - "RFC2136_TSIG_KEY": Name of the secret key as defined in DNS server configuration. To disable TSIG authentication, leave the 'RFC2136_TSIG*' variables unset.`) 1773 ew.writeln(` - "RFC2136_TSIG_SECRET": Secret key payload. To disable TSIG authentication, leave the' RFC2136_TSIG*' variables unset.`) 1774 ew.writeln() 1775 1776 ew.writeln(`Additional Configuration:`) 1777 ew.writeln(` - "RFC2136_DNS_TIMEOUT": API request timeout`) 1778 ew.writeln(` - "RFC2136_POLLING_INTERVAL": Time between DNS propagation check`) 1779 ew.writeln(` - "RFC2136_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1780 ew.writeln(` - "RFC2136_SEQUENCE_INTERVAL": Time between sequential requests`) 1781 ew.writeln(` - "RFC2136_TTL": The TTL of the TXT record used for the DNS challenge`) 1782 1783 ew.writeln() 1784 ew.writeln(`More information: https://go-acme.github.io/lego/dns/rfc2136`) 1785 1786 case "rimuhosting": 1787 // generated from: providers/dns/rimuhosting/rimuhosting.toml 1788 ew.writeln(`Configuration for RimuHosting.`) 1789 ew.writeln(`Code: 'rimuhosting'`) 1790 ew.writeln(`Since: 'v0.3.5'`) 1791 ew.writeln() 1792 1793 ew.writeln(`Credentials:`) 1794 ew.writeln(` - "RIMUHOSTING_API_KEY": User API key`) 1795 ew.writeln() 1796 1797 ew.writeln(`Additional Configuration:`) 1798 ew.writeln(` - "RIMUHOSTING_HTTP_TIMEOUT": API request timeout`) 1799 ew.writeln(` - "RIMUHOSTING_POLLING_INTERVAL": Time between DNS propagation check`) 1800 ew.writeln(` - "RIMUHOSTING_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1801 ew.writeln(` - "RIMUHOSTING_TTL": The TTL of the TXT record used for the DNS challenge`) 1802 1803 ew.writeln() 1804 ew.writeln(`More information: https://go-acme.github.io/lego/dns/rimuhosting`) 1805 1806 case "route53": 1807 // generated from: providers/dns/route53/route53.toml 1808 ew.writeln(`Configuration for Amazon Route 53.`) 1809 ew.writeln(`Code: 'route53'`) 1810 ew.writeln(`Since: 'v0.3.0'`) 1811 ew.writeln() 1812 1813 ew.writeln(`Credentials:`) 1814 ew.writeln(` - "AWS_ACCESS_KEY_ID": Managed by the AWS client. Access key ID ('AWS_ACCESS_KEY_ID_FILE' is not supported, use 'AWS_SHARED_CREDENTIALS_FILE' instead)`) 1815 ew.writeln(` - "AWS_HOSTED_ZONE_ID": Override the hosted zone ID.`) 1816 ew.writeln(` - "AWS_PROFILE": Managed by the AWS client ('AWS_PROFILE_FILE' is not supported)`) 1817 ew.writeln(` - "AWS_REGION": Managed by the AWS client ('AWS_REGION_FILE' is not supported)`) 1818 ew.writeln(` - "AWS_SDK_LOAD_CONFIG": Managed by the AWS client. Retrieve the region from the CLI config file ('AWS_SDK_LOAD_CONFIG_FILE' is not supported)`) 1819 ew.writeln(` - "AWS_SECRET_ACCESS_KEY": Managed by the AWS client. Secret access key ('AWS_SECRET_ACCESS_KEY_FILE' is not supported, use 'AWS_SHARED_CREDENTIALS_FILE' instead)`) 1820 ew.writeln() 1821 1822 ew.writeln(`Additional Configuration:`) 1823 ew.writeln(` - "AWS_MAX_RETRIES": The number of maximum returns the service will use to make an individual API request`) 1824 ew.writeln(` - "AWS_POLLING_INTERVAL": Time between DNS propagation check`) 1825 ew.writeln(` - "AWS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1826 ew.writeln(` - "AWS_SHARED_CREDENTIALS_FILE": Managed by the AWS client. Shared credentials file.`) 1827 ew.writeln(` - "AWS_TTL": The TTL of the TXT record used for the DNS challenge`) 1828 1829 ew.writeln() 1830 ew.writeln(`More information: https://go-acme.github.io/lego/dns/route53`) 1831 1832 case "sakuracloud": 1833 // generated from: providers/dns/sakuracloud/sakuracloud.toml 1834 ew.writeln(`Configuration for Sakura Cloud.`) 1835 ew.writeln(`Code: 'sakuracloud'`) 1836 ew.writeln(`Since: 'v1.1.0'`) 1837 ew.writeln() 1838 1839 ew.writeln(`Credentials:`) 1840 ew.writeln(` - "SAKURACLOUD_ACCESS_TOKEN": Access token`) 1841 ew.writeln(` - "SAKURACLOUD_ACCESS_TOKEN_SECRET": Access token secret`) 1842 ew.writeln() 1843 1844 ew.writeln(`Additional Configuration:`) 1845 ew.writeln(` - "SAKURACLOUD_HTTP_TIMEOUT": API request timeout`) 1846 ew.writeln(` - "SAKURACLOUD_POLLING_INTERVAL": Time between DNS propagation check`) 1847 ew.writeln(` - "SAKURACLOUD_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1848 ew.writeln(` - "SAKURACLOUD_TTL": The TTL of the TXT record used for the DNS challenge`) 1849 1850 ew.writeln() 1851 ew.writeln(`More information: https://go-acme.github.io/lego/dns/sakuracloud`) 1852 1853 case "scaleway": 1854 // generated from: providers/dns/scaleway/scaleway.toml 1855 ew.writeln(`Configuration for Scaleway.`) 1856 ew.writeln(`Code: 'scaleway'`) 1857 ew.writeln(`Since: 'v3.4.0'`) 1858 ew.writeln() 1859 1860 ew.writeln(`Credentials:`) 1861 ew.writeln(` - "SCALEWAY_API_TOKEN": API token`) 1862 ew.writeln(` - "SCALEWAY_PROJECT_ID": Project to use (optional)`) 1863 ew.writeln() 1864 1865 ew.writeln(`Additional Configuration:`) 1866 ew.writeln(` - "SCALEWAY_POLLING_INTERVAL": Time between DNS propagation check`) 1867 ew.writeln(` - "SCALEWAY_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1868 ew.writeln(` - "SCALEWAY_TTL": The TTL of the TXT record used for the DNS challenge`) 1869 1870 ew.writeln() 1871 ew.writeln(`More information: https://go-acme.github.io/lego/dns/scaleway`) 1872 1873 case "selectel": 1874 // generated from: providers/dns/selectel/selectel.toml 1875 ew.writeln(`Configuration for Selectel.`) 1876 ew.writeln(`Code: 'selectel'`) 1877 ew.writeln(`Since: 'v1.2.0'`) 1878 ew.writeln() 1879 1880 ew.writeln(`Credentials:`) 1881 ew.writeln(` - "SELECTEL_API_TOKEN": API token`) 1882 ew.writeln() 1883 1884 ew.writeln(`Additional Configuration:`) 1885 ew.writeln(` - "SELECTEL_BASE_URL": API endpoint URL`) 1886 ew.writeln(` - "SELECTEL_HTTP_TIMEOUT": API request timeout`) 1887 ew.writeln(` - "SELECTEL_POLLING_INTERVAL": Time between DNS propagation check`) 1888 ew.writeln(` - "SELECTEL_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1889 ew.writeln(` - "SELECTEL_TTL": The TTL of the TXT record used for the DNS challenge`) 1890 1891 ew.writeln() 1892 ew.writeln(`More information: https://go-acme.github.io/lego/dns/selectel`) 1893 1894 case "servercow": 1895 // generated from: providers/dns/servercow/servercow.toml 1896 ew.writeln(`Configuration for Servercow.`) 1897 ew.writeln(`Code: 'servercow'`) 1898 ew.writeln(`Since: 'v3.4.0'`) 1899 ew.writeln() 1900 1901 ew.writeln(`Credentials:`) 1902 ew.writeln(` - "SERVERCOW_PASSWORD": API password`) 1903 ew.writeln(` - "SERVERCOW_USERNAME": API username`) 1904 ew.writeln() 1905 1906 ew.writeln(`Additional Configuration:`) 1907 ew.writeln(` - "SERVERCOW_HTTP_TIMEOUT": API request timeout`) 1908 ew.writeln(` - "SERVERCOW_POLLING_INTERVAL": Time between DNS propagation check`) 1909 ew.writeln(` - "SERVERCOW_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1910 ew.writeln(` - "SERVERCOW_TTL": The TTL of the TXT record used for the DNS challenge`) 1911 1912 ew.writeln() 1913 ew.writeln(`More information: https://go-acme.github.io/lego/dns/servercow`) 1914 1915 case "simply": 1916 // generated from: providers/dns/simply/simply.toml 1917 ew.writeln(`Configuration for Simply.com.`) 1918 ew.writeln(`Code: 'simply'`) 1919 ew.writeln(`Since: 'v4.4.0'`) 1920 ew.writeln() 1921 1922 ew.writeln(`Credentials:`) 1923 ew.writeln(` - "SIMPLY_ACCOUNT_NAME": Account name`) 1924 ew.writeln(` - "SIMPLY_API_KEY": API key`) 1925 ew.writeln() 1926 1927 ew.writeln(`Additional Configuration:`) 1928 ew.writeln(` - "SIMPLY_HTTP_TIMEOUT": API request timeout`) 1929 ew.writeln(` - "SIMPLY_POLLING_INTERVAL": Time between DNS propagation check`) 1930 ew.writeln(` - "SIMPLY_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1931 ew.writeln(` - "SIMPLY_TTL": The TTL of the TXT record used for the DNS challenge`) 1932 1933 ew.writeln() 1934 ew.writeln(`More information: https://go-acme.github.io/lego/dns/simply`) 1935 1936 case "sonic": 1937 // generated from: providers/dns/sonic/sonic.toml 1938 ew.writeln(`Configuration for Sonic.`) 1939 ew.writeln(`Code: 'sonic'`) 1940 ew.writeln(`Since: 'v4.4.0'`) 1941 ew.writeln() 1942 1943 ew.writeln(`Credentials:`) 1944 ew.writeln(` - "SONIC_API_KEY": API Key`) 1945 ew.writeln(` - "SONIC_USER_ID": User ID`) 1946 ew.writeln() 1947 1948 ew.writeln(`Additional Configuration:`) 1949 ew.writeln(` - "SONIC_HTTP_TIMEOUT": API request timeout`) 1950 ew.writeln(` - "SONIC_POLLING_INTERVAL": Time between DNS propagation check`) 1951 ew.writeln(` - "SONIC_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1952 ew.writeln(` - "SONIC_SEQUENCE_INTERVAL": Time between sequential requests`) 1953 ew.writeln(` - "SONIC_TTL": The TTL of the TXT record used for the DNS challenge`) 1954 1955 ew.writeln() 1956 ew.writeln(`More information: https://go-acme.github.io/lego/dns/sonic`) 1957 1958 case "stackpath": 1959 // generated from: providers/dns/stackpath/stackpath.toml 1960 ew.writeln(`Configuration for Stackpath.`) 1961 ew.writeln(`Code: 'stackpath'`) 1962 ew.writeln(`Since: 'v1.1.0'`) 1963 ew.writeln() 1964 1965 ew.writeln(`Credentials:`) 1966 ew.writeln(` - "STACKPATH_CLIENT_ID": Client ID`) 1967 ew.writeln(` - "STACKPATH_CLIENT_SECRET": Client secret`) 1968 ew.writeln(` - "STACKPATH_STACK_ID": Stack ID`) 1969 ew.writeln() 1970 1971 ew.writeln(`Additional Configuration:`) 1972 ew.writeln(` - "STACKPATH_POLLING_INTERVAL": Time between DNS propagation check`) 1973 ew.writeln(` - "STACKPATH_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1974 ew.writeln(` - "STACKPATH_TTL": The TTL of the TXT record used for the DNS challenge`) 1975 1976 ew.writeln() 1977 ew.writeln(`More information: https://go-acme.github.io/lego/dns/stackpath`) 1978 1979 case "transip": 1980 // generated from: providers/dns/transip/transip.toml 1981 ew.writeln(`Configuration for TransIP.`) 1982 ew.writeln(`Code: 'transip'`) 1983 ew.writeln(`Since: 'v2.0.0'`) 1984 ew.writeln() 1985 1986 ew.writeln(`Credentials:`) 1987 ew.writeln(` - "TRANSIP_ACCOUNT_NAME": Account name`) 1988 ew.writeln(` - "TRANSIP_PRIVATE_KEY_PATH": Private key path`) 1989 ew.writeln() 1990 1991 ew.writeln(`Additional Configuration:`) 1992 ew.writeln(` - "TRANSIP_POLLING_INTERVAL": Time between DNS propagation check`) 1993 ew.writeln(` - "TRANSIP_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 1994 ew.writeln(` - "TRANSIP_TTL": The TTL of the TXT record used for the DNS challenge`) 1995 1996 ew.writeln() 1997 ew.writeln(`More information: https://go-acme.github.io/lego/dns/transip`) 1998 1999 case "vegadns": 2000 // generated from: providers/dns/vegadns/vegadns.toml 2001 ew.writeln(`Configuration for VegaDNS.`) 2002 ew.writeln(`Code: 'vegadns'`) 2003 ew.writeln(`Since: 'v1.1.0'`) 2004 ew.writeln() 2005 2006 ew.writeln(`Credentials:`) 2007 ew.writeln(` - "SECRET_VEGADNS_KEY": API key`) 2008 ew.writeln(` - "SECRET_VEGADNS_SECRET": API secret`) 2009 ew.writeln(` - "VEGADNS_URL": API endpoint URL`) 2010 ew.writeln() 2011 2012 ew.writeln(`Additional Configuration:`) 2013 ew.writeln(` - "VEGADNS_POLLING_INTERVAL": Time between DNS propagation check`) 2014 ew.writeln(` - "VEGADNS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 2015 ew.writeln(` - "VEGADNS_TTL": The TTL of the TXT record used for the DNS challenge`) 2016 2017 ew.writeln() 2018 ew.writeln(`More information: https://go-acme.github.io/lego/dns/vegadns`) 2019 2020 case "versio": 2021 // generated from: providers/dns/versio/versio.toml 2022 ew.writeln(`Configuration for Versio.[nl|eu|uk].`) 2023 ew.writeln(`Code: 'versio'`) 2024 ew.writeln(`Since: 'v2.7.0'`) 2025 ew.writeln() 2026 2027 ew.writeln(`Credentials:`) 2028 ew.writeln(` - "VERSIO_PASSWORD": Basic authentication password`) 2029 ew.writeln(` - "VERSIO_USERNAME": Basic authentication username`) 2030 ew.writeln() 2031 2032 ew.writeln(`Additional Configuration:`) 2033 ew.writeln(` - "VERSIO_ENDPOINT": The endpoint URL of the API Server`) 2034 ew.writeln(` - "VERSIO_HTTP_TIMEOUT": API request timeout`) 2035 ew.writeln(` - "VERSIO_POLLING_INTERVAL": Time between DNS propagation check`) 2036 ew.writeln(` - "VERSIO_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 2037 ew.writeln(` - "VERSIO_SEQUENCE_INTERVAL": Time between sequential requests, default 60s`) 2038 ew.writeln(` - "VERSIO_TTL": The TTL of the TXT record used for the DNS challenge`) 2039 2040 ew.writeln() 2041 ew.writeln(`More information: https://go-acme.github.io/lego/dns/versio`) 2042 2043 case "vinyldns": 2044 // generated from: providers/dns/vinyldns/vinyldns.toml 2045 ew.writeln(`Configuration for VinylDNS.`) 2046 ew.writeln(`Code: 'vinyldns'`) 2047 ew.writeln(`Since: 'v4.4.0'`) 2048 ew.writeln() 2049 2050 ew.writeln(`Credentials:`) 2051 ew.writeln(` - "VINYLDNS_ACCESS_KEY": The VinylDNS API key`) 2052 ew.writeln(` - "VINYLDNS_HOST": The VinylDNS API URL`) 2053 ew.writeln(` - "VINYLDNS_SECRET_KEY": The VinylDNS API Secret key`) 2054 ew.writeln() 2055 2056 ew.writeln(`Additional Configuration:`) 2057 ew.writeln(` - "VINYLDNS_POLLING_INTERVAL": Time between DNS propagation check`) 2058 ew.writeln(` - "VINYLDNS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 2059 ew.writeln(` - "VINYLDNS_TTL": The TTL of the TXT record used for the DNS challenge`) 2060 2061 ew.writeln() 2062 ew.writeln(`More information: https://go-acme.github.io/lego/dns/vinyldns`) 2063 2064 case "vscale": 2065 // generated from: providers/dns/vscale/vscale.toml 2066 ew.writeln(`Configuration for Vscale.`) 2067 ew.writeln(`Code: 'vscale'`) 2068 ew.writeln(`Since: 'v2.0.0'`) 2069 ew.writeln() 2070 2071 ew.writeln(`Credentials:`) 2072 ew.writeln(` - "VSCALE_API_TOKEN": API token`) 2073 ew.writeln() 2074 2075 ew.writeln(`Additional Configuration:`) 2076 ew.writeln(` - "VSCALE_BASE_URL": API endpoint URL`) 2077 ew.writeln(` - "VSCALE_HTTP_TIMEOUT": API request timeout`) 2078 ew.writeln(` - "VSCALE_POLLING_INTERVAL": Time between DNS propagation check`) 2079 ew.writeln(` - "VSCALE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 2080 ew.writeln(` - "VSCALE_TTL": The TTL of the TXT record used for the DNS challenge`) 2081 2082 ew.writeln() 2083 ew.writeln(`More information: https://go-acme.github.io/lego/dns/vscale`) 2084 2085 case "vultr": 2086 // generated from: providers/dns/vultr/vultr.toml 2087 ew.writeln(`Configuration for Vultr.`) 2088 ew.writeln(`Code: 'vultr'`) 2089 ew.writeln(`Since: 'v0.3.1'`) 2090 ew.writeln() 2091 2092 ew.writeln(`Credentials:`) 2093 ew.writeln(` - "VULTR_API_KEY": API key`) 2094 ew.writeln() 2095 2096 ew.writeln(`Additional Configuration:`) 2097 ew.writeln(` - "VULTR_HTTP_TIMEOUT": API request timeout`) 2098 ew.writeln(` - "VULTR_POLLING_INTERVAL": Time between DNS propagation check`) 2099 ew.writeln(` - "VULTR_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 2100 ew.writeln(` - "VULTR_TTL": The TTL of the TXT record used for the DNS challenge`) 2101 2102 ew.writeln() 2103 ew.writeln(`More information: https://go-acme.github.io/lego/dns/vultr`) 2104 2105 case "wedos": 2106 // generated from: providers/dns/wedos/wedos.toml 2107 ew.writeln(`Configuration for WEDOS.`) 2108 ew.writeln(`Code: 'wedos'`) 2109 ew.writeln(`Since: 'v4.4.0'`) 2110 ew.writeln() 2111 2112 ew.writeln(`Credentials:`) 2113 ew.writeln(` - "WEDOS_USERNAME": Username is the same as for the admin account`) 2114 ew.writeln(` - "WEDOS_WAPI_PASSWORD": Password needs to be generated and IP allowed in the admin interface`) 2115 ew.writeln() 2116 2117 ew.writeln(`Additional Configuration:`) 2118 ew.writeln(` - "WEDOS_HTTP_TIMEOUT": API request timeout`) 2119 ew.writeln(` - "WEDOS_POLLING_INTERVAL": Time between DNS propagation check`) 2120 ew.writeln(` - "WEDOS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 2121 ew.writeln(` - "WEDOS_TTL": The TTL of the TXT record used for the DNS challenge`) 2122 2123 ew.writeln() 2124 ew.writeln(`More information: https://go-acme.github.io/lego/dns/wedos`) 2125 2126 case "yandex": 2127 // generated from: providers/dns/yandex/yandex.toml 2128 ew.writeln(`Configuration for Yandex.`) 2129 ew.writeln(`Code: 'yandex'`) 2130 ew.writeln(`Since: 'v3.7.0'`) 2131 ew.writeln() 2132 2133 ew.writeln(`Credentials:`) 2134 ew.writeln(` - "YANDEX_PDD_TOKEN": Basic authentication username`) 2135 ew.writeln() 2136 2137 ew.writeln(`Additional Configuration:`) 2138 ew.writeln(` - "YANDEX_HTTP_TIMEOUT": API request timeout`) 2139 ew.writeln(` - "YANDEX_POLLING_INTERVAL": Time between DNS propagation check`) 2140 ew.writeln(` - "YANDEX_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 2141 ew.writeln(` - "YANDEX_TTL": The TTL of the TXT record used for the DNS challenge`) 2142 2143 ew.writeln() 2144 ew.writeln(`More information: https://go-acme.github.io/lego/dns/yandex`) 2145 2146 case "zoneee": 2147 // generated from: providers/dns/zoneee/zoneee.toml 2148 ew.writeln(`Configuration for Zone.ee.`) 2149 ew.writeln(`Code: 'zoneee'`) 2150 ew.writeln(`Since: 'v2.1.0'`) 2151 ew.writeln() 2152 2153 ew.writeln(`Credentials:`) 2154 ew.writeln(` - "ZONEEE_API_KEY": API key`) 2155 ew.writeln(` - "ZONEEE_API_USER": API user`) 2156 ew.writeln() 2157 2158 ew.writeln(`Additional Configuration:`) 2159 ew.writeln(` - "ZONEEE_ENDPOINT": API endpoint URL`) 2160 ew.writeln(` - "ZONEEE_HTTP_TIMEOUT": API request timeout`) 2161 ew.writeln(` - "ZONEEE_POLLING_INTERVAL": Time between DNS propagation check`) 2162 ew.writeln(` - "ZONEEE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 2163 ew.writeln(` - "ZONEEE_TTL": The TTL of the TXT record used for the DNS challenge`) 2164 2165 ew.writeln() 2166 ew.writeln(`More information: https://go-acme.github.io/lego/dns/zoneee`) 2167 2168 case "zonomi": 2169 // generated from: providers/dns/zonomi/zonomi.toml 2170 ew.writeln(`Configuration for Zonomi.`) 2171 ew.writeln(`Code: 'zonomi'`) 2172 ew.writeln(`Since: 'v3.5.0'`) 2173 ew.writeln() 2174 2175 ew.writeln(`Credentials:`) 2176 ew.writeln(` - "ZONOMI_API_KEY": User API key`) 2177 ew.writeln() 2178 2179 ew.writeln(`Additional Configuration:`) 2180 ew.writeln(` - "ZONOMI_HTTP_TIMEOUT": API request timeout`) 2181 ew.writeln(` - "ZONOMI_POLLING_INTERVAL": Time between DNS propagation check`) 2182 ew.writeln(` - "ZONOMI_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) 2183 ew.writeln(` - "ZONOMI_TTL": The TTL of the TXT record used for the DNS challenge`) 2184 2185 ew.writeln() 2186 ew.writeln(`More information: https://go-acme.github.io/lego/dns/zonomi`) 2187 2188 case "manual": 2189 ew.writeln(`Solving the DNS-01 challenge using CLI prompt.`) 2190 default: 2191 return fmt.Errorf("%q is not yet supported", name) 2192 } 2193 2194 if ew.err != nil { 2195 return fmt.Errorf("error: %w", ew.err) 2196 } 2197 2198 return w.Flush() 2199} 2200