Skip to content

Commit 5400055

Browse files
[3.14] Add documentation on PyManager proxy setting overrides (GH-156768)
(cherry picked from commit 8f84787) Co-authored-by: Steve Dower <steve.dower@python.org>
1 parent c8d0aa9 commit 5400055

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

941972
Troubleshooting

0 commit comments

Comments
 (0)