Add proxy documentation
This commit is contained in:
parent
ed88885070
commit
07b4250aea
@ -102,6 +102,7 @@ To get started, press Next.
|
|||||||
resources/TextFormatting
|
resources/TextFormatting
|
||||||
resources/UpdateHandling
|
resources/UpdateHandling
|
||||||
resources/ErrorHandling
|
resources/ErrorHandling
|
||||||
|
resources/ProxyServer
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:hidden:
|
:hidden:
|
||||||
|
29
docs/source/resources/ProxyServer.rst
Normal file
29
docs/source/resources/ProxyServer.rst
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
Proxy Server
|
||||||
|
============
|
||||||
|
|
||||||
|
Pyrogram supports SOCKS5 proxies with and without authentication. This feature allows Pyrogram to exchange data with
|
||||||
|
Telegram through an intermediate SOCKS5 proxy server.
|
||||||
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
|
||||||
|
To use Pyrogram with a proxy, simply append the following to your ``config.ini`` file and replace the values
|
||||||
|
with your own settings:
|
||||||
|
|
||||||
|
.. code-block:: ini
|
||||||
|
|
||||||
|
[proxy]
|
||||||
|
enabled = True
|
||||||
|
hostname = 11.22.33.44
|
||||||
|
port = 1080
|
||||||
|
username = <your_username>
|
||||||
|
password = <your_password>
|
||||||
|
|
||||||
|
- To enable or disable the proxy without deleting your settings from the config file,
|
||||||
|
change the ``enabled`` value as follows:
|
||||||
|
|
||||||
|
- ``1``, ``yes``, ``True`` or ``on``: Enables the proxy
|
||||||
|
- ``0``, ``no``, ``False`` or ``off``: Disables the proxy
|
||||||
|
|
||||||
|
- If your proxy doesn't require authorization you can omit username and password by either leaving the values blank
|
||||||
|
or completely delete the lines.
|
Loading…
Reference in New Issue
Block a user