Browse Source

Update DNS API readme

Armando Lüscher 8 years ago
parent
commit
d20831e41a
1 changed files with 54 additions and 75 deletions
  1. 54 75
      dnsapi/README.md

+ 54 - 75
dnsapi/README.md

@@ -1,99 +1,80 @@
-# How to use dns api
+# How to use DNS API
 
 
-## 1. Use CloudFlare domain api to automatically issue cert
+## 1. Use CloudFlare domain API to automatically issue cert
 
 
-For now, we support clourflare integeration.
-
-First you need to login to your clourflare account to get your api key.
+First you need to login to your CloudFlare account to get your API key.
 
 
 ```
 ```
 export CF_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
 export CF_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
-
 export CF_Email="xxxx@sss.com"
 export CF_Email="xxxx@sss.com"
-
 ```
 ```
 
 
-Ok, let's issue cert now:
+Ok, let's issue a cert now:
 ```
 ```
-acme.sh   --issue   --dns dns_cf   -d example.com  -d www.example.com
+acme.sh --issue --dns dns_cf -d example.com -d www.example.com
 ```
 ```
 
 
-The `CF_Key` and `CF_Email`  will be saved in `~/.acme.sh/account.conf`, when next time you use cloudflare api, it will reuse this key.
-
+The `CF_Key` and `CF_Email` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
 
 
 
 
-## 2. Use Dnspod.cn domain api to automatically issue cert
+## 2. Use DNSPod.cn domain API to automatically issue cert
 
 
-For now, we support dnspod.cn integeration.
-
-First you need to login to your dnspod.cn account to get your api key and key id.
+First you need to login to your DNSPod account to get your API Key and ID.
 
 
 ```
 ```
 export DP_Id="1234"
 export DP_Id="1234"
-
 export DP_Key="sADDsdasdgdsf"
 export DP_Key="sADDsdasdgdsf"
-
 ```
 ```
 
 
-Ok, let's issue cert now:
+Ok, let's issue a cert now:
 ```
 ```
-acme.sh   --issue   --dns dns_dp   -d example.com  -d www.example.com
+acme.sh --issue --dns dns_dp -d example.com -d www.example.com
 ```
 ```
 
 
-The `DP_Id` and `DP_Key`  will be saved in `~/.acme.sh/account.conf`, when next time you use dnspod.cn api, it will reuse this key.
-
+The `DP_Id` and `DP_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
 
 
-## 3. Use Cloudxns.com domain api to automatically issue cert
 
 
-For now, we support Cloudxns.com integeration.
+## 3. Use CloudXNS.com domain API to automatically issue cert
 
 
-First you need to login to your Cloudxns.com account to get your api key and key secret.
+First you need to login to your CloudXNS account to get your API Key and Secret.
 
 
 ```
 ```
 export CX_Key="1234"
 export CX_Key="1234"
-
 export CX_Secret="sADDsdasdgdsf"
 export CX_Secret="sADDsdasdgdsf"
-
 ```
 ```
 
 
-Ok, let's issue cert now:
+Ok, let's issue a cert now:
 ```
 ```
-acme.sh   --issue   --dns dns_cx   -d example.com  -d www.example.com
+acme.sh --issue --dns dns_cx -d example.com -d www.example.com
 ```
 ```
 
 
-The `CX_Key` and `CX_Secret`  will be saved in `~/.acme.sh/account.conf`, when next time you use Cloudxns.com api, it will reuse this key.
+The `CX_Key` and `CX_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
 
 
 
 
-## 4. Use Godaddy.com domain api to automatically issue cert
+## 4. Use GoDaddy.com domain API to automatically issue cert
 
 
-We support Godaddy integration.
-
-First you need to login to your Godaddy account to get your api key and api secret.
+First you need to login to your GoDaddy account to get your API Key and Secret.
 
 
 https://developer.godaddy.com/keys/
 https://developer.godaddy.com/keys/
 
 
-Please Create a Production key, instead of a Test key.
-
+Please create a Production key, instead of a Test key.
 
 
 ```
 ```
 export GD_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
 export GD_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
-
 export GD_Secret="asdfsdafdsfdsfdsfdsfdsafd"
 export GD_Secret="asdfsdafdsfdsfdsfdsfdsafd"
-
 ```
 ```
 
 
-Ok, let's issue cert now:
+Ok, let's issue a cert now:
 ```
 ```
-acme.sh   --issue   --dns dns_gd   -d example.com  -d www.example.com
+acme.sh --issue --dns dns_gd -d example.com -d www.example.com
 ```
 ```
 
 
