Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a section about proxy support #814

Merged
merged 8 commits into from Sep 19, 2021
Merged
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/index.rst
Expand Up @@ -151,6 +151,31 @@ on a CI/build server).
* ``TWINE_NON_INTERACTIVE`` - Do not interactively prompt for username/password
if the required credentials are missing.

Proxy Support
^^^^^^^^^^^^^

Twine can be configured to use a proxy by setting environment variables.
For example:

.. code-block:: bash

export HTTPS_PROXY=socks5://user:pass@host:port

twine upload dist/*
dukecat0 marked this conversation as resolved.
Show resolved Hide resolved

Alternatively, one can set the environment variable for the command
itself without exporting it for other tools as well:

.. code-block:: bash

HTTPS_PROXY=socks5://user:pass@host:port twine upload dist/*
dukecat0 marked this conversation as resolved.
Show resolved Hide resolved

For more information, see the Requests documentation on
`proxies <https://docs.python-requests.org/en/master/user/advanced/#proxies>`_ and
`SOCKS <https://docs.python-requests.org/en/master/user/advanced/#socks>`_ , and
`an in-depth article about proxy environment variables
<https://about.gitlab.com/blog/2021/01/27/we-need-to-talk-no-proxy/>`_.

dukecat0 marked this conversation as resolved.
Show resolved Hide resolved
Keyring Support
---------------

Expand Down