lego/docs/content/dns/zz_gen_joker.md

80 lines
2.2 KiB
Markdown
Raw Normal View History

2019-04-28 12:33:50 +00:00
---
title: "Joker"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: joker
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/joker/joker.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.6.0
Configuration for [Joker](https://joker.com).
<!--more-->
- Code: `joker`
Here is an example bash command using the Joker provider:
```bash
2020-10-08 14:52:50 +00:00
# SVC
JOKER_API_MODE=SVC \
JOKER_USERNAME=<your email> \
JOKER_PASSWORD=<your password> \
lego --email myemail@example.com --dns joker --domains my.example.org run
2020-10-08 14:52:50 +00:00
# DMAPI
JOKER_API_MODE=DMAPI \
JOKER_USERNAME=<your email> \
JOKER_PASSWORD=<your password> \
lego --email myemail@example.com --dns joker --domains my.example.org run
2020-10-08 14:52:50 +00:00
## or
JOKER_API_MODE=DMAPI \
2019-04-28 12:33:50 +00:00
JOKER_API_KEY=<your API key> \
lego --email myemail@example.com --dns joker --domains my.example.org run
2019-04-28 12:33:50 +00:00
```
## Credentials
| Environment Variable Name | Description |
|-----------------------|-------------|
2020-10-08 14:52:50 +00:00
| `JOKER_API_KEY` | API key (only with DMAPI mode) |
| `JOKER_API_MODE` | 'DMAPI' or 'SVC'. DMAPI is for resellers accounts. (Default: DMAPI) |
| `JOKER_PASSWORD` | Joker.com password |
| `JOKER_USERNAME` | Joker.com username |
2019-04-28 12:33:50 +00:00
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).
## Additional Configuration
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `JOKER_HTTP_TIMEOUT` | API request timeout |
| `JOKER_POLLING_INTERVAL` | Time between DNS propagation check |
| `JOKER_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
2021-04-25 09:51:37 +00:00
| `JOKER_SEQUENCE_INTERVAL` | Time between sequential requests (only with 'SVC' mode) |
2019-04-28 12:33:50 +00:00
| `JOKER_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.
More information [here](/lego/dns/#configuration-and-credentials).
## More information
- [API documentation](https://joker.com/faq/category/39/22-dmapi.html)
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/joker/joker.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->