diff options
| author | Jeff Forcier <jeff@bitprophet.org> | 2019-12-03 10:42:58 -0500 |
|---|---|---|
| committer | Jeff Forcier <jeff@bitprophet.org> | 2019-12-03 10:50:46 -0500 |
| commit | df8765f940c496b5dd42b0896e2f246ba1e2394d (patch) | |
| tree | 875ca5f71b4d402cc3d08b7169509295b9a1b79b | |
| parent | d3b481d1db05dab8745222888482f86d8805160f (diff) | |
Beef up mentions of the need for Invoke, when using Match exec, in the docs
| -rw-r--r-- | sites/docs/api/config.rst | 14 | ||||
| -rw-r--r-- | sites/www/installing.rst | 3 |
2 files changed, 11 insertions, 6 deletions
diff --git a/sites/docs/api/config.rst b/sites/docs/api/config.rst index 8ee0b444..1c3af085 100644 --- a/sites/docs/api/config.rst +++ b/sites/docs/api/config.rst @@ -61,11 +61,15 @@ Paramiko releases) are included. A keyword by itself means no known departures. - ``Host`` - ``HostName``: used in ``%h`` :ref:`token expansion <TOKENS>` -- ``Match``: fully supported, with the usual caveat that connection-time - information is not present during config lookup, and thus cannot be used to - determine matching. This primarily impacts ``Match user``, which can match - against loaded ``User`` values but has no knowledge about connection-time - usernames. +- ``Match``: fully supported, with the following caveats: + + - You must have the optional dependency Invoke installed; see :ref:`the + installation docs <paramiko-itself>` (in brief: install + ``paramiko[invoke]`` or ``paramiko[everything]``). + - As usual, connection-time information is not present during config + lookup, and thus cannot be used to determine matching. This primarily + impacts ``Match user``, which can match against loaded ``User`` values + but has no knowledge about connection-time usernames. .. versionadded:: 2.7 diff --git a/sites/www/installing.rst b/sites/www/installing.rst index ee57bdfc..4b2680a4 100644 --- a/sites/www/installing.rst +++ b/sites/www/installing.rst @@ -37,7 +37,8 @@ There are also a number of **optional dependencies** you may install using .. TODO 3.0: tweak the ed25519 line to remove the caveat - If you want all optional dependencies at once, use ``paramiko[everything]``. -- For ``Match exec`` config support, use ``paramiko[invoke]``. +- For ``Match exec`` config support, use ``paramiko[invoke]`` (which installs + `Invoke <https://www.pyinvoke.org>`_). - For GSS-API / SSPI support, use ``paramiko[gssapi]``, though also see :ref:`the below subsection on it <gssapi>` for details. - ``paramiko[ed25519]`` references the dependencies for Ed25519 key support. |