Skip to content

Commit

Permalink
Add docs re: collision of ProxyCommand and env.gateway
Browse files Browse the repository at this point in the history
  • Loading branch information
bitprophet committed Nov 6, 2012
1 parent ef160ed commit d9f119d
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/usage/execution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -716,3 +716,13 @@ If enabled, the following SSH config directives will be loaded and honored by Fa
:ref:`env.gateway <gateway>` to be a more efficient connection method
(which will also honor more Fabric-level settings) than the typical ``ssh
gatewayhost nc %h %p`` method of using ``ProxyCommand`` as a gateway.

.. note::
If your SSH config file contains ``ProxyCommand`` directives *and* you have
set :ref:`env.gateway <gateway>` to a non-``None`` value, ``env.gateway``
will take precedence and the ``ProxyCommand`` will be ignored.

If one has a pre-created SSH config file, rationale states it will be
easier for you to modify ``env.gateway`` (e.g. via
`~fabric.context_managers.settings`) than to work around your conf file's
contents entirely.

0 comments on commit d9f119d

Please sign in to comment.