From 4d360d4bdac39a830fdc2b0a0910788c0e4b1588 Mon Sep 17 00:00:00 2001 From: Jeffrey Cafferata Date: Sun, 21 May 2023 19:30:30 +0200 Subject: [PATCH] DOCS: Fixed creds.json example (#2385) --- documentation/ci-cd-gitlab.md | 10 +++---- documentation/get-certs.md | 34 ++++++++++++------------ documentation/getting-started.md | 2 +- documentation/notifications.md | 2 +- documentation/providers/akamaiedgedns.md | 4 ++- documentation/providers/axfrddns.md | 20 +++++++------- documentation/providers/azure_dns.md | 8 +++--- documentation/providers/dnsmadeeasy.md | 2 +- documentation/providers/hedns.md | 16 ++++++----- documentation/providers/hexonet.md | 2 +- documentation/providers/inwx.md | 11 ++++---- documentation/providers/route53.md | 4 +-- 12 files changed, 60 insertions(+), 55 deletions(-) diff --git a/documentation/ci-cd-gitlab.md b/documentation/ci-cd-gitlab.md index 40d3bbe4d..d7f404f21 100644 --- a/documentation/ci-cd-gitlab.md +++ b/documentation/ci-cd-gitlab.md @@ -33,11 +33,11 @@ D('cafferata.dev', {% code title="creds.json" %} ```json { - "transip": { - "TYPE": "TRANSIP", - "AccountName": "cafferatax", - "PrivateKey": "$TRANSIP_PRIVATE_KEY" - } + "transip": { + "TYPE": "TRANSIP", + "AccountName": "cafferatax", + "PrivateKey": "$TRANSIP_PRIVATE_KEY" + } } ``` {% endcode %} diff --git a/documentation/get-certs.md b/documentation/get-certs.md index cc65fbb0f..774b574b8 100644 --- a/documentation/get-certs.md +++ b/documentation/get-certs.md @@ -56,23 +56,23 @@ The format of the file is a simple JSON array of objects: {% code title="certs.json" %} ```json [ - { - "cert_name": "mainCert", - "names": [ - "example.com.com", - "www.example.com" - ] - }, - { - "cert_name": "wildcardCert", - "names": [ - "example.com", - "*.example.com", - "*.foo.example.com", - "otherdomain.tld", - "*.otherdomain.tld" - ] - } + { + "cert_name": "mainCert", + "names": [ + "example.com.com", + "www.example.com" + ] + }, + { + "cert_name": "wildcardCert", + "names": [ + "example.com", + "*.example.com", + "*.foo.example.com", + "otherdomain.tld", + "*.otherdomain.tld" + ] + } ] ``` {% endcode %} diff --git a/documentation/getting-started.md b/documentation/getting-started.md index 4295c369c..7a9186fdc 100644 --- a/documentation/getting-started.md +++ b/documentation/getting-started.md @@ -194,7 +194,7 @@ FYI: `creds.json` fields can be read from an environment variable. The field mus {% code title="creds.json" %} ```json { - "apikey": "$GANDI_V5_APIKEY" + "apikey": "$GANDI_V5_APIKEY" } ``` {% endcode %} diff --git a/documentation/notifications.md b/documentation/notifications.md index 3206b06e3..f274512fe 100644 --- a/documentation/notifications.md +++ b/documentation/notifications.md @@ -17,7 +17,7 @@ Notifications are set up in your credentials JSON file. They will use the `notif "gcloud": { ... } , - "notifications":{ + "notifications": { "slack_url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX", "teams_url": "https://outlook.office.com/webhook/00000000-0000-0000-0000-000000000000@00000000-0000-0000-0000-000000000000/IncomingWebhook/00000000000000000000000000000000/00000000-0000-0000-0000-000000000000" } diff --git a/documentation/providers/akamaiedgedns.md b/documentation/providers/akamaiedgedns.md index 6f0a92472..8f9e82793 100644 --- a/documentation/providers/akamaiedgedns.md +++ b/documentation/providers/akamaiedgedns.md @@ -21,7 +21,8 @@ Example: {% code title="creds.json" %} ```json -"akamaiedgedns": { +{ + "akamaiedgedns": { "TYPE": "AKAMAIEDGEDNS", "client_secret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "host": "akaa-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxx.akamaiapis.net", @@ -29,6 +30,7 @@ Example: "client_token": "akaa-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "contract_id": "X-XXXX", "group_id": "NNNNNN" + } } ``` {% endcode %} diff --git a/documentation/providers/axfrddns.md b/documentation/providers/axfrddns.md index 44eebb81e..cf2428b28 100644 --- a/documentation/providers/axfrddns.md +++ b/documentation/providers/axfrddns.md @@ -65,16 +65,16 @@ And update `creds.json` accordingly: {% code title="creds.json" %} ```json { - "axfrddns-a": { - "TYPE": "AXFRDDNS", - "transfer-key": "hmac-sha256:transfer-key-id:Base64EncodedSecret=", - "update-key": "hmac-sha256:update-key-id:AnotherSecret=" - }, - "axfrddns-b": { - "TYPE": "AXFRDDNS", - "transfer-key": "hmac-sha512:transfer-key-id-B:SmallSecret=", - "update-key": "hmac-sha512:update-key-id-B:YetAnotherSecret=" - } + "axfrddns-a": { + "TYPE": "AXFRDDNS", + "transfer-key": "hmac-sha256:transfer-key-id:Base64EncodedSecret=", + "update-key": "hmac-sha256:update-key-id:AnotherSecret=" + }, + "axfrddns-b": { + "TYPE": "AXFRDDNS", + "transfer-key": "hmac-sha512:transfer-key-id-B:SmallSecret=", + "update-key": "hmac-sha512:update-key-id-B:YetAnotherSecret=" + } } ``` {% endcode %} diff --git a/documentation/providers/azure_dns.md b/documentation/providers/azure_dns.md index 8025c423d..e4523bce5 100644 --- a/documentation/providers/azure_dns.md +++ b/documentation/providers/azure_dns.md @@ -12,9 +12,9 @@ Example: "TYPE": "AZURE_DNS", "SubscriptionID": "AZURE_SUBSCRIPTION_ID", "ResourceGroup": "AZURE_RESOURCE_GROUP", - "TenantID": "AZURE_TENANT_ID" + "TenantID": "AZURE_TENANT_ID", "ClientID": "AZURE_CLIENT_ID", - "ClientSecret": "AZURE_CLIENT_SECRET", + "ClientSecret": "AZURE_CLIENT_SECRET" } } ``` @@ -38,8 +38,8 @@ export AZURE_CLIENT_SECRET=BBBBBBBBB "SubscriptionID": "$AZURE_SUBSCRIPTION_ID", "ResourceGroup": "$AZURE_RESOURCE_GROUP", "ClientID": "$AZURE_CLIENT_ID", - "TenantID": "$AZURE_TENANT_ID" - "ClientSecret": "$AZURE_CLIENT_SECRET", + "TenantID": "$AZURE_TENANT_ID", + "ClientSecret": "$AZURE_CLIENT_SECRET" } } ``` diff --git a/documentation/providers/dnsmadeeasy.md b/documentation/providers/dnsmadeeasy.md index c8531c217..5e3d71339 100644 --- a/documentation/providers/dnsmadeeasy.md +++ b/documentation/providers/dnsmadeeasy.md @@ -9,7 +9,7 @@ Example: ```json { "dnsmadeeasy": { - "TYPE_key": "DNSMADEEASY", + "TYPE": "DNSMADEEASY", "api_key": "1c1a3c91-4770-4ce7-96f4-54c0eb0e457a", "secret_key": "e2268cde-2ccd-4668-a518-8aa8757a65a0" } diff --git a/documentation/providers/hedns.md b/documentation/providers/hedns.md index 4124ac100..5a11f5afe 100644 --- a/documentation/providers/hedns.md +++ b/documentation/providers/hedns.md @@ -15,8 +15,8 @@ and password used to log in to the [web interface](https://dns.he.net). { "hedns": { "TYPE": "HEDNS", - "password": "yourPassword", - "username": "yourUsername" + "username": "yourUsername", + "password": "yourPassword" } } ``` @@ -32,9 +32,9 @@ This can also be done via an environment variable: { "hedns": { "TYPE": "HEDNS", + "username": "yourUsername", "password": "yourPassword", - "totp": "$HEDNS_TOTP", - "username": "yourUsername" + "totp": "$HEDNS_TOTP" } } ``` @@ -58,7 +58,8 @@ only available when first enabling two-factor authentication. {% code title="creds.json" %} ```json { - "hedns":{ + "hedns": { + "TYPE": "HEDNS", "username": "yourUsername", "password": "yourPassword", "totp-key": "yourTOTPSharedSecret" @@ -87,10 +88,11 @@ This option is disabled by default when this key is not present, {% code title="creds.json" %} ```json { - "hedns":{ + "hedns": { + "TYPE": "HEDNS", "username": "yourUsername", "password": "yourPassword", - "totp-key": "yourTOTPSharedSecret" + "totp-key": "yourTOTPSharedSecret", "session-file-path": "." } } diff --git a/documentation/providers/hexonet.md b/documentation/providers/hexonet.md index a17425c2b..31fb7703e 100644 --- a/documentation/providers/hexonet.md +++ b/documentation/providers/hexonet.md @@ -39,7 +39,7 @@ Here a working example for our OT&E System: "apilogin": "test.user", "apipassword": "test.passw0rd", "apientity": "OTE", - "debugmode": "0", + "debugmode": "0" } } ``` diff --git a/documentation/providers/inwx.md b/documentation/providers/inwx.md index 78844cc02..b447fc620 100644 --- a/documentation/providers/inwx.md +++ b/documentation/providers/inwx.md @@ -38,9 +38,9 @@ This can also be done via an environment variable: { "inwx": { "TYPE": "INWX", + "username": "yourUsername", "password": "yourPassword", - "totp": "$INWX_TOTP", - "username": "yourUsername" + "totp": "$INWX_TOTP" } } ``` @@ -64,9 +64,9 @@ This secret is only shown once when two factor authentication is enabled and you { "inwx": { "TYPE": "INWX", + "username": "yourUsername", "password": "yourPassword", - "totp-key": "yourTOTPSharedSecret", - "username": "yourUsername" + "totp-key": "yourTOTPSharedSecret" } } ``` @@ -79,7 +79,8 @@ redirect all requests to the sandbox API instead: {% code title="creds.json" %} ```json { - "inwx":{ + "inwx": { + "TYPE": "INWX", "username": "yourUsername", "password": "yourPassword", "sandbox": "1" diff --git a/documentation/providers/route53.md b/documentation/providers/route53.md index 6f8c4817d..0227cde2f 100644 --- a/documentation/providers/route53.md +++ b/documentation/providers/route53.md @@ -31,9 +31,9 @@ export AWS_SESSION_TOKEN=ZZZZZZZZ ```json { "r53_main": { + "TYPE": "ROUTE53", "KeyId": "$AWS_ACCESS_KEY_ID", - "SecretKey": "$AWS_SECRET_ACCESS_KEY", - "TYPE": "ROUTE53" + "SecretKey": "$AWS_SECRET_ACCESS_KEY" } } ```