Xtao-Labs/MTPyroger
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update ConfigurationFile.rst

Browse Source
This commit is contained in:
Dan 2019-01-25 09:40:55 +01:00
parent c17bf3c64c
commit e4c8592616
1 changed files with 26 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/source/resources/ConfigurationFile.rst
View File

@ -9,7 +9,7 @@ Introduction
The idea behind using a configuration file is to help keeping your code free of settings (private) information such as The idea behind using a configuration file is to help keeping your code free of settings (private) information such as
the API Key and Proxy without having you to even deal with how to load such settings. The configuration file, usually the API Key and Proxy without having you to even deal with how to load such settings. The configuration file, usually
referred as ``config.ini` file, is automatically loaded from the root of your working directory; all you need to do is referred as ``config.ini`` file, is automatically loaded from the root of your working directory; all you need to do is
fill in the necessary parts. fill in the necessary parts.
.. note:: .. note::
@ -25,9 +25,9 @@ fill in the necessary parts.
The config.ini File The config.ini File
------------------- -------------------
By default, Pyrogram will look for a file named ``config.ini`` placed at the root of your working directory, that is, in By default, Pyrogram will look for a file named ``config.ini`` placed at the root of your working directory, that is,
the same folder of your running script. You can change the name or location of your configuration file by specifying the same folder of your running script. You can change the name or location of your configuration file by specifying it
that in your Client's parameter *config_file*. in your Client's parameter *config_file*.
- Replace the default *config.ini* file with *my_configuration.ini*: - Replace the default *config.ini* file with *my_configuration.ini*:
@ -41,13 +41,12 @@ that in your Client's parameter *config_file*.
Configuration Sections Configuration Sections
---------------------- ----------------------
There are all the sections Pyrogram uses in its configuration file: These are all the sections Pyrogram uses in its configuration file:
Pyrogram Pyrogram
^^^^^^^^ ^^^^^^^^
The ``pyrogram`` section is used to store Telegram credentials, namely the API Key, which consists of two parts: The ``[pyrogram]`` section contains your Telegram API credentials *api_id* and *api_hash*.
*api_id* and *api_hash*.
.. code-block:: ini .. code-block:: ini
@ -55,12 +54,12 @@ The ``pyrogram`` section is used to store Telegram credentials, namely the API K
api_id = 12345 api_id = 12345
api_hash = 0123456789abcdef0123456789abcdef api_hash = 0123456789abcdef0123456789abcdef
`More info <../start/Setup.html#configuration>`_ `More info about API Key. <../start/Setup.html#configuration>`_
Proxy Proxy
^^^^^ ^^^^^
The ``proxy`` section contains settings about your SOCKS5 proxy. The ``[proxy]`` section contains settings about your SOCKS5 proxy.
.. code-block:: ini .. code-block:: ini
@ -71,3 +70,21 @@ The ``proxy`` section contains settings about your SOCKS5 proxy.
username = <your_username> username = <your_username>
password = <your_password> password = <your_password>
`More info about SOCKS5 Proxy. <SOCKS5Proxy.html>`_
Plugins
^^^^^^^
The ``[plugins]`` section contains settings about Smart Plugins.
.. code-block:: ini
[plugins]
root = plugins
include =
module
folder.module
exclude =
module fn2
`More info about Smart Plugins. <SmartPlugins.html>`_