Skip to content

Commit

Permalink
Beef up mentions of the need for Invoke, when using Match exec, in th…
Browse files Browse the repository at this point in the history
…e docs
  • Loading branch information
bitprophet committed Dec 3, 2019
1 parent d3b481d commit df8765f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
14 changes: 9 additions & 5 deletions sites/docs/api/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion sites/www/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit df8765f

Please sign in to comment.