Skip to content

Commit 19f6929

Browse files
committed
Update README
1 parent fab3cf6 commit 19f6929

1 file changed

Lines changed: 21 additions & 4 deletions

File tree

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The following AWS IAM policy is a minimal working example to give `libdns` permi
6868
}
6969
```
7070

71-
## Examples
71+
## Configuration
7272

7373
To use this module for the ACME DNS challenge, configure the ACME issuer in your Caddyfile like so:
7474

@@ -100,7 +100,10 @@ tls {
100100
}
101101
```
102102

103-
or with the JSON configuration (see above for comments):
103+
> [!NOTE]
104+
> As of 2025, the `region` option is rarely needs to be changed because most AWS Route53 regions use [the same endpoints](https://docs.aws.amazon.com/general/latest/gr/r53.html) as `us-east-1`. It is only required for AWS GovCloud and the China Beijing and Ningxia regions.
105+
106+
### JSON configuration example (see above for comments):
104107

105108
```json
106109
{
@@ -129,12 +132,26 @@ When using AWS EC2 instance roles, a minimal Caddy configuration may look like t
129132
```caddy
130133
*.caddyexample.example.com {
131134
tls {
132-
dns route53 {
133-
}
135+
dns route53 {
136+
}
137+
}
138+
}
139+
```
140+
141+
When using AWS access keys, the configuration becomes:
142+
143+
```caddy
144+
*.caddyexample.example.com {
145+
tls {
146+
dns route53 {
147+
access_key_id "AKI..."
148+
secret_access_key "wJa..."
149+
}
134150
}
135151
}
136152
```
137153

138154
## More information
139155

140156
This module is extremely compact and primarily does configuration - the actual Route53 calls are made by [libdns/route53](https://github.com/libdns/route53). Refer to that project for more information.
157+

0 commit comments

Comments
 (0)