diff --git a/dnsapi.md b/DNS-API-plugins.md similarity index 86% rename from dnsapi.md rename to DNS-API-plugins.md index b960c8e..e4504e5 100644 --- a/dnsapi.md +++ b/DNS-API-plugins.md @@ -10,13 +10,13 @@ Cloudflare Domain API offers two methods to automatically issue certs. ### Using the global API key First you need to login to your Cloudflare account to get your [API key](https://dash.cloudflare.com/profile). Each token generated is not stored on cloudflare account and will have expiry if not set correctly. You will get this in API keys section. -``` +```sh export CF_Key="sdfsdfsdfljlbjkljlkjsdfoiwje" export CF_Email="xxxx@sss.com" ``` ### Using the new cloudflare api token, you will get this after normal login and scroll down on dashboard and copy credentials. -``` +```sh export CF_Token="sdfsdfsdfljlbjkljlkjsdfoiwje" export CF_Account_ID="xxxxxxxxxxxxx" ``` @@ -24,15 +24,15 @@ In order to use the new token, the token currently needs access read access to Z Alternatively, if the certificate only covers a single zone, you can restrict the API Token only for write access to Zone.DNS for a single domain, and then specify the `CF_Zone_ID` directly: -``` +```sh export CF_Token="sdfsdfsdfljlbjkljlkjsdfoiwje" export CF_Account_ID="xxxxxxxxxxxxx" export CF_Zone_ID="xxxxxxxxxxxxx" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_cf -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_cf -d example.com -d www.example.com ``` The `CF_Key` and `CF_Email` or `CF_Token`and `CF_Account_ID`will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -41,14 +41,14 @@ The `CF_Key` and `CF_Email` or `CF_Token`and `CF_Account_ID`will be saved in `~/ The DNSPod.cn Domain API option requires that you first login to your account to get a DNSPod API Key and ID. -``` +```sh export DP_Id="1234" export DP_Key="sADDsdasdgdsf" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_dp -d example.com -d www.example.com +```sh +./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` and will be reused when needed. @@ -58,14 +58,14 @@ The `DP_Id` and `DP_Key` will be saved in `~/.acme.sh/account.conf` and will be First you need to login to your CloudXNS account to get your API Key and Secret. -``` +```sh export CX_Key="1234" export CX_Secret="sADDsdasdgdsf" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_cx -d example.com -d www.example.com +```sh +./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` and will be reused when needed. @@ -79,14 +79,14 @@ https://developer.godaddy.com/keys/ Please create a Production key, instead of a Test key. -``` +```sh export GD_Key="sdfsdfsdfljlbjkljlkjsdfoiwje" export GD_Secret="asdfsdafdsfdsfdsfdsfdsafd" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_gd -d example.com -d www.example.com +```sh +./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` and will be reused when needed. @@ -98,7 +98,7 @@ First you need to login to your PowerDNS account to enable the API and set your https://doc.powerdns.com/md/httpapi/README/ -``` +```sh export PDNS_Url="http://ns.example.com:8081" export PDNS_ServerId="localhost" export PDNS_Token="0123456789ABCDEF" @@ -106,8 +106,8 @@ export PDNS_Ttl=60 ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_pdns -d example.com -d www.example.com +```sh +./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` and will be reused when needed. @@ -121,7 +121,7 @@ https://github.com/Neilpang/acme.sh/wiki/How-to-use-OVH-domain-api ## 7. Use nsupdate to automatically issue cert First, generate a key for updating the zone -``` +```sh b=$(dnssec-keygen -a hmac-sha512 -b 512 -n USER -K /tmp foo) cat > /etc/named/keys/update.key < /etc/knot/acme.key ``` Include this key in your knot configuration file. -``` +```sh include: /etc/knot/acme.key ``` @@ -422,7 +419,7 @@ Next, configure your zone to allow dynamic updates. Dynamic updates for the zone are allowed via proper ACL rule with the `update` action. For in-depth instructions, please see [Knot DNS's documentation](https://www.knot-dns.cz/documentation/). -``` +```sh acl: - id: acme_acl address: 192.168.1.0/24 @@ -437,20 +434,20 @@ zone: Finally, make the DNS server and TSIG Key available to `acme.sh` -``` +```sh export KNOT_SERVER="dns.example.com" export KNOT_KEY=`grep \# /etc/knot/acme.key | cut -d' ' -f2` ``` and optionally (if you use challenge alias zone) -``` +```sh export KNOT_ZONE="le.example.com" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_knot -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_knot -d example.com -d www.example.com ``` The `KNOT_SERVER` and `KNOT_KEY` and `KNOT_ZONE` settings will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -459,20 +456,20 @@ The `KNOT_SERVER` and `KNOT_KEY` and `KNOT_ZONE` settings will be saved in `~/.a You need to obtain a read and write capable API key from your DigitalOcean account. See: https://www.digitalocean.com/help/api/ -``` +```sh export DO_API_KEY="75310dc4ca779ac39a19f6355db573b49ce92ae126553ebd61ac3a3ae34834cc" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_dgon -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_dgon -d example.com -d www.example.com ``` ## 21. Use ClouDNS.net API You need to set the HTTP API user ID and password credentials. See: https://www.cloudns.net/wiki/article/42/. For security reasons, it's recommended to use a sub user ID that only has access to the necessary zones, as a regular API user has access to your entire account. -``` +```sh # Use this for a sub auth ID export CLOUDNS_SUB_AUTH_ID=XXXXX # Use this for a regular auth ID @@ -481,8 +478,8 @@ export CLOUDNS_AUTH_PASSWORD="YYYYYYYYY" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_cloudns -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_cloudns -d example.com -d www.example.com ``` The `CLOUDNS_AUTH_ID` and `CLOUDNS_AUTH_PASSWORD` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -490,14 +487,14 @@ The `CLOUDNS_AUTH_ID` and `CLOUDNS_AUTH_PASSWORD` will be saved in `~/.acme.sh/a First you need to create/obtain API credentials on your Infoblox appliance. -``` +```sh export Infoblox_Creds="username:password" export Infoblox_Server="ip or fqdn of infoblox appliance" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_infoblox -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_infoblox -d example.com -d www.example.com ``` Note: This script will automatically create and delete the ephemeral txt record. @@ -508,27 +505,27 @@ The `Infoblox_Creds` and `Infoblox_Server` will be saved in `~/.acme.sh/account. First you need to create/obtain API tokens on your [settings panel](https://vscale.io/panel/settings/tokens/). -``` +```sh export VSCALE_API_KEY="sdfsdfsdfljlbjkljlkjsdfoiwje" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_vscale -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_vscale -d example.com -d www.example.com ``` ## 24. Use Dynu API First you need to create/obtain API credentials from your Dynu account. See: https://www.dynu.com/resources/api/documentation -``` +```sh export Dynu_ClientId="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" export Dynu_Secret="yyyyyyyyyyyyyyyyyyyyyyyyy" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_dynu -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_dynu -d example.com -d www.example.com ``` The `Dynu_ClientId` and `Dynu_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -543,14 +540,14 @@ Note that this is an _account_ token and not a user token. The account token is needed to infer the `account_id` used in requests. A user token will not be able to determine the correct account to use. -``` +```sh export DNSimple_OAUTH_TOKEN="sdfsdfsdfljlbjkljlkjsdfoiwje" ``` To issue the cert just specify the `dns_dnsimple` API. -``` -acme.sh --issue --dns dns_dnsimple -d example.com +```sh +./acme.sh --issue --dns dns_dnsimple -d example.com ``` The `DNSimple_OAUTH_TOKEN` will be saved in `~/.acme.sh/account.conf` and will @@ -561,18 +558,18 @@ https://github.com/pho3nixf1re/acme.sh/issues. ## 26. Use NS1.com API -``` +```sh export NS1_Key="fdmlfsdklmfdkmqsdfk" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_nsone -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_nsone -d example.com -d www.example.com ``` ## 27. Use DuckDNS.org API -``` +```sh export DuckDNS_Token="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" ``` @@ -588,15 +585,15 @@ Create your API token here: https://www.name.com/account/settings/api Note: `Namecom_Username` should be your Name.com username and not the token name. If you accidentally run the script with the token name as the username see `~/.acme.sh/account.conf` to fix the issue -``` +```sh export Namecom_Username="testuser" export Namecom_Token="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" ``` And now you can issue certs with: -``` -acme.sh --issue --dns dns_namecom -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_namecom -d example.com -d www.example.com ``` If you had Two-step Authentication enabled, make sure to change your security setting, read this guide for help: [Using API with Two-step Authentication](https://www.name.com/support/articles/360007989433-Using-API-with-Two-step-Authentication) @@ -621,28 +618,28 @@ ZonePublish ``` Pass the API user credentials to the environment: -``` +```sh export DYN_Customer="customer" export DYN_Username="apiuser" export DYN_Password="secret" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_dyn -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_dyn -d example.com -d www.example.com ``` The `DYN_Customer`, `DYN_Username` and `DYN_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. ## 30. Use pdd.yandex.ru API -``` +```sh export PDD_Token="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" ``` Follow these instructions to get the token for your domain https://tech.yandex.com/domain/doc/concepts/access-docpage/ -``` -acme.sh --issue --dns dns_yandex -d mydomain.example.org +```sh +./acme.sh --issue --dns dns_yandex -d mydomain.example.org ``` Sometimes cloudflare / google doesn't pick new dns records fast enough. You can add `--dnssleep XXX` to params as workaround. @@ -653,15 +650,15 @@ For issues, please report to https://github.com/non7top/acme.sh/issues. Hurricane Electric (https://dns.he.net/) doesn't have an API so just set your login credentials like so: -``` +```sh export HE_Username="yourusername" export HE_Password="password" ``` Then you can issue your certificate: -``` -acme.sh --issue --dns dns_he -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_he -d example.com -d www.example.com ``` The `HE_Username` and `HE_Password` settings will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -672,14 +669,14 @@ Please report any issues to https://github.com/angel333/acme.sh or to difference is whether ssl cert is checked for validity (0) or whether it is just accepted (1) Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_da -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_da -d example.com -d www.example.com ``` The `DA_Api` and `DA_Api_Insecure` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -871,10 +868,10 @@ The `DA_Api` and `DA_Api_Insecure` will be saved in `~/.acme.sh/account.conf` an API access must be enabled at https://painel.kinghost.com.br/painel.api.php -``` +```sh export KINGHOST_Username="yourusername" export KINGHOST_Password="yourpassword" -acme.sh --issue --dns dns_kinghost -d example.com -d *.example.com +./acme.sh --issue --dns dns_kinghost -d example.com -d *.example.com ``` The `KINGHOST_username` and `KINGHOST_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -883,13 +880,13 @@ The `KINGHOST_username` and `KINGHOST_Password` will be saved in `~/.acme.sh/acc First, get your API key at https://my.zilore.com/account/api -``` +```sh export Zilore_Key="5dcad3a2-36cb-50e8-cb92-000002f9" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_zilore -d example.com -d *.example.com +```sh +./acme.sh --issue --dns dns_zilore -d example.com -d *.example.com ``` The `Zilore_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -908,7 +905,7 @@ The user needs the following permissions: Set the API endpoint: -``` +```sh export LOOPIA_Api="https://api.loopia./RPCSERV" ``` @@ -917,15 +914,15 @@ Depending on your hosting location, `` is one of: `com`, `no`, Set the login credentials: -``` +```sh export LOOPIA_User="user@loopiaapi" export LOOPIA_Password="password" ``` And to issue a cert run: -``` -acme.sh --issue --dns dns_loopia -d example.com -d *.example.com +```sh +./acme.sh --issue --dns dns_loopia -d example.com -d *.example.com ``` The exported variables will be saved in `~/.acme.sh/account.conf` and @@ -946,7 +943,7 @@ https://github.com/joohoi/acme-dns # export ACMEDNS_PASSWORD="" # export ACMEDNS_SUBDOMAIN="" -acme.sh --issue --dns dns_acmedns -d example.com -d www.example.com +./acme.sh --issue --dns dns_acmedns -d example.com -d www.example.com ``` The credentials will be saved in `~/.acme.sh/account.conf` and will @@ -956,11 +953,11 @@ be reused when needed. First you need to login to your TELE3 account to set your API-KEY. https://www.tele3.cz/system-acme-api.html -``` +```sh export TELE3_Key="MS2I4uPPaI..." export TELE3_Secret="kjhOIHGJKHg" -acme.sh --issue --dns dns_tele3 -d example.com -d *.example.com +./acme.sh --issue --dns dns_tele3 -d example.com -d *.example.com ``` The TELE3_Key and TELE3_Secret will be saved in ~/.acme.sh/account.conf and will be reused when needed. @@ -973,14 +970,14 @@ First you need to login to your euserv.eu account and activate your API Administ Once you've activate, login to your API Admin Interface and create an API account. Please specify the scope (active groups: domain) and assign the allowed IPs. -``` +```sh export EUSERV_Username="99999.user123" export EUSERV_Password="Asbe54gHde" ``` Ok, let's issue a cert now: (Be aware to use the `--insecure` flag, cause euserv.eu is still using self-signed certificates!) -``` -acme.sh --issue --dns dns_euserv -d example.com -d *.example.com --insecure +```sh +./acme.sh --issue --dns dns_euserv -d example.com -d *.example.com --insecure ``` The `EUSERV_Username` and `EUSERV_Password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -991,14 +988,14 @@ Please report any issues to https://github.com/initit/acme.sh or to export PDNS_MANAGER_PASSWORD= @@ -1969,35 +1966,35 @@ export PDNS_MANAGER_PASSWORD= Then issue a new certificate: -``` -acme.sh --issue -d example.com --dns dns_pdnsmanager +```sh +./acme.sh --issue -d example.com --dns dns_pdnsmanager ``` ## 94. Use Misaka.io domain API Get your API token at https://console.misaka.io/settings -``` +```sh export Misaka_Key="sdfsdfsdfljlbjkljlkjsdfoiwje" ``` To issue a cert: -``` -acme.sh --issue --dns dns_misaka -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_misaka -d example.com -d www.example.com ``` ## 95. Use easyDNS.net API to automatically issue a cert You need to sign up for beta API access [here](http://docs.sandbox.rest.easydns.net/beta_signup.php). Docs: http://sandbox.rest.easydns.net:3000/ -``` +```sh export EASYDNS_Key="xxxxxxxxxxxxxxxxx.xxxxxxxx" export EASYDNS_Token="xxxxxxxxxxxxxxx.xxxxxxxx" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_easydns -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_easydns -d example.com -d www.example.com ``` The `EASYDNS_Key` and `EASYDNS_Token` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -2008,15 +2005,15 @@ https://github.com/Neilpang/acme.sh/issues/2647 ## 96. Use CloudDNS API to automatically issue a cert Docs: https://github.com/vshosting/clouddns -``` +```sh export CLOUDDNS_EMAIL="email@example.com" export CLOUDDNS_PASSWORD="xxxxxxxx" export CLOUDDNS_CLIENT_ID="xxxxxxxxxxxxxxxxxxxx" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_clouddns -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_clouddns -d example.com -d www.example.com ``` The `CLOUDDNS_EMAIL`, `CLOUDDNS_PASSWORD` and `CLOUDDNS_CLIENT_ID` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -2032,8 +2029,8 @@ Alternatively you can use the [HTTP REST API](https://dynv6.github.io/api-spec/) If both a SSH Key and a HTTP Token are specified the REST API will be used. To issue a cert use: -``` -acme.sh --issue --dns dns_dynv6 -d www.example.dynv6.net +```sh +./acme.sh --issue --dns dns_dynv6 -d www.example.dynv6.net ``` If you find any bugs, please report here: https://github.com/acmesh-official/acme.sh/issues/2702 @@ -2041,14 +2038,14 @@ https://github.com/acmesh-official/acme.sh/issues/2702 ## 98. Use All-Inkl.com domain API to automatically issue cert You need your login credentials for All-Inkl (https://kas.all-inkl.com). -``` +```sh export KAS_Login="....." export KAS_Authtype="sha1" export KAS_Authdata="....." ``` Now you are able to issue a cert: -``` -acme.sh --issue --dns dns_kas -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_kas -d example.com -d www.example.com ``` The `KAS_Login`, `KAS_Authtype` and `KAS_Authdata` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -2056,14 +2053,14 @@ The `KAS_Login`, `KAS_Authtype` and `KAS_Authdata` will be saved in `~/.acme.sh/ Get your API credentials at https://manage.constellix.com/users -``` +```sh export CONSTELLIX_Key="XXX" export CONSTELLIX_Secret="XXX" ``` To issue a cert: -``` -acme.sh --issue --dns dns_constellix -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_constellix -d example.com -d www.example.com ``` The `CONSTELLIX_Key` and `CONSTELLIX_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -2072,14 +2069,14 @@ The `CONSTELLIX_Key` and `CONSTELLIX_Secret` will be saved in `~/.acme.sh/accoun Get your API credentials at https://namemaster.de DNS/API -``` +```sh export NM_user="XXX" export NM_sha256="XXX" ``` To issue a cert: -``` -acme.sh --issue --dns dns_nm -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_nm -d example.com -d www.example.com ``` The `NM_user` and `NM_sha256` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -2096,11 +2093,11 @@ HostingUkraine_Token="XXX" ``` To issue a cert: -``` +```sh ./acme.sh --issue --dns dns_hostingukraine -d yourdomain.com -d www.yourdomain.com ``` To issue a wildcard cert: -``` +```sh ./acme.sh --issue --dns dns_hostingukraine -d yourdomain.com -d '*.yourdomain.com' ``` @@ -2110,13 +2107,13 @@ The `HostingUkraine_Login` and `HostingUkraine_Token` will be saved in `~/.acme. Get your API token at https://npanel.arvancloud.com/profile/api-keys -``` +```sh export Arvan_Token="fsdasdfsdfljlbjkljlkjsdfoiwje" ``` To issue a cert: -``` -acme.sh --issue --dns dns_arvan -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_arvan -d example.com -d www.example.com ``` The `Arvan_Token` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -2130,14 +2127,14 @@ You must activate Dynamic DNS in Joker.com DNS configuration first. Username and Report bugs to https://github.com/acmesh-official/acme.sh/issues/2840 -``` +```sh export JOKER_USERNAME="xxxx" export JOKER_PASSWORD="xxxx" ``` To issue a cert: -``` -acme.sh --issue --dns dns_joker -d example.com +```sh +./acme.sh --issue --dns dns_joker -d example.com ``` The `JOKER_USERNAME` and `JOKER_PASSWORD` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -2164,7 +2161,7 @@ in `~/.acme.sh/account.conf` and reuses it when needed. Ok, let's issue a cert now: ```sh -acme.sh --issue --dns dns_1984hosting -d example.com -d *.example.com +./acme.sh --issue --dns dns_1984hosting -d example.com -d *.example.com ``` If you have any issues with 1984Hosting DNS API please report them [here](https://github.com/Neilpang/acme.sh/issues/2851). @@ -2172,14 +2169,14 @@ If you have any issues with 1984Hosting DNS API please report them [here](https: ## 105. Use Aruba domain API Get your api token following instruction here at https://admin.arubabusiness.it/DashBoard/WebApiGuide.aspx -``` +```sh export ARUBA_TK="sdfsdfsdfljlbjkljlkjsdfoiwje" #ARUBA API Token export ARUBA_AK="xxxxxxxxxxxxx" #ARUBA Username export ARUBA_AS="xxxxxxxxxxxxx" #ARUBA Password ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_aruba -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_aruba -d example.com -d www.example.com ``` If you find any bugs, please report here: @@ -2189,7 +2186,7 @@ https://github.com/JTrotta/acme.sh/issues ## 106. Use TransIP domain API: First you need to login to your TransIP account to get your [private key](https://www.transip.nl/cp/account/api/). -``` +```sh export TRANSIP_Username="MyUserName" export TRANSIP_Key_File="private_key" ``` @@ -2213,33 +2210,33 @@ you can add this trusted root CA with This script will create a new access token with a default lifetime of 30 minutes. Note that these tokens are by default IP-whitelisted and will not work if your IP is not whitelisted in the Transip control panel. To issue a cert: -``` -acme.sh --issue --dns dns_transip --dnssleep 300 -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_transip --dnssleep 300 -d example.com -d www.example.com ``` ## 107. Use dyndnsfree.de API -``` +```sh export df_user="XXX" export df_password="XXX" ``` To issue a cert: -``` -acme.sh --issue --dns dns_df -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_df -d example.com -d www.example.com ``` The `df_user` and `df_password` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. ## 108. Use Njalla API -``` +```sh export NJALLA_Token="XXX" ``` To issue a cert: -``` -acme.sh --issue --dns dns_njalla -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_njalla -d example.com -d www.example.com ``` Please report any bugs here: https://github.com/acmesh-official/acme.sh/issues/2913 @@ -2249,13 +2246,13 @@ Please report any bugs here: https://github.com/acmesh-official/acme.sh/issues/2 Obtain an account token from https://vercel.com/account/tokens. -``` +```sh export VERCEL_TOKEN="sdfsdfsdfljlbjkljlkjsdfoiwje" ``` To issue a cert: -``` -acme.sh --issue --dns dns_vercel -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_vercel -d example.com -d www.example.com ``` @@ -2269,7 +2266,7 @@ export HETZNER_Token="somelongrandomstring" Ok, let's issue a cert now: ```sh -acme.sh --issue --dns dns_hetzner -d example.com -d www.example.com +./acme.sh --issue --dns dns_hetzner -d example.com -d www.example.com ``` The `HETZNER_Token` settings will be saved in `[acme.sh-config-home-path]/account.conf` @@ -2285,19 +2282,19 @@ in order to avoid multiple `get_zone_id` requests two months later. Contact kapper.net support via support@kapper.net to get your kapper.net DNS Panel API Key and Secret. For initialzation call following in commandline -``` +```sh export KAPPERNETDNS_Key="yourKAPPERNETapikey" export KAPPERNETDNS_Secret="yourKAPPERNETapisecret" ``` You can start the acme.sh with following parameters for testing -``` -acme.sh --issue --dns dns_kappernet -d +```sh +./acme.sh --issue --dns dns_kappernet -d or for a wildcertificate -acme.sh --issue --dns dns_kappernet -d -d *. +./acme.sh --issue --dns dns_kappernet -d -d *. ``` Please replace "" with the name of the domain you wish to create a certificate for. @@ -2305,8 +2302,8 @@ Please replace "" with the name of the domain you wish to create a After the test you can replace your kapper.net DNS Panel API Key and Secret, it is stored in ~/.acme.sh/account.conf. For repeated calls use -``` -acme.sh --issue --dns dns_kappernet -d +```sh +./acme.sh --issue --dns dns_kappernet -d ``` ## 112. Use Wedos API @@ -2315,7 +2312,7 @@ First create your WAPI password and add your IP address to access list at custom Set variables: -``` +```sh export WEDOS_User='xxx@xxx.xx' export WEDOS_Pass='xxx123' or use sha1 hash of WEDOS_Pass directly @@ -2323,8 +2320,8 @@ export WEDOS_Hash='xxxxxxxxxx' ``` Issue your certs: -``` -acme.sh --issue --dns dns_wedos -d xxx.xx -d www.xxx.xx +```sh +./acme.sh --issue --dns dns_wedos -d xxx.xx -d www.xxx.xx ``` WEDOS_User and WEDOS_Hash will be stored in `~/.acme.sh/account.conf` and will be reused when needed. @@ -2336,22 +2333,22 @@ Shellrent API offers one method to automatically issue certs. First you need to login to your Shellrent account to get your API key. In order to use the token, you need to authorize your IP to have access to it. More Info on https://api.shellrent.com and https://guide.shellrent.com -``` +```sh export SH_Username="usrXXXX" export SH_Token="sdfsdfsdfljlbjkljlkjsdfoiwje" ``` Alternatively, if the certificate only covers a single zone, you can speed up the process by specify the SH_Domain_ID directly: -``` +```sh export SH_Username="usrXXXX" export SH_Token="sdfsdfsdfljlbjkljlkjsdfoiwje" export SH_Domain_ID="xxxxxxxxxxxxx" ``` Let's issue a cert now: -``` -acme.sh --issue --dns dns_shellrent -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_shellrent -d example.com -d www.example.com ``` The SH_Username and SH_Token and SH_Domain_ID will be saved in ~/.acme.sh/account.conf and will be reused when needed. @@ -2375,7 +2372,7 @@ You will most likely want to source your OpenStack RC file to set your environme . openrc.sh ``` or manually like: -``` +```sh export OS_AUTH_URL=https://keystone.example.com:5000/ export OS_USERNAME= export OS_PASSWORD= @@ -2385,8 +2382,8 @@ export OS_USER_DOMAIN_NAME=Default ``` To issue a cert: -``` -acme.sh --issue --dns dns_openstack -d example.com +```sh +./acme.sh --issue --dns dns_openstack -d example.com ``` Your OpenStack credentials will be saved to `~/.acme.sh/account.conf` and reused on renewal. @@ -2397,14 +2394,14 @@ Your OpenStack credentials will be saved to `~/.acme.sh/account.conf` and reused 2. Set your token for use with -``` +```sh export NETLIFY_ACCESS_TOKEN='arstdhneioqwfpgjluyzxcvbkm' ``` 3. Issue a cert with: -``` -acme.sh --issue --dns dns_netlify -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_netlify -d example.com -d www.example.com ``` [Report a Netlify-related Bug](https://github.com/acmesh-official/acme.sh/issues/3088) @@ -2418,7 +2415,7 @@ Report any issues to https://github.com/acmesh-official/acme.sh/issues/3157 This provider requires Akamai Open Edgegrid Credentials with EdgeDNS API access authorization. To create and establish your Akamai OPEN CREDENTIALS, see the [authorization](https://developer.akamai.com/legacy/introduction/Prov_Creds.html) and [credentials](https://developer.akamai.com/legacy/introduction/Conf_Client.html) sections of the Akamai Developer Get Started guide. The Akamai Open Edgegrid credentials must be specified as environment variables as follows: -``` +```sh export AKAMAI_CLIENT_TOKEN= export AKAMAI_ACCESS_TOKEN= export AKAMAI_CLIENT_SECRET= @@ -2426,8 +2423,8 @@ export AKAMAI_HOST= ``` To issue a cert: -``` -acme.sh --issue --dns dns_edgedns -d example.com +```sh +./acme.sh --issue --dns dns_edgedns -d example.com ``` Your Akamai Edgegrid credentials will be saved to `~/.acme.sh/account.conf` and reused on renewal. @@ -2436,14 +2433,14 @@ Your Akamai Edgegrid credentials will be saved to `~/.acme.sh/account.conf` and WEDOS DNS provider comes from Czech Republic. DNS API implementation for WEDOS require your WEDOS's account to allow WAPI interface. You have to login to WEDOS administration, in setting allow WAPI interface (in days when this manual were written it was for free completelly). Configure WAPI interface to XML interface and register the IP addresses (IPv4 and IPv6) of the server where you plan to use acme.sh. That is from the manual side. By doing this setting you should have WEDOS web account username and configured WAPI password. This must be configured to your acme.sh account in the first execution of acme.sh script. To save it to `~/.acme.sh/account.conf` (and for subsequent acme.sh executions) just execute following before first execution of acme.sh script. -``` +```sh export WEDOS_Username= export WEDOS_Wapipass= ``` Then you can issue a certificates: -``` -acme.sh --issue --dns dns_wedos -d "*.example.com" -d "examle.com" +```sh +./acme.sh --issue --dns dns_wedos -d "*.example.com" -d "examle.com" ``` If you face any bug, please use this [page](https://github.com/acmesh-official/acme.sh/issues/3166) to report it. But before reporting run the acme.sh with `--debug 2` switch and append full acme.sh output to the issue report. @@ -2452,14 +2449,14 @@ Enjoy it. ## 118. Use Websupport DNS API Obtain an api key and secret from https://admin.websupport.sk/en/auth/apiKey -``` +```sh export WS_ApiKey="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" export WS_ApiSecret="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" ``` To issue a cert: -``` -acme.sh --issue --dns dns_websupport -d "*.example.com" -d "examle.com" +```sh +./acme.sh --issue --dns dns_websupport -d "*.example.com" -d "examle.com" ``` Report any issues to https://github.com/akulumbeg/acme.sh/issues @@ -2471,9 +2468,9 @@ Create a token with Domain scope in the API dashboard at https://manager.infomaniak.com/v3//api/dashboard and export it as an environment variable: -``` +```sh export INFOMANIAK_API_TOKEN=xxx -acme.sh --issue --dns dns_infomaniak -d example.com -d www.example.com +./acme.sh --issue --dns dns_infomaniak -d example.com -d www.example.com ``` Please report any issue to https://github.com/acmesh-official/acme.sh/issues/3188 @@ -2484,10 +2481,10 @@ Bookmyname hosts domains and has a small API. Export your login/pass as an environment variable: -``` +```sh export BOOKMYNAME_USERNAME=xxx export BOOKMYNAME_PASSWORD=yyy -acme.sh --issue --dns dns_bookmyname --dnssleep 600 -d example.com -d www.example.com +./acme.sh --issue --dns dns_bookmyname --dnssleep 600 -d example.com -d www.example.com ``` Please report any issue to https://github.com/acmesh-official/acme.sh/issues/3209 @@ -2498,9 +2495,9 @@ For DNS records managed via https://engine.anexia-it.com/clouddns Export your token as an environment variable: -``` +```sh export ANX_Token='XXXXXXXXXXXXXXXXXXX' -acme.sh --issue --dns dns_anx -d example.com -d www.example.com +./acme.sh --issue --dns dns_anx -d example.com -d www.example.com ``` Please report any issue to https://github.com/acmesh-official/acme.sh/issues/3238 @@ -2508,11 +2505,13 @@ Please report any issue to https://github.com/acmesh-official/acme.sh/issues/323 Note that in order the script to be working properly acme.sh should be installed on Synology itself. To issue a cert: - - ./acme.sh --issue --dns dns_synology_dsm -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_synology_dsm -d example.com -d www.example.com +``` To issue a wildcard cert: - - ./acme.sh --issue --dns dns_synology_dsm -d example.com -d *.example.com +``` +./acme.sh --issue --dns dns_synology_dsm -d example.com -d *.example.com +``` You can find more details [here](https://github.com/arabezar/acme.sh/wiki) Please report any issue [here](https://github.com/acmesh-official/acme.sh/issues/3248) @@ -2523,52 +2522,52 @@ Export your credentials as an environment variable: ProjectID can be found at [here](https://console-intl.huaweicloud.com/iam/?region=ap-southeast-1#/myCredential) It seems that project ID can be retrieved automatically, but this dnsapi does not implement it yet. -``` +```sh export HUAWEICLOUD_Username= # Usually hwxxxxxx export HUAWEICLOUD_Password= export HUAWEICLOUD_ProjectID= ``` To issue a cert: -``` +```sh ./acme.sh --issue --dns dns_huaweicloud -d example.com -d www.example.com ``` To issue a wildcard cert: -``` +```sh ./acme.sh --issue --dns dns_huaweicloud -d example.com -d *.example.com ``` ## 124. Use Simply API Export your credentials, you will find your API key by logging in to your Simply.com account: -``` +```sh export SIMPLY_AccountName= export SIMPLY_ApiKey= ``` To issue a cert: -``` +```sh ./acme.sh --issue --dns dns_simply -d example.com -d www.example.com ``` To issue a wildcard cert: -``` +```sh ./acme.sh --issue --dns dns_simply -d example.com -d *.example.com ``` ## 125. Use World4You API Export your credentials as an environment variable: -``` +```sh export WORLD4YOU_USERNAME= export WORLD4YOU_PASSWORD= ``` To issue a cert: -``` +```sh ./acme.sh --issue --dns dns_world4you -d example.com -d www.example.com ``` To issue a wildcard cert: -``` +```sh ./acme.sh --issue --dns dns_world4you -d example.com -d *.example.com ``` @@ -2576,42 +2575,42 @@ To issue a wildcard cert: First, you'll need to retrieve your [Api Key](https://www.scaleway.com/en/docs/generate-api-keys/) -``` +```sh export SCALEWAY_API_TOKEN='xxx' ``` To issue a cert run: -``` -acme.sh --issue --dns dns_scaleway -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_scaleway -d example.com -d www.example.com ``` Please report any issue [here](https://github.com/acmesh-official/acme.sh/issues/3295) ## 127 First you need to login to your LS account to get your API Key. -``` +```sh export LS_Key="KEY" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_ls -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_ls -d example.com -d www.example.com ``` ## 128. Use RackCorp API Export your credentials as an environment variable: -``` +```sh export RACKCORP_APIUUID="UUIDHERE" export RACKCORP_APISECRET="SECRETHERE" ``` To issue a cert: -``` -acme.sh --issue --dns dns_rackcorp -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_rackcorp -d example.com -d www.example.com ``` To issue a wildcard cert: -``` -acme.sh --issue --dns dns_rackcorp -d example.com -d *.example.com +```sh +./acme.sh --issue --dns dns_rackcorp -d example.com -d *.example.com ``` ## 129. Using the IONOS domain API @@ -2619,19 +2618,19 @@ acme.sh --issue --dns dns_rackcorp -d example.com -d *.example.com Read [Getting Started](https://developer.hosting.ionos.de/docs/getstarted) to learn how to create an API key. Export your credentials as environment variables: -``` +```sh export IONOS_PREFIX="..." export IONOS_SECRET="..." ``` To issue a certificate, execute: -``` -acme.sh --issue --dns dns_ionos -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_ionos -d example.com -d www.example.com ``` To issue a wildcard certificate, execute: -``` -acme.sh --issue --dns dns_ionos -d example.com -d *.example.com +```sh +./acme.sh --issue --dns dns_ionos -d example.com -d *.example.com ``` ## 130. Using the Porkbun API @@ -2639,19 +2638,19 @@ acme.sh --issue --dns dns_ionos -d example.com -d *.example.com Read [Getting Started](https://porkbun.com/api/json/v3/documentation) to learn how to create an API key. Export your credentials as environment variables: -``` +```sh export PORKBUN_API_KEY="..." export PORKBUN_SECRET_API_KEY="..." ``` To issue a certificate, execute: -``` -acme.sh --issue --dns dns_porkbun -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_porkbun -d example.com -d www.example.com ``` To issue a wildcard certificate, execute: -``` -acme.sh --issue --dns dns_porkbun -d example.com -d *.example.com +```sh +./acme.sh --issue --dns dns_porkbun -d example.com -d *.example.com ``` ## 131. Using the Aurora API @@ -2659,14 +2658,14 @@ acme.sh --issue --dns dns_porkbun -d example.com -d *.example.com [PCextreme B.V.](https://www.pcextreme.nl/) is a Dutch cloud provider offering cloud services under the family name Aurora. Head over to [DNS & Health Checks > Users](https://cp.pcextreme.nl/auroradns/users) to get your API credentials. Export your credentials as environment variables: -``` +```sh export AURORA_Key="..." export AURORA_Secret="..." ``` To issue a certificate, execute: -``` -acme.sh --issue --dns dns_aurora -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_aurora -d example.com -d www.example.com ``` Please report any issue to https://github.com/acmesh-official/acme.sh/issues/3459 @@ -2676,14 +2675,14 @@ Please report any issue to https://github.com/acmesh-official/acme.sh/issues/345 [Azion](https://www.azion.com/) is a Edge Computing Platform to build modern applications at edge. This API reflects the [Intelligent DNS](https://www.azion.com/en/documentation/products/intelligent-dns/) product. Read this [documentation](https://www.azion.com/en/documentation/products/api/v3/) to create an username/password and permissions to use this plugin. Export your username/password as environment variables: -``` +```sh export AZION_Email="user@example.com" export AZION_Password="password" ``` To issue a certificate, execute: -``` -acme.sh --issue --dns dns_azion -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_azion -d example.com -d www.example.com ``` Please report any issue to https://github.com/acmesh-official/acme.sh/issues/3555 @@ -2697,17 +2696,17 @@ See: Manage API Tokens). Then set your username, api token and hostname: -``` +```sh export cPanel_Username=username export cPanel_Apitoken=apitoken export cPanel_Hostname=https://hostname:port ``` example -``` +```sh export cPanel_Username=myadminuseratnordicway export cPanel_Apitoken=CXJ8HRXFNS363RQ71Z51TKM9KTHRFZVE export cPanel_Hostname=https://cp04.nordicway.dk:2083 ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_cpanel -d example.com -d www.example.com +```sh +./acme.sh --issue --dns dns_cpanel -d example.com -d www.example.com ``` (see https://api.docs.cpanel.net/cpanel/introduction/#cpanel-or-webmail-session-url-1 regarding cPanel ports) @@ -2779,21 +2778,21 @@ The `ISPMan_Username` and `ISPMan_Password` will be saved in `$LE_WORKING_DIR/ac Ok, let's issue a cert: ```sh -acme.sh --issue --dns dns_ispman -d example.com -d *.example.com +./acme.sh --issue --dns dns_ispman -d example.com -d *.example.com ``` Please report bugs to [https://github.com/acmesh-official/acme.sh/issues/3751](https://github.com/acmesh-official/acme.sh/issues/3751) ## 138. Use dnsHome.de DNS API -``` +```sh export DNSHOME_Subdomain="" export DNSHOME_SubdomainPassword="" ``` Ok, let's issue a cert now: -``` -acme.sh --issue --dns dns_dnshome -d subdomain.ddnsdomain.tld +```sh +./acme.sh --issue --dns dns_dnshome -d subdomain.ddnsdomain.tld ``` The `DNSHOME_Subdomain` and `DNSHOME_SubdomainPassword` will be saved in the domain conf and will be reused when needed. @@ -2811,7 +2810,7 @@ export MB_AS="Secret" Ok, let's issue a cert now: ```sh -acme.sh --issue --dns dns_mythic_beasts --domain example.com +./acme.sh --issue --dns dns_mythic_beasts --domain example.com ``` The credentials will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -2829,13 +2828,13 @@ export SDNS_ZONE_KEY="Key" Ok, let's issue a cert now: ```sh -acme.sh --issue --dns dns_sdns --domain example.com +./acme.sh --issue --dns dns_sdns --domain example.com ``` S-dns nameservers use anycast. It is therefore possible that the server next to your location already provides the new record, while the CA reaches another one that does not have the TXT record yet. To avoid such timing errors the dnssleep flag can be set to a value of 240 seconds. ```sh -acme.sh --issue --dns dns_sdns --domain example.com --dnssleep 240 +./acme.sh --issue --dns dns_sdns --domain example.com --dnssleep 240 ``` ## 141. Using the united-domains reselling DNS API @@ -2851,12 +2850,12 @@ export UDR_PASS="..." To issue a certificate, execute: ```sh -acme.sh --issue --dns dns_udr -d example.com -d www.example.com +./acme.sh --issue --dns dns_udr -d example.com -d www.example.com ``` To issue a wildcard certificate, execute: ```sh -acme.sh --issue --dns dns_udr -d example.com -d *.example.com +./acme.sh --issue --dns dns_udr -d example.com -d *.example.com ``` The `UDR_USER` and `UDR_PASS` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. @@ -2872,16 +2871,42 @@ export CURANET_AUTHSECRET="..." To issue a certificate, execute: ```sh -acme.sh --issue --dns dns_curanet -d example.com -d www.example.com +./acme.sh --issue --dns dns_curanet -d example.com -d www.example.com ``` To issue a wildcard certificate, execute: ```sh -acme.sh --issue --dns dns_curanet -d example.com -d *.example.com +./acme.sh --issue --dns dns_curanet -d example.com -d *.example.com ``` The `CURANET_AUTHCLIENTID` and `CURANET_AUTHSECRET` will be saved in `~/.acme.sh/account.conf` and will be reused when needed. +## 143. Use ArtFiles.de DNS API + +First, verify that API access is already enabled: +1. Go to ArtFiles.de's **DCP** (Domain Control Panel). +2. Click **Passwords** in the left menu. +3. To the menu's right, the drop-down menu for **Active** is either `active` or `inactive`. +4. If **Active** is already set to `active`, skip this step. Otherwise, enter your desired password into both text boxes, save it somewhere else (e. g. Firefox, KeePass, etc.) & click **Apply** below. +5. Copy **User name**'s value, i. e. the one that starts with `api` & then continues with your account number which is something like `a12345678`. + +Export `AF_API_Username` & `AF_API_Password` only once (saved into domain's config file upon 1st successful script run): +```sh +export AF_API_Username="api12345678" +export AF_API_Password="apiPassword" +``` + +To issue a certificate, execute: +```sh +./acme.sh --issue --dns dns_artfiles -d yourDomain.tld +``` +To issue a wildcard certificate, execute: +```sh +./acme.sh --issue --dns dns_artfiles -d yourDomain.tld -d *.yourDomain.tld +``` + +Please report any issue at [Eagle3386/acme.sh/issues](https://github.com/Eagle3386/acme.sh/issues). + # ################## # Use custom API @@ -2893,8 +2918,8 @@ Let's assume you want to name it 'myapi': 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 +```sh +./acme.sh --issue --dns dns_myapi -d example.com -d www.example.com ``` For more details, please check our sample script: [dns_myapi.sh](https://github.com/Neilpang/acme.sh/blob/master/dnsapi/dns_myapi.sh)