Skip to content

Commit 2f1276c

Browse files
miss-islingtonzoobahugovk
authored
[3.15] Add documentation on PyManager proxy setting overrides (GH-156768) (#157288)
Co-authored-by: Steve Dower <steve.dower@python.org> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
1 parent 6a93c91 commit 2f1276c

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
@@ -934,6 +934,37 @@ checking for that feed.
934934
}
935935
936936
937+
Proxy settings
938+
--------------
939+
940+
.. versionadded:: 26.4
941+
942+
By default, the Python install manager will use your system-wide proxy settings,
943+
including automatic authentication. For most users, this behaves the same as
944+
your browser and other applications.
945+
946+
To override the settings, use the ``NO_PROXY``, ``HTTP_PROXY`` and
947+
``HTTPS_PROXY`` environment variables. These should be set in the terminal
948+
session before using the Python install manager. Other applications may also
949+
use the variables, so use caution before setting them globally for your entire
950+
machine.
951+
952+
Setting ``NO_PROXY`` to any non-empty value will disable the use of any proxy.
953+
Use this to bypass your system's default proxy setting and attempt to access the
954+
index server directly.
955+
956+
Setting ``HTTPS_PROXY`` to a string like ``example.com:8080`` will connect to
957+
that proxy server for all HTTPS connections. For the default index, all
958+
connections will be using HTTPS, and so this is the usual setting to override.
959+
960+
The ``HTTP_PROXY`` variable may be needed if you are using a private index
961+
server that does not use encrypted connections, but does require the default
962+
proxy server to be overridden. It follows the same format as ``HTTPS_PROXY``.
963+
964+
Credentials may be embedded in either setting, however, when ``HTTPS_PROXY`` has
965+
credentials embedded they will be used in preference to other credentials. Only
966+
one set of credentials will be used for both types of proxy.
967+
937968
.. _pymanager-troubleshoot:
938969

939970
Troubleshooting

0 commit comments

Comments
 (0)