mirror of
https://github.com/certbot/certbot.git
synced 2026-07-25 00:32:44 +02:00
ohemorangeandGitHub
16f858547f
Fixes #10252. See further discussion here: https://github.com/pypa/pip/issues/11457 We are doing option: > Alternatively, enable the --use-pep517 pip option, possibly with --no-build-isolation. The --use-pip517 flag will force pip to use the modern mechanism for editable installs. --no-build-isolation may be needed if your project has build-time requirements beyond setuptools and wheel. By passing this flag, you are responsible for making sure your environment already has the required dependencies to build your package. Once the legacy mechanism is removed, --use-pep517 will have no effect and will essentially be enabled by default in this context. Major changes made here include: - Add `--use-pep517` to use the modern mechanism, which will be the only mechanism in future pip releases - Change to `/src` layout to appease mypy, and because for editable installs that really is the normal way these days. - `cd acme && mkdir src && mv acme src/` etc. - add `where='src'` argument to `find_packages` and add `package_dir={'': 'src'},` in `setup.py`s - update `MANIFEST.in` files with new path locations - Update our many hardcoded filepaths - Update `importlib-metadata` requirement to fix double-plugin-entry-point problem in oldest tests
98 lines
3.9 KiB
Python
98 lines
3.9 KiB
Python
"""
|
|
The `~certbot_dns_linode.dns_linode` plugin automates the process of
|
|
completing a ``dns-01`` challenge (`~acme.challenges.DNS01`) by creating, and
|
|
subsequently removing, TXT records using the Linode API.
|
|
|
|
.. note::
|
|
The plugin is not installed by default. It can be installed by heading to
|
|
`certbot.eff.org <https://certbot.eff.org/instructions#wildcard>`_, choosing your system and
|
|
selecting the Wildcard tab.
|
|
|
|
Named Arguments
|
|
---------------
|
|
|
|
========================================== ===================================
|
|
``--dns-linode-credentials`` Linode credentials_ INI file.
|
|
(Required)
|
|
``--dns-linode-propagation-seconds`` The number of seconds to wait for
|
|
DNS to propagate before asking the
|
|
ACME server to verify the DNS
|
|
record.
|
|
(Default: 120 because Linode
|
|
updates its first DNS every 60
|
|
seconds and we allow 60 more seconds
|
|
for the update to reach other 5
|
|
servers)
|
|
========================================== ===================================
|
|
|
|
|
|
Credentials
|
|
-----------
|
|
|
|
Use of this plugin requires a configuration file containing Linode API
|
|
credentials, obtained from your Linode account's `Applications & API
|
|
Tokens page (legacy) <https://manager.linode.com/profile/api>`_ or `Applications
|
|
& API Tokens page (new) <https://cloud.linode.com/profile/tokens>`_.
|
|
|
|
.. code-block:: ini
|
|
:name: credentials.ini
|
|
:caption: Example credentials file:
|
|
|
|
# Linode API credentials used by Certbot
|
|
dns_linode_key = 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ64
|
|
|
|
The path to this file can be provided interactively or using the
|
|
``--dns-linode-credentials`` command-line argument. Certbot records the path
|
|
to this file for use during renewal, but does not store the file's contents.
|
|
|
|
.. caution::
|
|
You should protect these API credentials as you would the password to your
|
|
Linode account. Users who can read this file can use these credentials
|
|
to issue arbitrary API calls on your behalf. Users who can cause Certbot to
|
|
run using these credentials can complete a ``dns-01`` challenge to acquire
|
|
new certificates or revoke existing certificates for associated domains,
|
|
even if those domains aren't being managed by this server.
|
|
|
|
Certbot will emit a warning if it detects that the credentials file can be
|
|
accessed by other users on your system. The warning reads "Unsafe permissions
|
|
on credentials configuration file", followed by the path to the credentials
|
|
file. This warning will be emitted each time Certbot uses the credentials file,
|
|
including for renewal, and cannot be silenced except by addressing the issue
|
|
(e.g., by using a command like ``chmod 600`` to restrict access to the file).
|
|
|
|
|
|
Examples
|
|
--------
|
|
|
|
.. code-block:: bash
|
|
:caption: To acquire a certificate for ``example.com``
|
|
|
|
certbot certonly \\
|
|
--dns-linode \\
|
|
--dns-linode-credentials ~/.secrets/certbot/linode.ini \\
|
|
-d example.com
|
|
|
|
.. code-block:: bash
|
|
:caption: To acquire a single certificate for both ``example.com`` and
|
|
``www.example.com``
|
|
|
|
certbot certonly \\
|
|
--dns-linode \\
|
|
--dns-linode-credentials ~/.secrets/certbot/linode.ini \\
|
|
-d example.com \\
|
|
-d www.example.com
|
|
|
|
.. code-block:: bash
|
|
:caption: To acquire a certificate for ``example.com``, waiting 120 seconds
|
|
for DNS propagation (Linode updates its first DNS every minute
|
|
and we allow some extra time for the update to reach other 5
|
|
servers)
|
|
|
|
certbot certonly \\
|
|
--dns-linode \\
|
|
--dns-linode-credentials ~/.secrets/certbot/linode.ini \\
|
|
--dns-linode-propagation-seconds 120 \\
|
|
-d example.com
|
|
|
|
"""
|