Skip to content

Commit 8f84787

Browse files
authored
Add documentation on PyManager proxy setting overrides (GH-156768)
1 parent bba99f2 commit 8f84787

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

‎Doc/using/windows.rst‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -943,6 +943,37 @@ checking for that feed.
943943
}
944944
945945
946+
Proxy Settings
947+
--------------
948+
949+
.. versionadded:: 26.4
950+
951+
By default, the Python install manager will use your system-wide proxy settings,
952+
including automatic authentication. For most users, this behaves the same as
953+
your browser and other applications.
954+
955+
To override the settings, use the ``NO_PROXY``, ``HTTP_PROXY`` and
956+
``HTTPS_PROXY`` environment variables. These should be set in the terminal
957+
session before using the Python install manager. Other applications may also
958+
use the variables, so use caution before setting them globally for your entire
959+
machine.
960+
961+
Setting ``NO_PROXY`` to any non-empty value will disable the use of any proxy.
962+
Use this to bypass your system's default proxy setting and attempt to access the
963+
index server directly.
964+
965+
Setting ``HTTPS_PROXY`` to a string like ``example.com:8080`` will connect to
966+
that proxy server for all HTTPS connections. For the default index, all
967+
connections will be using HTTPS, and so this is the usual setting to override.
968+
969+
The ``HTTP_PROXY`` variable may be needed if you are using a private index
970+
server that does not use encrypted connections, but does require the default
971+
proxy server to be overridden. It follows the same format as ``HTTPS_PROXY``.
972+
973+
Credentials may be embedded in either setting, however, when ``HTTPS_PROXY`` has
974+
credentials embedded they will be used in preference to other credentials. Only
975+
one set of credentials will be used for both types of proxy.
976+
946977
.. _pymanager-troubleshoot:
947978

948979
Troubleshooting

0 commit comments

Comments
 (0)