diff --git a/docs/index.rst b/docs/index.rst index 4b336654..9b2ae695 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -151,6 +151,23 @@ 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, to use a proxy for just the ``twine`` command, +without ``export``-ing it for other tools: + +.. code-block:: bash + + HTTPS_PROXY=socks5://user:pass@host:port twine upload dist/* + +For more information, see the Requests documentation on +`proxies `_ and +`SOCKS `_ , and +`an in-depth article about proxy environment variables +`_. + Keyring Support ---------------