#
Configuration File
The configuration file serves as a central repository for all the necessary information that the QBittorrentBot needs to operate effectively. It defines the connection parameters, credentials, and user settings that the bot utilizes to interact with the qBittorrent server and Telegram API.
Below you can find an example of the configuration file:
{
"client": {
"type": "qbittorrent",
"host": "http://192.168.178.102",
"user": "admin",
"password": "admin"
},
"telegram": {
"bot_token": "1111111:AAAAAAAA-BBBBBBBBB",
"api_id": 1111,
"api_hash": "aaaaaaaa"
},
"users": [
{
"user_id": 123456,
"notify": false,
"role": "administrator"
}
]
}
Here's a brief overview of the configuration file and its key sections:
Clients Section: Establishes the connection details for the qBittorrent server, including the hostname, port number, username, and password. This enables the bot to interact with the qBittorrent server and manage torrents.
Telegram Section: Contains the bot token, API ID, and API hash, which are essential for authenticating the bot with the Telegram API. These credentials allow the bot to communicate with the Telegram server and receive user commands. Click here to find out how to retrive your API ID and API Hash
Users Section: Lists the authorized users of the QBittorrentBot, along with their Telegram user IDs, notification preferences, and user roles. This section defines the users who can interact with the bot, receive notifications, and manage torrents.
#
Client
This section defines the configuration for the qBittorrent client that the bot will be interacting with.
#
Telegram
This section defines the configuration for the Telegram bot that the QBittorrentBot will be communicating with.
#
Users
This section defines the list of users who are authorized to use the QBittorrentBot. Each user is defined by their Telegram user ID, whether or not they should be notified about completed torrents, and their role.
#
Enums
#
ClientTypeEnum
#
UserRolesEnum
#
Telegram Proxy Scheme
#
Other types
#
HttpUrl
A type that will accept any http or https URL.
- TLD required
- Host required
- Max length 2083
#
Languages
#
Telegram Proxy Settings
QBittorrentBot supports proxies with and without authentication. This feature allows QBittorrentBot to exchange data with Telegram through an intermediate SOCKS 4/5 or HTTP proxy server.