lego/docs/content/dns/zz_gen_netlify.md

68 lines
1.8 KiB
Markdown
Raw Normal View History

2020-05-08 10:26:44 +00:00
---
title: "Netlify"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: netlify
2022-06-16 22:25:42 +00:00
dnsprovider:
since: "v3.7.0"
code: "netlify"
url: "https://www.netlify.com"
2020-05-08 10:26:44 +00:00
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/netlify/netlify.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Configuration for [Netlify](https://www.netlify.com).
<!--more-->
- Code: `netlify`
2022-06-16 22:25:42 +00:00
- Since: v3.7.0
2020-05-08 10:26:44 +00:00
Here is an example bash command using the Netlify provider:
```bash
NETLIFY_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
2022-06-16 22:25:42 +00:00
lego --email you@example.com --dns netlify --domains my.example.org run
2020-05-08 10:26:44 +00:00
```
## Credentials
| Environment Variable Name | Description |
|-----------------------|-------------|
| `NETLIFY_TOKEN` | Token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
2024-08-14 21:55:11 +00:00
More information [here]({{% ref "dns#configuration-and-credentials" %}}).
2020-05-08 10:26:44 +00:00
## Additional Configuration
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `NETLIFY_HTTP_TIMEOUT` | API request timeout |
| `NETLIFY_POLLING_INTERVAL` | Time between DNS propagation check |
| `NETLIFY_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `NETLIFY_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
2024-08-14 21:55:11 +00:00
More information [here]({{% ref "dns#configuration-and-credentials" %}}).
2020-05-08 10:26:44 +00:00
## More information
- [API documentation](https://open-api.netlify.com/)
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/netlify/netlify.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->