From 07b4250aea7ef9240504c322c1ab1554a9394303 Mon Sep 17 00:00:00 2001 From: Dan <14043624+delivrance@users.noreply.github.com> Date: Thu, 18 Jan 2018 13:23:05 +0100 Subject: [PATCH] Add proxy documentation --- docs/source/index.rst | 1 + docs/source/resources/ProxyServer.rst | 29 +++++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 docs/source/resources/ProxyServer.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 87867fc0..2a18feda 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -102,6 +102,7 @@ To get started, press Next. resources/TextFormatting resources/UpdateHandling resources/ErrorHandling + resources/ProxyServer .. toctree:: :hidden: diff --git a/docs/source/resources/ProxyServer.rst b/docs/source/resources/ProxyServer.rst new file mode 100644 index 00000000..1486c93e --- /dev/null +++ b/docs/source/resources/ProxyServer.rst @@ -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 = + 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. \ No newline at end of file