potyarkin/lego
1
0
Fork 0
forked from TrueCloudLab/lego
Code Pull requests Activity

doc: improve Cloudflare documentation. (#913)

Browse source
This commit is contained in:
Ludovic Fernandez 2019-07-04 18:10:43 +02:00 committed by GitHub
parent 6647ce7b1d
commit 8dcc55b828
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 18 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
cmd/zz_gen_cmd_dnshelp.go
View file

@ -216,8 +216,10 @@ func displayDNSHelp(name string) {
fmt.Fprintln(w) fmt.Fprintln(w)
fmt.Fprintln(w, `Credentials:`) fmt.Fprintln(w, `Credentials:`)
fmt.Fprintln(w, ` - "CLOUDFLARE_API_KEY": API key`) fmt.Fprintln(w, ` - "CF_API_EMAIL": Account email`)
fmt.Fprintln(w, ` - "CLOUDFLARE_EMAIL": Account email`) fmt.Fprintln(w, ` - "CF_API_KEY": API key`)
fmt.Fprintln(w, ` - "CLOUDFLARE_API_KEY": Alias to CLOUDFLARE_API_KEY`)
fmt.Fprintln(w, ` - "CLOUDFLARE_EMAIL": Alias to CF_API_EMAIL`)
fmt.Fprintln(w) fmt.Fprintln(w)
fmt.Fprintln(w, `Additional Configuration:`) fmt.Fprintln(w, `Additional Configuration:`)

7
docs/content/dns/zz_gen_cloudflare.md
View file

@ -33,8 +33,10 @@ lego --dns cloudflare --domains my.domain.com --email my@email.com run
| Environment Variable Name | Description | | Environment Variable Name | Description |
|-----------------------|-------------| |-----------------------|-------------|
| `CLOUDFLARE_API_KEY` | API key | | `CF_API_EMAIL` | Account email |
| `CLOUDFLARE_EMAIL` | Account email | | `CF_API_KEY` | API key |
| `CLOUDFLARE_API_KEY` | Alias to CLOUDFLARE_API_KEY |
| `CLOUDFLARE_EMAIL` | Alias to CF_API_EMAIL |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here](/lego/dns/#configuration-and-credentials).
@ -52,6 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here](/lego/dns/#configuration-and-credentials).
The Global API Key needs to be used, not the Origin CA Key.

3
platform/config/env/env_test.go vendored
View file

@ -85,7 +85,7 @@ func TestGetWithFallback(t *testing.T) {
}, },
}, },
{ {
desc: "only all env vars have a value", desc: "all env vars in a groups have a value",
groups: [][]string{{"TEST_LEGO_VAR_EXIST_1", "TEST_LEGO_VAR_EXIST_2"}}, groups: [][]string{{"TEST_LEGO_VAR_EXIST_1", "TEST_LEGO_VAR_EXIST_2"}},
expected: expected{ expected: expected{
value: map[string]string{"TEST_LEGO_VAR_EXIST_1": "VAR1"}, value: map[string]string{"TEST_LEGO_VAR_EXIST_1": "VAR1"},
@ -104,7 +104,6 @@ func TestGetWithFallback(t *testing.T) {
} }
}) })
} }
} }
func TestGetOrDefaultInt(t *testing.T) { func TestGetOrDefaultInt(t *testing.T) {

10
providers/dns/cloudflare/cloudflare.toml
View file

@ -10,10 +10,16 @@ CLOUDFLARE_API_KEY=b9841238feb177a84330febba8a83208921177bffe733 \
lego --dns cloudflare --domains my.domain.com --email my@email.com run lego --dns cloudflare --domains my.domain.com --email my@email.com run
''' '''
Additional = '''
The Global API Key needs to be used, not the Origin CA Key.
'''
[Configuration] [Configuration]
[Configuration.Credentials] [Configuration.Credentials]
CLOUDFLARE_EMAIL = "Account email" CF_API_EMAIL = "Account email"
CLOUDFLARE_API_KEY = "API key" CF_API_KEY = "API key"
CLOUDFLARE_EMAIL = "Alias to CF_API_EMAIL"
CLOUDFLARE_API_KEY = "Alias to CLOUDFLARE_API_KEY"
[Configuration.Additional] [Configuration.Additional]
CLOUDFLARE_POLLING_INTERVAL = "Time between DNS propagation check" CLOUDFLARE_POLLING_INTERVAL = "Time between DNS propagation check"
CLOUDFLARE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation" CLOUDFLARE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"