2019-03-08 18:47:06 +00:00
|
|
|
Name = "Cloudflare"
|
|
|
|
|
Description = ''''''
|
|
|
|
|
URL = "https://www.cloudflare.com/dns/"
|
|
|
|
|
Code = "cloudflare"
|
2019-04-17 19:32:38 +00:00
|
|
|
Since = "v0.3.0"
|
2019-03-08 18:47:06 +00:00
|
|
|
|
|
|
|
|
Example = '''
|
|
|
|
|
CLOUDFLARE_EMAIL=foo@bar.com \
|
|
|
|
|
CLOUDFLARE_API_KEY=b9841238feb177a84330febba8a83208921177bffe733 \
|
|
|
|
|
lego --dns cloudflare --domains my.domain.com --email my@email.com run
|
2019-09-01 12:32:20 +00:00
|
|
|
|
|
|
|
|
# or
|
|
|
|
|
|
|
|
|
|
CLOUDFLARE_API_TOKEN=1234567890abcdefghijklmnopqrstuvwxyz \
|
|
|
|
|
lego --dns cloudflare --domains my.domain.com --email my@email.com run
|
2019-03-08 18:47:06 +00:00
|
|
|
'''
|
|
|
|
|
|
2019-07-04 16:10:43 +00:00
|
|
|
Additional = '''
|
2019-09-01 12:32:20 +00:00
|
|
|
## Description
|
|
|
|
|
|
|
|
|
|
You may use `CF_API_EMAIL` and `CF_API_KEY` to authenticate, or `CF_API_TOKEN`.
|
|
|
|
|
|
|
|
|
|
### API keys
|
|
|
|
|
|
|
|
|
|
If using API keys (`CF_API_EMAIL` and `CF_API_KEY`), the Global API Key needs to be used, not the Origin CA Key.
|
|
|
|
|
|
|
|
|
|
### API tokens
|
|
|
|
|
|
|
|
|
|
If using [API tokens](https://api.cloudflare.com/#getting-started-endpoints) (`CF_API_TOKEN`), the following permissions are required:
|
|
|
|
|
|
|
|
|
|
* `Zone:Read`
|
|
|
|
|
* `DNS:Edit`
|
2019-07-04 16:10:43 +00:00
|
|
|
'''
|
|
|
|
|
|
2019-03-08 18:47:06 +00:00
|
|
|
[Configuration]
|
|
|
|
|
[Configuration.Credentials]
|
2019-07-04 16:10:43 +00:00
|
|
|
CF_API_EMAIL = "Account email"
|
|
|
|
|
CF_API_KEY = "API key"
|
2019-09-01 12:32:20 +00:00
|
|
|
CF_API_TOKEN = "API token"
|
2019-07-04 16:10:43 +00:00
|
|
|
CLOUDFLARE_EMAIL = "Alias to CF_API_EMAIL"
|
2019-09-01 12:32:20 +00:00
|
|
|
CLOUDFLARE_API_KEY = "Alias to CF_API_KEY"
|
|
|
|
|
CLOUDFLARE_API_TOKEN = "Alias to CF_API_TOKEN"
|
2019-03-08 18:47:06 +00:00
|
|
|
[Configuration.Additional]
|
|
|
|
|
CLOUDFLARE_POLLING_INTERVAL = "Time between DNS propagation check"
|
|
|
|
|
CLOUDFLARE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
|
|
|
|
|
CLOUDFLARE_TTL = "The TTL of the TXT record used for the DNS challenge"
|
|
|
|
|
CLOUDFLARE_HTTP_TIMEOUT = "API request timeout"
|
|
|
|
|
|
|
|
|
|
[Links]
|
|
|
|
|
API = "https://api.cloudflare.com/"
|
|
|
|
|
GoClient = "https://github.com/cloudflare/cloudflare-go"
|