-The `GD_Key` and `GD_Secret`  will be saved in `~/.acme.sh/account.conf`, when next time you use cloudflare api, it will reuse this key.
+The `GD_Key` and `GD_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
 
 
-## 5. Use PowerDNS embedded api to automatically issue cert
 
 
-We support PowerDNS embedded API integration.
+## 5. Use PowerDNS embedded API to automatically issue cert
 
 
-First you need to enable api and set your api-token in PowerDNS configuration.
+First you need to login to your PowerDNS account to enable the API and set your API-Token in the configuration.
 
 
 https://doc.powerdns.com/md/httpapi/README/
 https://doc.powerdns.com/md/httpapi/README/
 
 
@@ -102,21 +83,21 @@ export PDNS_Url="http://ns.example.com:8081"
 export PDNS_ServerId="localhost"
 export PDNS_ServerId="localhost"
 export PDNS_Token="0123456789ABCDEF"
 export PDNS_Token="0123456789ABCDEF"
 export PDNS_Ttl=60
 export PDNS_Ttl=60
-
 ```
 ```
 
 
-Ok, let's issue cert now:
+Ok, let's issue a cert now:
 ```
 ```
-acme.sh   --issue   --dns dns_pdns   -d example.com  -d www.example.com
+acme.sh --issue --dns dns_pdns -d example.com -d www.example.com
 ```
 ```
 
 
-The `PDNS_Url`, `PDNS_ServerId`, `PDNS_Token` and `PDNS_Ttl` will be saved in `~/.acme.sh/account.conf`.
+The `PDNS_Url`, `PDNS_ServerId`, `PDNS_Token` and `PDNS_Ttl` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
 
 
 
 
-## 6. Use OVH/kimsufi/soyoustart/runabove API
+## 6. Use OVH/kimsufi/soyoustart/runabove API to automatically issue cert
 
 
 https://github.com/Neilpang/acme.sh/wiki/How-to-use-OVH-domain-api
 https://github.com/Neilpang/acme.sh/wiki/How-to-use-OVH-domain-api
 
 
+
 ## 7. Use nsupdate to automatically issue cert
 ## 7. Use nsupdate to automatically issue cert
 
 
 First, generate a key for updating the zone
 First, generate a key for updating the zone
@@ -137,6 +118,7 @@ include "/etc/named/keys/update.key";
 ```
 ```
 
 
 Next, configure your zone to allow dynamic updates.
 Next, configure your zone to allow dynamic updates.
+
 Depending on your named version, use either
 Depending on your named version, use either
 ```
 ```
 zone "example.com" {
 zone "example.com" {
@@ -153,18 +135,21 @@ zone "example.com" {
     };
     };
 }
 }
 ```
 ```
-Finally, make the dns server and update key available to `acme.sh`
+
+Finally, make the DNS server and update Key available to `acme.sh`
+
 ```
 ```
-export NSUPDATE_SERVER=dns.example.com
-export NSUPDATE_KEY=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa==
+export NSUPDATE_SERVER="dns.example.com"
+export NSUPDATE_KEY="aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa=="
 ```
 ```
 
 
-Ok, let's issue cert now:
+Ok, let's issue a cert now:
 ```
 ```
-acme.sh   --issue   --dns dns_nsupdate   -d example.com  -d www.example.com
+acme.sh --issue --dns dns_nsupdate -d example.com -d www.example.com
 ```
 ```
 
 
-The `NSUPDATE_SERVER` and `NSUPDATE_KEY` settings will be saved in `~/.acme.sh/account.conf`.
+The `NSUPDATE_SERVER` and `NSUPDATE_KEY` settings will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
+
 
 
 ## 8. Use LuaDNS domain API
 ## 8. Use LuaDNS domain API
 
 
@@ -172,17 +157,16 @@ Get your API token at https://api.luadns.com/settings
 
 
 ```
 ```
 export LUA_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
 export LUA_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
-
 export LUA_Email="xxxx@sss.com"
 export LUA_Email="xxxx@sss.com"
-
 ```
 ```
 
 
 To issue a cert:
 To issue a cert:
 ```
 ```
-acme.sh   --issue   --dns dns_lua --dnssleep 3  -d example.com  -d www.example.com
+acme.sh --issue --dns dns_lua -d example.com -d www.example.com
 ```
 ```
 
 
-The `LUA_Key` and `LUA_Email`  will be saved in `~/.acme.sh/account.conf`, and will be reused when needed.
+The `LUA_Key` and `LUA_Email` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
+
 
 
 ## 9. Use DNSMadeEasy domain API
 ## 9. Use DNSMadeEasy domain API
 
 
@@ -190,39 +174,34 @@ Get your API credentials at https://cp.dnsmadeeasy.com/account/info
 
 
 ```
 ```
 export ME_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
 export ME_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
-
 export ME_Secret="qdfqsdfkjdskfj"
 export ME_Secret="qdfqsdfkjdskfj"
-
 ```
 ```
 
 
 To issue a cert:
 To issue a cert:
 ```
 ```
-acme.sh   --issue   --dns dns_me --dnssleep 3  -d example.com  -d www.example.com
+acme.sh --issue --dns dns_me -d example.com -d www.example.com
 ```
 ```
 
 
-The `ME_Key` and `ME_Secret`  will be saved in `~/.acme.sh/account.conf`, and will be reused when needed.
+The `ME_Key` and `ME_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
+
 
 
-# 10. Use custom api
+# 10. Use custom API
 
 
-If your api is not supported yet,  you can write your own dns api.
+If your API is not supported yet, you can write your own DNS API.
 
 
-Let's assume you want to name it 'myapi',
+Let's assume you want to name it 'myapi':
 
 
-1. Create a bash script named  `~/.acme.sh/dns_myapi.sh`,
-2. In the script, you must have a function named `dns_myapi_add()`. Which will be called by acme.sh to add dns records.
-3. Then you can use your api to issue cert like:
+1. Create a bash script named `~/.acme.sh/dns_myapi.sh`,
+2. In the script you must have a function named `dns_myapi_add()` which will be called by acme.sh to add the DNS records.
+3. Then you can use your API to issue cert like this:
 
 
 ```
 ```
-acme.sh  --issue  --dns  dns_myapi  -d example.com  -d www.example.com
+acme.sh --issue --dns dns_myapi -d example.com -d www.example.com
 ```
 ```
 
 
 For more details, please check our sample script: [dns_myapi.sh](dns_myapi.sh)
 For more details, please check our sample script: [dns_myapi.sh](dns_myapi.sh)
 
 
-# 11. Use lexicon dns api
-
-https://github.com/Neilpang/acme.sh/wiki/How-to-use-lexicon-dns-api
-
-
-
 
 
+## 11. Use lexicon DNS API
 
 
+https://github.com/Neilpang/acme.sh/wiki/How-to-use-lexicon-dns-api