certbot-dns-hurricane-electric


Namecertbot-dns-hurricane-electric JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/studioeng/certbot-dns-hurricane-electric
SummaryHurricane Electric DNS Authenticator plugin for Certbot
upload_time2024-08-24 21:28:24
maintainerNone
docs_urlNone
authorStudioeng
requires_python!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7
licenseMIT
keywords certbot dns hurricane electric dns-01 authenticator api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            certbot-dns-hurricane-electric
======================================

`Hurricane Electric DNS <https://dns.he.net>`_ Authenticator plugin for `Certbot <https://certbot.eff.org>`_

----

Installation
------------

Install `certbot-dns-hurricane-electric <https://pypi.org/project/certbot-dns-hurricane-electric/>`_ to your Certbot's environment with pip. For example, the line below works for me after running ``certbot-auto``.

.. code-block:: bash

  $ sudo /opt/eff.org/certbot/venv/bin/pip install cerbot-dns-hurricane-electric

You can also use ``git+https://github.com/studioeng/certbot-dns-hurricane-electric.git`` or clone the repository and install from the directory, but pip is recommended.

Example usage
-------------

Create a configuration file with your username and password:

.. code-block:: ini

  dns_hurricane_electric_user = Your HE username
  dns_hurricane_electric_pass = Your HE password

and chmod it to ``600``:

.. code-block:: bash

  $ chmod 600 dns_he.ini

Then request a certificate with something like:

.. code-block:: bash

  domain="mail.example.com"
  email="email@example.com"

  $ certbot-auto certonly \
    --server https://acme-v02.api.letsencrypt.org/directory \
    --rsa-key-size 2048 \
    --preferred-challenges dns \
    --authenticator dns-hurricane_electric \
    --dns-hurricane_electric-credentials /data/dns_he.ini \
    --dns-hurricane_electric-propagation-seconds 30 \
    --domain "${domain}" \
    --email "${email}" \
    --agree-tos

You're done!

| ``--dns-hurricane_electric-credentials`` specifies the configuration file path.
| ``--dns-hurricane_electric-propagation-seconds`` controls the duration waited for the DNS record(s) to propagate.

These are stored in cerbot's renewal configuration, so they'll work on your automatic renewals.

Credits
-------

The original plugin by @tsaarist has been unchanged for a number of years.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/studioeng/certbot-dns-hurricane-electric",
    "name": "certbot-dns-hurricane-electric",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
    "maintainer_email": null,
    "keywords": "certbot dns hurricane electric dns-01 authenticator api",
    "author": "Studioeng",
    "author_email": "byattsystems@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/d1/d2/808ae79f5882da13dedd3805301abba0f8bbd255fb5994b27ee38872e891/certbot_dns_hurricane_electric-0.1.0.tar.gz",
    "platform": null,
    "description": "certbot-dns-hurricane-electric\n======================================\n\n`Hurricane Electric DNS <https://dns.he.net>`_ Authenticator plugin for `Certbot <https://certbot.eff.org>`_\n\n----\n\nInstallation\n------------\n\nInstall `certbot-dns-hurricane-electric <https://pypi.org/project/certbot-dns-hurricane-electric/>`_ to your Certbot's environment with pip. For example, the line below works for me after running ``certbot-auto``.\n\n.. code-block:: bash\n\n  $ sudo /opt/eff.org/certbot/venv/bin/pip install cerbot-dns-hurricane-electric\n\nYou can also use ``git+https://github.com/studioeng/certbot-dns-hurricane-electric.git`` or clone the repository and install from the directory, but pip is recommended.\n\nExample usage\n-------------\n\nCreate a configuration file with your username and password:\n\n.. code-block:: ini\n\n  dns_hurricane_electric_user = Your HE username\n  dns_hurricane_electric_pass = Your HE password\n\nand chmod it to ``600``:\n\n.. code-block:: bash\n\n  $ chmod 600 dns_he.ini\n\nThen request a certificate with something like:\n\n.. code-block:: bash\n\n  domain=\"mail.example.com\"\n  email=\"email@example.com\"\n\n  $ certbot-auto certonly \\\n    --server https://acme-v02.api.letsencrypt.org/directory \\\n    --rsa-key-size 2048 \\\n    --preferred-challenges dns \\\n    --authenticator dns-hurricane_electric \\\n    --dns-hurricane_electric-credentials /data/dns_he.ini \\\n    --dns-hurricane_electric-propagation-seconds 30 \\\n    --domain \"${domain}\" \\\n    --email \"${email}\" \\\n    --agree-tos\n\nYou're done!\n\n| ``--dns-hurricane_electric-credentials`` specifies the configuration file path.\n| ``--dns-hurricane_electric-propagation-seconds`` controls the duration waited for the DNS record(s) to propagate.\n\nThese are stored in cerbot's renewal configuration, so they'll work on your automatic renewals.\n\nCredits\n-------\n\nThe original plugin by @tsaarist has been unchanged for a number of years.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Hurricane Electric DNS Authenticator plugin for Certbot",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/studioeng/certbot-dns-hurricane-electric"
    },
    "split_keywords": [
        "certbot",
        "dns",
        "hurricane",
        "electric",
        "dns-01",
        "authenticator",
        "api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e1c666ccb82870682ea646d81e8aef6bb31e2609c7108348e1e46c87f519c0a5",
                "md5": "9290c189f3cca7f72f16d5759a252c33",
                "sha256": "b886e14b9becc3f117d6744bed5086c25dcd4f52a455489ddd7bc6ca91e4f088"
            },
            "downloads": -1,
            "filename": "certbot_dns_hurricane_electric-0.1.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9290c189f3cca7f72f16d5759a252c33",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
            "size": 6816,
            "upload_time": "2024-08-24T21:28:22",
            "upload_time_iso_8601": "2024-08-24T21:28:22.755343Z",
            "url": "https://files.pythonhosted.org/packages/e1/c6/66ccb82870682ea646d81e8aef6bb31e2609c7108348e1e46c87f519c0a5/certbot_dns_hurricane_electric-0.1.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d1d2808ae79f5882da13dedd3805301abba0f8bbd255fb5994b27ee38872e891",
                "md5": "87d7ad5676e55a416d958a5fd679621e",
                "sha256": "93e3ea43d39ac0abeee2005d2b491349895d48a7c2de4356eab1b873ff3bd17e"
            },
            "downloads": -1,
            "filename": "certbot_dns_hurricane_electric-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "87d7ad5676e55a416d958a5fd679621e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
            "size": 6171,
            "upload_time": "2024-08-24T21:28:24",
            "upload_time_iso_8601": "2024-08-24T21:28:24.186325Z",
            "url": "https://files.pythonhosted.org/packages/d1/d2/808ae79f5882da13dedd3805301abba0f8bbd255fb5994b27ee38872e891/certbot_dns_hurricane_electric-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-24 21:28:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "studioeng",
    "github_project": "certbot-dns-hurricane-electric",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "certbot-dns-hurricane-electric"
}
        
Elapsed time: 0.32092s