You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

960 lines
28 KiB

8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
  1. How to use DNS API
  2. ==================
  3. 1. [Use CloudFlare domain API to automatically issue cert](#use-cloudflare-domain-api-to-automatically-issue-cert)
  4. 2. [Use DNSPod.cn domain API to automatically issue cert](#use-dnspodcn-domain-api-to-automatically-issue-cert)
  5. 3. [Use CloudXNS.com domain API to automatically issue cert](#use-cloudxnscom-domain-api-to-automatically-issue-cert)
  6. 4. [Use GoDaddy.com domain API to automatically issue cert](#use-godaddycom-domain-api-to-automatically-issue-cert)
  7. 5. [Use PowerDNS embedded API to automatically issue cert](#use-powerdns-embedded-api-to-automatically-issue-cert)
  8. 6. [Use OVH/kimsufi/soyoustart/runabove API to automatically issue cert](#use-ovhkimsufisoyoustartrunabove-api-to-automatically-issue-cert)
  9. 7. [Use nsupdate to automatically issue cert](#use-nsupdate-to-automatically-issue-cert)
  10. 8. [Use LuaDNS domain API](#use-luadns-domain-api)
  11. 9. [Use DNSMadeEasy domain API](#use-dnsmadeeasy-domain-api)
  12. 10. [Use Amazon Route53 domain API](#use-amazon-route53-domain-api)
  13. 11. [Use Aliyun domain API to automatically issue cert](#use-aliyun-domain-api-to-automatically-issue-cert)
  14. 12. [Use ISPConfig 3.1 API](#use-ispconfig-31-api)
  15. 13. [Use Alwaysdata domain API](#use-alwaysdata-domain-api)
  16. 14. [Use Linode domain API](#use-linode-domain-api)
  17. 15. [Use FreeDNS](#use-freedns)
  18. 16. [Use cyon.ch](#use-cyonch)
  19. 17. [Use Domain-Offensive/Resellerinterface/Domainrobot API](#use-domain-offensiveresellerinterfacedomainrobot-api)
  20. 18. [Use Gandi LiveDNS API](#use-gandi-livedns-api)
  21. 19. [Use Knot (knsupdate) DNS API to automatically issue cert](#use-knot-knsupdate-dns-api-to-automatically-issue-cert)
  22. 20. [Use DigitalOcean API (native)](#use-digitalocean-api-native)
  23. 21. [Use ClouDNS.net API](#use-cloudnsnet-api)
  24. 22. [Use Infoblox API](#use-infoblox-api)
  25. 23. [Use VSCALE API](#use-vscale-api)
  26. 24. [Use Dynu API](#use-dynu-api)
  27. 25. [Use DNSimple API](#use-dnsimple-api)
  28. 26. [Use NS1.com API](#use-ns1com-api)
  29. 27. [Use DuckDNS.org API](#use-duckdnsorg-api)
  30. 28. [Use Name.com API](#use-namecom-api)
  31. 29. [Use Dyn Managed DNS API to automatically issue cert](#use-dyn-managed-dns-api-to-automatically-issue-cert)
  32. 30. [Use pdd.yandex.ru API](#use-pddyandexru-api)
  33. 31. [Use Hurricane Electric](#use-hurricane-electric)
  34. 32. [Use UnoEuro API to automatically issue cert](#use-unoeuro-api-to-automatically-issue-cert)
  35. 33. [Use INWX](#use-inwx)
  36. 34. [Use Servercow API v1](#use-servercow-api-v1)
  37. 35. [Use Namesilo.com API](#use-namesilocom-api)
  38. 36. [Use autoDNS (InternetX)](#use-autodns-internetx)
  39. 37. [Use Azure DNS](#use-azure-dns)
  40. 38. [Use selectel.com (selectel.ru) domain API to automatically issue cert](#use-selectelcom-selectelru-domain-api-to-automatically-issue-cert)
  41. 39. [Use zonomi.com domain API to automatically issue cert](#use-zonomicom-domain-api-to-automatically-issue-cert)
  42. 40. [Use DreamHost DNS API](#use-dreamhost-dns-api)
  43. 41. [Use DirectAdmin API](#use-directadmin-api)
  44. 42. [Use KingHost DNS API](#use-kinghost-dns-api)
  45. 43. [Use Zilore DNS API](#use-zilore-dns-api)
  46. 44. [Use Loopia.se API](#use-loopiase-api)
  47. 45. [Use ACME DNS API](#use-acme-dns-api)
  48. Use a custom API
  49. ================
  50. If your API is not supported yet, you can write your own DNS API.
  51. Let's assume you want to name it `myapi`:
  52. 1. Create a bash script named `~/.acme.sh/dns_myapi.sh`.
  53. 2. In the script, you must have a function named `dns_myapi_add()`
  54. which will be called by acme.sh to add the DNS records.
  55. 3. Then you can use your API to issue cert like this:
  56. acme.sh --issue --dns dns_myapi -d example.com -d www.example.com
  57. For more details, please check our sample script: [dns_myapi.sh](dns_myapi.sh)
  58. See: https://github.com/Neilpang/acme.sh/wiki/DNS-API-Dev-Guide
  59. Use lexicon DNS API
  60. ===================
  61. https://github.com/Neilpang/acme.sh/wiki/How-to-use-lexicon-dns-api
  62. ------------------------------------------------------------------------
  63. Use CloudFlare domain API to automatically issue cert
  64. -----------------------------------------------------
  65. First you need to login to your CloudFlare account to get your API key.
  66. export CF_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
  67. export CF_Email="xxxx@sss.com"
  68. OK, let's issue a cert now:
  69. acme.sh --issue --dns dns_cf -d example.com -d www.example.com
  70. The `CF_Key` and `CF_Email` will be saved in `~/.acme.sh/account.conf`
  71. and will be reused when needed.
  72. Use DNSPod.cn domain API to automatically issue cert
  73. ----------------------------------------------------
  74. First you need to login to your DNSPod account to get your API Key and
  75. ID.
  76. export DP_Id="1234"
  77. export DP_Key="sADDsdasdgdsf"
  78. OK, let's issue a cert now:
  79. acme.sh --issue --dns dns_dp -d example.com -d www.example.com
  80. The `DP_Id` and `DP_Key` will be saved in `~/.acme.sh/account.conf` and
  81. will be reused when needed.
  82. Use CloudXNS.com domain API to automatically issue cert
  83. -------------------------------------------------------
  84. First you need to login to your CloudXNS account to get your API Key and
  85. Secret.
  86. export CX_Key="1234"
  87. export CX_Secret="sADDsdasdgdsf"
  88. OK, let's issue a cert now:
  89. acme.sh --issue --dns dns_cx -d example.com -d www.example.com
  90. The `CX_Key` and `CX_Secret` will be saved in `~/.acme.sh/account.conf`
  91. and will be reused when needed.
  92. Use GoDaddy.com domain API to automatically issue cert
  93. ------------------------------------------------------
  94. First you need to login to your GoDaddy account to get your API Key and
  95. Secret.
  96. https://developer.godaddy.com/keys/
  97. Please create a Production key, instead of a Test key.
  98. export GD_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
  99. export GD_Secret="asdfsdafdsfdsfdsfdsfdsafd"
  100. OK, let's issue a cert now:
  101. acme.sh --issue --dns dns_gd -d example.com -d www.example.com
  102. The `GD_Key` and `GD_Secret` will be saved in `~/.acme.sh/account.conf`
  103. and will be reused when needed.
  104. Use PowerDNS embedded API to automatically issue cert
  105. -----------------------------------------------------
  106. First you need to login to your PowerDNS account to enable the API and
  107. set your API-Token in the configuration.
  108. https://doc.powerdns.com/md/httpapi/README/
  109. export PDNS_Url="http://ns.example.com:8081"
  110. export PDNS_ServerId="localhost"
  111. export PDNS_Token="0123456789ABCDEF"
  112. export PDNS_Ttl=60
  113. OK, let's issue a cert now:
  114. acme.sh --issue --dns dns_pdns -d example.com -d www.example.com
  115. The `PDNS_Url`, `PDNS_ServerId`, `PDNS_Token` and `PDNS_Ttl` will be
  116. saved in `~/.acme.sh/account.conf` and will be reused when needed.
  117. Use OVH/kimsufi/soyoustart/runabove API to automatically issue cert
  118. -------------------------------------------------------------------
  119. https://github.com/Neilpang/acme.sh/wiki/How-to-use-OVH-domain-api
  120. Use nsupdate to automatically issue cert
  121. ----------------------------------------
  122. First, generate a key for updating the zone
  123. b=$(dnssec-keygen -a hmac-sha512 -b 512 -n USER -K /tmp foo)
  124. cat > /etc/named/keys/update.key <<EOF
  125. key "update" {
  126. algorithm hmac-sha512;
  127. secret "$(awk '/^Key/{print $2}' /tmp/$b.private)";
  128. };
  129. EOF
  130. rm -f /tmp/$b.{private,key}
  131. Include this key in your named configuration
  132. include "/etc/named/keys/update.key";
  133. Next, configure your zone to allow dynamic updates.
  134. Depending on your named version, use either
  135. zone "example.com" {
  136. type master;
  137. allow-update { key "update"; };
  138. };
  139. or
  140. zone "example.com" {
  141. type master;
  142. update-policy {
  143. grant update subdomain example.com.;
  144. };
  145. }
  146. Finally, make the DNS server and update Key available to `acme.sh`
  147. export NSUPDATE_SERVER="dns.example.com"
  148. export NSUPDATE_KEY="/path/to/your/nsupdate.key"
  149. OK, let's issue a cert now:
  150. acme.sh --issue --dns dns_nsupdate -d example.com -d www.example.com
  151. The `NSUPDATE_SERVER` and `NSUPDATE_KEY` settings will be saved in
  152. `~/.acme.sh/account.conf` and will be reused when needed.
  153. Use LuaDNS domain API
  154. ---------------------
  155. Get your API token at https://api.luadns.com/settings
  156. export LUA_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
  157. export LUA_Email="xxxx@sss.com"
  158. OK, let's issue a cert now:
  159. acme.sh --issue --dns dns_lua -d example.com -d www.example.com
  160. The `LUA_Key` and `LUA_Email` will be saved in `~/.acme.sh/account.conf`
  161. and will be reused when needed.
  162. Use DNSMadeEasy domain API
  163. --------------------------
  164. Get your API credentials at https://cp.dnsmadeeasy.com/account/info
  165. export ME_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
  166. export ME_Secret="qdfqsdfkjdskfj"
  167. OK, let's issue a cert now:
  168. acme.sh --issue --dns dns_me -d example.com -d www.example.com
  169. The `ME_Key` and `ME_Secret` will be saved in `~/.acme.sh/account.conf`
  170. and will be reused when needed.
  171. Use Amazon Route53 domain API
  172. -----------------------------
  173. https://github.com/Neilpang/acme.sh/wiki/How-to-use-Amazon-Route53-API
  174. export AWS_ACCESS_KEY_ID=XXXXXXXXXX
  175. export AWS_SECRET_ACCESS_KEY=XXXXXXXXXXXXXXX
  176. OK, let's issue a cert now:
  177. acme.sh --issue --dns dns_aws -d example.com -d www.example.com
  178. The `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` will be saved in
  179. `~/.acme.sh/account.conf` and will be reused when needed.
  180. Use Aliyun domain API to automatically issue cert
  181. -------------------------------------------------
  182. First you need to login to your Aliyun account to get your API key.
  183. https://ak-console.aliyun.com/#/accesskey
  184. export Ali_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
  185. export Ali_Secret="jlsdflanljkljlfdsaklkjflsa"
  186. OK, let's issue a cert now:
  187. acme.sh --issue --dns dns_ali -d example.com -d www.example.com
  188. The `Ali_Key` and `Ali_Secret` will be saved in
  189. `~/.acme.sh/account.conf` and will be reused when needed.
  190. Use ISPConfig 3.1 API
  191. ---------------------
  192. This only works for ISPConfig 3.1 (and newer).
  193. Create a Remote User in the ISPConfig Control Panel. The Remote User
  194. must have access to at least `DNS zone functions` and `DNS txt
  195. functions`.
  196. export ISPC_User="xxx"
  197. export ISPC_Password="xxx"
  198. export ISPC_Api="https://ispc.domain.tld:8080/remote/json.php"
  199. export ISPC_Api_Insecure=1
  200. If you have installed ISPConfig on a different port, then alter the
  201. `8080` accordingly. Leave `ISPC_Api_Insecure` set to `1` if you do not
  202. have a valid SSL cert for your installation. Change it to `0` if you
  203. have a valid SSL cert.
  204. OK, let's issue a cert now:
  205. acme.sh --issue --dns dns_ispconfig -d example.com -d www.example.com
  206. The `ISPC_User`, `ISPC_Password`, `ISPC_Api`and `ISPC_Api_Insecure` will
  207. be saved in `~/.acme.sh/account.conf` and will be reused when needed.
  208. Use Alwaysdata domain API
  209. -------------------------
  210. First you need to login to your Alwaysdata account to get your API Key.
  211. export AD_API_KEY="myalwaysdataapikey"
  212. OK, let's issue a cert now:
  213. acme.sh --issue --dns dns_ad -d example.com -d www.example.com
  214. The `AD_API_KEY` will be saved in `~/.acme.sh/account.conf` and will be
  215. reused when needed.
  216. Use Linode domain API
  217. ---------------------
  218. First you need to login to your Linode account to get your API Key.
  219. https://manager.linode.com/profile/api
  220. Then add an API key with label _ACME_ and copy the new key.
  221. export LINODE_API_KEY="..."
  222. Due to the reload time of any changes in the DNS records, we have to use
  223. the `dnssleep` option to wait at least 15 minutes for the changes to
  224. take effect.
  225. OK, let's issue a cert now:
  226. acme.sh --issue --dns dns_linode --dnssleep 900 -d example.com -d www.example.com
  227. The `LINODE_API_KEY` will be saved in `~/.acme.sh/account.conf` and will
  228. be reused when needed.
  229. Use FreeDNS
  230. -----------
  231. FreeDNS (https://freedns.afraid.org/) does not provide an API to update
  232. DNS records (other than IPv4 and IPv6 dynamic DNS addresses). The
  233. acme.sh plugin therefore retrieves and updates domain TXT records by
  234. logging into the FreeDNS website to read the HTML and posting updates as
  235. HTTP. The plugin needs to know your userid and password for the FreeDNS
  236. website.
  237. export FREEDNS_User="..."
  238. export FREEDNS_Password="..."
  239. You only need to provide this the first time you run the acme.sh client
  240. with FreeDNS validation and then again whenever you change your password
  241. at the FreeDNS site. The acme.sh FreeDNS plugin does not store your
  242. userid or password but rather saves an authentication token returned by
  243. FreeDNS in `~/.acme.sh/account.conf` and reuses that when needed.
  244. OK, let's issue a cert now:
  245. acme.sh --issue --dns dns_freedns -d example.com -d www.example.com
  246. Note that you cannot use acme.sh automatic DNS validation for FreeDNS
  247. public domains or for a subdomain that you create under a FreeDNS public
  248. domain. You must own the top level domain in order to automatically
  249. validate with acme.sh at FreeDNS.
  250. Use cyon.ch
  251. -----------
  252. You only need to set your cyon.ch login credentials. If you also have 2
  253. Factor Authentication (OTP) enabled, you need to set your secret token
  254. too and have `oathtool` installed.
  255. export CY_Username="your_cyon_username"
  256. export CY_Password="your_cyon_password"
  257. export CY_OTP_Secret="your_otp_secret" # Only required if using 2FA
  258. OK, let's issue a cert now:
  259. acme.sh --issue --dns dns_cyon -d example.com -d www.example.com
  260. The `CY_Username`, `CY_Password` and `CY_OTP_Secret` will be saved in
  261. `~/.acme.sh/account.conf` and will be reused when needed.
  262. Use Domain-Offensive/Resellerinterface/Domainrobot API
  263. ------------------------------------------------------
  264. ATTENTION: You need to be a registered Reseller to be able to use the
  265. ResellerInterface. As a normal user you can not use this method.
  266. You will need your login credentials (Partner ID+Password) to the
  267. Resellerinterface, and export them before you run `acme.sh`:
  268. export DO_PID="KD-1234567"
  269. export DO_PW="cdfkjl3n2"
  270. OK, let's issue a cert now:
  271. acme.sh --issue --dns dns_do -d example.com -d www.example.com
  272. Use Gandi LiveDNS API
  273. ---------------------
  274. You must enable the new Gandi LiveDNS API first and the create your API
  275. key, See: http://doc.livedns.gandi.net/
  276. export GANDI_LIVEDNS_KEY="fdmlfsdklmfdkmqsdfk"
  277. OK, let's issue a cert now:
  278. acme.sh --issue --dns dns_gandi_livedns -d example.com -d www.example.com
  279. Use Knot (knsupdate) DNS API to automatically issue cert
  280. --------------------------------------------------------
  281. First, generate a TSIG key for updating the zone.
  282. keymgr tsig generate -t acme_key hmac-sha512 > /etc/knot/acme.key
  283. Include this key in your knot configuration file.
  284. include: /etc/knot/acme.key
  285. Next, configure your zone to allow dynamic updates.
  286. Dynamic updates for the zone are allowed via proper ACL rule with the
  287. `update` action. For in-depth instructions, please see [Knot DNS's
  288. documentation](https://www.knot-dns.cz/documentation/).
  289. acl:
  290. - id: acme_acl
  291. address: 192.168.1.0/24
  292. key: acme_key
  293. action: update
  294. zone:
  295. - domain: example.com
  296. file: example.com.zone
  297. acl: acme_acl
  298. Finally, make the DNS server and TSIG Key available to `acme.sh`
  299. export KNOT_SERVER="dns.example.com"
  300. export KNOT_KEY=`grep \# /etc/knot/acme.key | cut -d' ' -f2`
  301. OK, let's issue a cert now:
  302. acme.sh --issue --dns dns_knot -d example.com -d www.example.com
  303. The `KNOT_SERVER` and `KNOT_KEY` settings will be saved in
  304. `~/.acme.sh/account.conf` and will be reused when needed.
  305. Use DigitalOcean API (native)
  306. -----------------------------
  307. You need to obtain a read and write capable API key from your
  308. DigitalOcean account. See: https://www.digitalocean.com/help/api/
  309. export DO_API_KEY="75310dc4ca779ac39a19f6355db573b49ce92ae126553ebd61ac3a3ae34834cc"
  310. OK, let's issue a cert now:
  311. acme.sh --issue --dns dns_dgon -d example.com -d www.example.com
  312. Use ClouDNS.net API
  313. -------------------
  314. You need to set the HTTP API user ID and password credentials. See:
  315. https://www.cloudns.net/wiki/article/42/. For security reasons, it's
  316. recommended to use a sub user ID that only has access to the necessary
  317. zones, as a regular API user has access to your entire account.
  318. # Use this for a sub auth ID
  319. export CLOUDNS_SUB_AUTH_ID=XXXXX
  320. # Use this for a regular auth ID
  321. #export CLOUDNS_AUTH_ID=XXXXX
  322. export CLOUDNS_AUTH_PASSWORD="YYYYYYYYY"
  323. OK, let's issue a cert now:
  324. acme.sh --issue --dns dns_cloudns -d example.com -d www.example.com
  325. The `CLOUDNS_AUTH_ID` and `CLOUDNS_AUTH_PASSWORD` will be saved in
  326. `~/.acme.sh/account.conf` and will be reused when needed.
  327. Use Infoblox API
  328. ----------------
  329. First you need to create/obtain API credentials on your Infoblox
  330. appliance.
  331. export Infoblox_Creds="username:password"
  332. export Infoblox_Server="ip or fqdn of infoblox appliance"
  333. OK, let's issue a cert now:
  334. acme.sh --issue --dns dns_infoblox -d example.com -d www.example.com
  335. Note: This script will automatically create and delete the ephemeral TXT
  336. record. The `Infoblox_Creds` and `Infoblox_Server` will be saved in
  337. `~/.acme.sh/account.conf` and will be reused when needed.
  338. Use VSCALE API
  339. --------------
  340. First you need to create/obtain API tokens on your [settings
  341. panel](https://vscale.io/panel/settings/tokens/).
  342. VSCALE_API_KEY="sdfsdfsdfljlbjkljlkjsdfoiwje"
  343. OK, let's issue a cert now:
  344. acme.sh --issue --dns dns_vscale -d example.com -d www.example.com
  345. Use Dynu API
  346. ------------
  347. First you need to create/obtain API credentials from your Dynu account.
  348. See: https://www.dynu.com/resources/api/documentation
  349. export Dynu_ClientId="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  350. export Dynu_Secret="yyyyyyyyyyyyyyyyyyyyyyyyy"
  351. OK, let's issue a cert now:
  352. acme.sh --issue --dns dns_dynu -d example.com -d www.example.com
  353. The `Dynu_ClientId` and `Dynu_Secret` will be saved in
  354. `~/.acme.sh/account.conf` and will be reused when needed.
  355. Use DNSimple API
  356. ----------------
  357. First you need to login to your DNSimple account and generate a new
  358. oauth token.
  359. https://dnsimple.com/a/{your account id}/account/access_tokens
  360. Note that this is an _account_ token and not a user token. The account
  361. token is needed to infer the `account_id` used in requests. A user
  362. token will not be able to determine the correct account to use.
  363. export DNSimple_OAUTH_TOKEN="sdfsdfsdfljlbjkljlkjsdfoiwje"
  364. To issue the cert just specify the `dns_dnsimple` API.
  365. acme.sh --issue --dns dns_dnsimple -d example.com
  366. The `DNSimple_OAUTH_TOKEN` will be saved in `~/.acme.sh/account.conf`
  367. and will be reused when needed.
  368. If you have any issues with this integration please report them to
  369. https://github.com/pho3nixf1re/acme.sh/issues.
  370. Use NS1.com API
  371. ---------------
  372. export NS1_Key="fdmlfsdklmfdkmqsdfk"
  373. OK, let's issue a cert now:
  374. acme.sh --issue --dns dns_nsone -d example.com -d www.example.com
  375. Use DuckDNS.org API
  376. -------------------
  377. export DuckDNS_Token="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
  378. Please note that since DuckDNS uses StartSSL as their cert provider,
  379. thus `--insecure` may need to be used when issuing certs:
  380. acme.sh --insecure --issue --dns dns_duckdns -d mydomain.duckdns.org
  381. For issues, please report to https://github.com/raidenii/acme.sh/issues.
  382. Use Name.com API
  383. ----------------
  384. Create your API token here: https://www.name.com/account/settings/api
  385. Note: `Namecom_Username` should be your Name.com username and not the
  386. token name. If you accidentally run the script with the token name as
  387. the username see `~/.acme.sh/account.conf` to fix the issue
  388. export Namecom_Username="testuser"
  389. export Namecom_Token="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  390. And now you can issue certs with:
  391. acme.sh --issue --dns dns_namecom -d example.com -d www.example.com
  392. For issues, please report to https://github.com/raidenii/acme.sh/issues.
  393. Use Dyn Managed DNS API to automatically issue cert
  394. ---------------------------------------------------
  395. First, login to your Dyn Managed DNS account:
  396. https://portal.dynect.net/login/
  397. It is recommended to add a new user specific for API access.
  398. The minimum "Zones & Records Permissions" required are:
  399. RecordAdd
  400. RecordUpdate
  401. RecordDelete
  402. RecordGet
  403. ZoneGet
  404. ZoneAddNode
  405. ZoneRemoveNode
  406. ZonePublish
  407. Pass the API user credentials to the environment:
  408. export DYN_Customer="customer"
  409. export DYN_Username="apiuser"
  410. export DYN_Password="secret"
  411. OK, let's issue a cert now:
  412. acme.sh --issue --dns dns_dyn -d example.com -d www.example.com
  413. The `DYN_Customer`, `DYN_Username` and `DYN_Password` will be saved in
  414. `~/.acme.sh/account.conf` and will be reused when needed.
  415. Use pdd.yandex.ru API
  416. ---------------------
  417. Follow these instructions to get the token for your domain
  418. https://tech.yandex.com/domain/doc/concepts/access-docpage/
  419. export PDD_Token="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  420. OK, let's issue a cert now:
  421. acme.sh --issue --dns dns_yandex -d mydomain.example.org
  422. For issues, please report to https://github.com/non7top/acme.sh/issues.
  423. Use Hurricane Electric
  424. ----------------------
  425. Hurricane Electric (https://dns.he.net/) doesn't have an API so just set
  426. your login credentials like so:
  427. export HE_Username="yourusername"
  428. export HE_Password="password"
  429. OK, let's issue a cert now:
  430. acme.sh --issue --dns dns_he -d example.com -d www.example.com
  431. The `HE_Username` and `HE_Password` settings will be saved in
  432. `~/.acme.sh/account.conf` and will be reused when needed.
  433. Please report any issues to https://github.com/angel333/acme.sh or to
  434. <me@ondrejsimek.com>.
  435. Use UnoEuro API to automatically issue cert
  436. -------------------------------------------
  437. First you need to login to your UnoEuro account to get your API key.
  438. export UNO_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
  439. export UNO_User="UExxxxxx"
  440. OK, let's issue a cert now:
  441. acme.sh --issue --dns dns_unoeuro -d example.com -d www.example.com
  442. The `UNO_Key` and `UNO_User` will be saved in `~/.acme.sh/account.conf`
  443. and will be reused when needed.
  444. Use INWX
  445. --------
  446. [INWX](https://www.inwx.de/) offers an [xmlrpc
  447. api](https://www.inwx.de/de/help/apidoc) with your standard login
  448. credentials, set them like so:
  449. export INWX_User="yourusername"
  450. export INWX_Password="password"
  451. OK, let's issue a cert now:
  452. acme.sh --issue --dns dns_inwx -d example.com -d www.example.com
  453. The `INWX_User` and `INWX_Password` settings will be saved in
  454. `~/.acme.sh/account.conf` and will be reused when needed.
  455. If your account is secured by Mobile-TAN, you also have to define the
  456. shared secret:
  457. export INWX_Shared_Secret="shared secret"
  458. You may need to re-enable the Mobile-TAN to get the shared secret.
  459. Use Servercow API v1
  460. ---------------------
  461. Create a new user from the servercow control center. Don't forget to
  462. activate **DNS API** for this user.
  463. export SERVERCOW_API_Username=username
  464. export SERVERCOW_API_Password=password
  465. OK, let's issue a cert now:
  466. acme.sh --issue --dns dns_servercow -d example.com -d www.example.com
  467. Both, `SERVERCOW_API_Username` and `SERVERCOW_API_Password` will be
  468. saved in `~/.acme.sh/account.conf` and will be reused when needed.
  469. Use Namesilo.com API
  470. --------------------
  471. You'll need to generate an API key at
  472. https://www.namesilo.com/account_api.php Optionally you may restrict the
  473. access to an IP range there.
  474. export Namesilo_Key="xxxxxxxxxxxxxxxxxxxxxxxx"
  475. OK, let's issue a cert now:
  476. acme.sh --issue --dns dns_namesilo --dnssleep 900 -d example.com -d www.example.com
  477. Use autoDNS (InternetX)
  478. -----------------------
  479. [InternetX](https://www.internetx.com/) offers an [XML
  480. API](https://help.internetx.com/display/API/AutoDNS+XML-API) with your
  481. standard login credentials, set them like so:
  482. export AUTODNS_USER="yourusername"
  483. export AUTODNS_PASSWORD="password"
  484. export AUTODNS_CONTEXT="context"
  485. OK, let's issue a cert now:
  486. acme.sh --issue --dns dns_autodns -d example.com -d www.example.com
  487. The `AUTODNS_USER`, `AUTODNS_PASSWORD` and `AUTODNS_CONTEXT` settings
  488. will be saved in `~/.acme.sh/account.conf` and will be reused when
  489. needed.
  490. Use Azure DNS
  491. -------------
  492. You have to create a service principal first. See:[How to use Azure
  493. DNS](https://github.com/Neilpang/acme.sh/wiki/How-to-use-Azure-DNS)
  494. export AZUREDNS_SUBSCRIPTIONID="12345678-9abc-def0-1234-567890abcdef"
  495. export AZUREDNS_TENANTID="11111111-2222-3333-4444-555555555555"
  496. export AZUREDNS_APPID="3b5033b5-7a66-43a5-b3b9-a36b9e7c25ed"
  497. export AZUREDNS_CLIENTSECRET="1b0224ef-34d4-5af9-110f-77f527d561bd"
  498. OK, let's issue a cert now:
  499. acme.sh --issue --dns dns_azure -d example.com -d www.example.com
  500. `AZUREDNS_SUBSCRIPTIONID`, `AZUREDNS_TENANTID`, `AZUREDNS_APPID` and
  501. `AZUREDNS_CLIENTSECRET` settings will be saved in
  502. `~/.acme.sh/account.conf` and will be reused when needed.
  503. Use selectel.com (selectel.ru) domain API to automatically issue cert
  504. ---------------------------------------------------------------------
  505. First you need to login to your account to get your API key from:
  506. https://my.selectel.ru/profile/apikeys.
  507. export SL_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
  508. OK, let's issue a cert now:
  509. acme.sh --issue --dns dns_selectel -d example.com -d www.example.com
  510. The `SL_Key` will be saved in `~/.acme.sh/account.conf` and will be
  511. reused when needed.
  512. Use zonomi.com domain API to automatically issue cert
  513. -----------------------------------------------------
  514. First you need to login to your account to find your API key from:
  515. http://zonomi.com/app/dns/dyndns.jsp
  516. Your will find your api key in the example urls:
  517. https://zonomi.com/app/dns/dyndns.jsp?host=example.com&api_key=1063364558943540954358668888888888
  518. export ZM_Key="1063364558943540954358668888888888"
  519. OK, let's issue a cert now:
  520. acme.sh --issue --dns dns_zonomi -d example.com -d www.example.com
  521. The `ZM_Key` will be saved in `~/.acme.sh/account.conf` and will be
  522. reused when needed.
  523. Use DreamHost DNS API
  524. ---------------------
  525. DNS API keys may be created at
  526. https://panel.dreamhost.com/?tree=home.api. Ensure the created key has
  527. add and remove privileges.
  528. export DH_API_KEY="<api key>"
  529. OK, let's issue a cert now:
  530. acme.sh --issue --dns dns_dreamhost -d example.com -d www.example.com
  531. The 'DH_API_KEY' will be saved in `~/.acme.sh/account.conf` and will
  532. be reused when needed.
  533. Use DirectAdmin API
  534. -------------------
  535. The DirectAdmin interface has it's own Let's Encrypt functionality, but
  536. this script can be used to generate certificates for names which are not
  537. hosted on DirectAdmin.
  538. User must provide login data and URL to the DirectAdmin incl. port.
  539. You can create an user which only has access to
  540. - `CMD_API_DNS_CONTROL`
  541. - `CMD_API_SHOW_DOMAINS`
  542. By using the Login Keys function. See also
  543. https://www.directadmin.com/api.php and
  544. https://www.directadmin.com/features.php?id=1298
  545. export DA_Api="https://remoteUser:remotePassword@da.domain.tld:8443"
  546. export DA_Api_Insecure=1
  547. Set `DA_Api_Insecure` to `1` for insecure and `0` for secure ->
  548. difference is whether SSL cert is checked for validity (`0`) or whether
  549. it is just accepted (`1`).
  550. OK, let's issue a cert now:
  551. acme.sh --issue --dns dns_da -d example.com -d www.example.com
  552. The `DA_Api` and `DA_Api_Insecure` will be saved in
  553. `~/.acme.sh/account.conf` and will be reused when needed.
  554. Use KingHost DNS API
  555. --------------------
  556. API access must be enabled at
  557. https://painel.kinghost.com.br/painel.api.php
  558. export KINGHOST_Username="yourusername"
  559. export KINGHOST_Password="yourpassword"
  560. OK, let's issue a cert now:
  561. acme.sh --issue --dns dns_kinghost -d example.com -d *.example.com
  562. The `KINGHOST_username` and `KINGHOST_Password` will be saved in
  563. `~/.acme.sh/account.conf` and will be reused when needed.
  564. Use Zilore DNS API
  565. ------------------
  566. First, get your API key at https://my.zilore.com/account/api
  567. export Zilore_Key="5dcad3a2-36cb-50e8-cb92-000002f9"
  568. OK, let's issue a cert now:
  569. acme.sh --issue --dns dns_zilore -d example.com -d *.example.com
  570. The `Zilore_Key` will be saved in `~/.acme.sh/account.conf` and will be
  571. reused when needed.
  572. Use Loopia.se API
  573. -----------------
  574. User must provide login credentials to the Loopia API. The user needs
  575. the following permissions:
  576. - `addSubdomain`
  577. - `updateZoneRecord`
  578. - `getDomains`
  579. - `removeSubdomain`
  580. Set the login credentials:
  581. export LOOPIA_User="user@loopiaapi"
  582. export LOOPIA_Password="password"
  583. OK, let's issue a cert now:
  584. acme.sh --issue --dns dns_loopia -d example.com -d *.example.com
  585. The username and password will be saved in `~/.acme.sh/account.conf` and
  586. will be reused when needed.
  587. Use ACME DNS API
  588. ----------------
  589. ACME DNS is a limited DNS server with RESTful HTTP API to handle ACME
  590. DNS challenges easily and securely. https://github.com/joohoi/acme-dns
  591. export ACMEDNS_UPDATE_URL="https://auth.acme-dns.io/update"
  592. export ACMEDNS_USERNAME="<username>"
  593. export ACMEDNS_PASSWORD="<password>"
  594. export ACMEDNS_SUBDOMAIN="<subdomain>"
  595. OK, let's issue a cert now:
  596. acme.sh --issue --dns dns_acmedns -d example.com -d www.example.com
  597. The credentials will be saved in `~/.acme.sh/account.conf` and will be
  598. reused when needed.