diff --git a/README.md b/README.md new file mode 100644 index 0000000..c87face --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# DNSPod DNS Authenticator plugin for Certbot + +A certbot dns plugin to obtain certificates using dnspod. + + +## Obtain API Token +[https://www.dnspod.cn/console/user/security](https://www.dnspod.cn/console/user/security) + + +## Install + +```bash +git clone https://github.com/tengattack/certbot-dns-dnspod +cd certbot-dns-dnspod +sudo python setup.py install +``` + +If you are using `certbot-auto`, you should run `virtualenv` first: + +```bash +# CentOS 7 +virtualenv --no-site-packages --python "python2.7" "/opt/eff.org/certbot/venv" +/opt/eff.org/certbot/venv/bin/python2.7 setup.py install +``` + +## Credentials File + +```ini +certbot_dns_dnspod:dns_dnspod_api_id = 12345 +certbot_dns_dnspod:dns_dnspod_api_token = 1234567890abcdef1234567890abcdef +``` + +```bash +chmod 600 /path/to/credentials.ini +``` + + +## Obtain Certificates + +```bash +certbot certonly -a certbot-dns-dnspod:dns-dnspod \ + --certbot-dns-dnspod:dns-dnspod-credentials /path/to/credentials.ini \ + -d example.com \ + -d "*.example.com" +``` diff --git a/README.rst b/README.rst deleted file mode 100644 index e41554c..0000000 --- a/README.rst +++ /dev/null @@ -1,43 +0,0 @@ -DNSPod DNS Authenticator plugin for Certbot -------------------------------------------- - -A certbot dns plugin to obtain certificates using dnspod. - - -Obtain API Token -================ -https://www.dnspod.cn/console/user/security - - -Install -======= - -.. code-block:: bash - - git clone https://github.com/tengattack/certbot-dns-dnspod - cd certbot-dns-dnspod - sudo python setup.py install - - -Credentials File -================ - -.. code-block:: ini - - certbot_dns_dnspod:dns_dnspod_api_id = 12345 - certbot_dns_dnspod:dns_dnspod_api_token = 1234567890abcdef1234567890abcdef - -.. code-block:: bash - - chmod 600 /path/to/credentials.ini - - -Obtain Certificates -=================== - -.. code-block:: bash - - certbot certonly -a certbot-dns-dnspod:dns-dnspod \ - --certbot-dns-dnspod:dns-dnspod-credentials /path/to/credentials.ini \ - -d example.com \ - -d "*.example.com"