From 27bb3f225680368f792ec7090ccd1dec7324c5f0 Mon Sep 17 00:00:00 2001 From: Ludovic Fernandez Date: Thu, 30 Dec 2021 13:31:31 +0100 Subject: [PATCH] joker: explains user and password for SVC mode (#1555) --- docs/content/dns/zz_gen_joker.md | 16 ++++++++++++++++ providers/dns/joker/joker.toml | 19 +++++++++++++++++++ 2 files changed, 35 insertions(+) diff --git a/docs/content/dns/zz_gen_joker.md b/docs/content/dns/zz_gen_joker.md index 9596bb78..c6598efa 100644 --- a/docs/content/dns/zz_gen_joker.md +++ b/docs/content/dns/zz_gen_joker.md @@ -67,6 +67,22 @@ 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. More information [here](/lego/dns/#configuration-and-credentials). +## SVC mode + +In the SVC mode, username and passsword are not your email and account passwords, but those displayed in Joker.com domain dashboard when enabling Dynamic DNS. + +As per [Joker.com documentation](https://joker.com/faq/content/6/496/en/let_s-encrypt-support.html): + +> 1. please login at Joker.com, visit 'My Domains', +> find the domain you want to add Let's Encrypt certificate for, and chose "DNS" in the menu +> +> 2. on the top right, you will find the setting for 'Dynamic DNS'. +> If not already active, please activate it. +> It will not affect any other already existing DNS records of this domain. +> +> 3. please take a note of the credentials which are now shown as 'Dynamic DNS Authentication', consisting of a 'username' and a 'password'. +> +> 4. this is all you have to do here - and only once per domain. diff --git a/providers/dns/joker/joker.toml b/providers/dns/joker/joker.toml index 51c4ad58..09e7cf4b 100644 --- a/providers/dns/joker/joker.toml +++ b/providers/dns/joker/joker.toml @@ -22,6 +22,25 @@ JOKER_API_KEY= \ lego --email myemail@example.com --dns joker --domains my.example.org run ''' +Additional = ''' +## SVC mode + +In the SVC mode, username and passsword are not your email and account passwords, but those displayed in Joker.com domain dashboard when enabling Dynamic DNS. + +As per [Joker.com documentation](https://joker.com/faq/content/6/496/en/let_s-encrypt-support.html): + +> 1. please login at Joker.com, visit 'My Domains', +> find the domain you want to add Let's Encrypt certificate for, and chose "DNS" in the menu +> +> 2. on the top right, you will find the setting for 'Dynamic DNS'. +> If not already active, please activate it. +> It will not affect any other already existing DNS records of this domain. +> +> 3. please take a note of the credentials which are now shown as 'Dynamic DNS Authentication', consisting of a 'username' and a 'password'. +> +> 4. this is all you have to do here - and only once per domain. +''' + [Configuration] [Configuration.Credentials] JOKER_API_MODE = "'DMAPI' or 'SVC'. DMAPI is for resellers accounts. (Default: DMAPI)"