lego/docs/content/dns/zz_gen_vercel.md

69 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

---
title: "Vercel"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: vercel
2022-06-16 22:25:42 +00:00
dnsprovider:
since: "v4.7.0"
code: "vercel"
url: "https://vercel.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/vercel/vercel.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Configuration for [Vercel](https://vercel.com).
<!--more-->
- Code: `vercel`
2022-06-16 22:25:42 +00:00
- Since: v4.7.0
Here is an example bash command using the Vercel provider:
```bash
VERCEL_API_TOKEN=xxxxxx \
2022-06-16 22:25:42 +00:00
lego --email you@example.com --dns vercel --domains my.example.org run
```
## Credentials
| Environment Variable Name | Description |
|-----------------------|-------------|
| `VERCEL_API_TOKEN` | Authentication token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
2022-06-16 22:25:42 +00:00
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `VERCEL_HTTP_TIMEOUT` | API request timeout |
| `VERCEL_POLLING_INTERVAL` | Time between DNS propagation check |
| `VERCEL_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `VERCEL_TEAM_ID` | Team ID (ex: team_xxxxxxxxxxxxxxxxxxxxxxxx) |
| `VERCEL_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.
2022-06-16 22:25:42 +00:00
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## More information
- [API documentation](https://vercel.com/docs/rest-api#endpoints/dns)
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/vercel/vercel.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->