{"id":13551409,"url":"https://github.com/ch3p4ll3/QBittorrentBot","last_synced_at":"2025-04-03T01:32:37.608Z","repository":{"id":43598750,"uuid":"210440343","full_name":"ch3p4ll3/QBittorrentBot","owner":"ch3p4ll3","description":"This bot can control qbittorrent easily from Telegram! You can add magnet or torrent files, have a list of active downloads, delete, pause and restart downloads.","archived":false,"fork":false,"pushed_at":"2024-07-09T15:38:43.000Z","size":753,"stargazers_count":64,"open_issues_count":2,"forks_count":28,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-01T12:24:38.643Z","etag":null,"topics":["bot","docker","docker-image","dockerfile","dockerhub","pyrogram","pyrogram-bot","qbittorrent","qbittorrent-api","qbittorrent-webui","telegram","telegram-bot","telegrambot","torrent"],"latest_commit_sha":null,"homepage":"https://ch3p4ll3.github.io/QBittorrentBot/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ch3p4ll3.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"docs/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-23T19:54:02.000Z","updated_at":"2024-07-22T03:51:14.000Z","dependencies_parsed_at":"2024-01-20T15:22:59.852Z","dependency_job_id":"db2c0597-e03b-4b0b-acae-b776410a4cc4","html_url":"https://github.com/ch3p4ll3/QBittorrentBot","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ch3p4ll3%2FQBittorrentBot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ch3p4ll3%2FQBittorrentBot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ch3p4ll3%2FQBittorrentBot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ch3p4ll3%2FQBittorrentBot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ch3p4ll3","download_url":"https://codeload.github.com/ch3p4ll3/QBittorrentBot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222905880,"owners_count":17055818,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","docker","docker-image","dockerfile","dockerhub","pyrogram","pyrogram-bot","qbittorrent","qbittorrent-api","qbittorrent-webui","telegram","telegram-bot","telegrambot","torrent"],"created_at":"2024-08-01T12:01:47.684Z","updated_at":"2024-11-03T21:32:14.660Z","avatar_url":"https://github.com/ch3p4ll3.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"![GitHub License](https://img.shields.io/github/license/ch3p4ll3/QBittorrentBot)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/259099080ca24e029a910e3249d32041)](https://app.codacy.com/gh/ch3p4ll3/QBittorrentBot?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=ch3p4ll3/QBittorrentBot\u0026utm_campaign=Badge_Grade)\n![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/ch3p4ll3/QBittorrentBot/docker-image.yml)\n![Docker Pulls](https://img.shields.io/docker/pulls/ch3p4ll3/qbittorrent-bot)\n\n\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\n# QBittorrentBot\n\nWith this bot telegram you can manage your qbittorrent with a few simple clicks. Thanks to QBittorrentBot you can have a list of all the files in download / upload, add torrents and magnets.  \nYou can add more magnets by simply placing one link per line, e.g. \n```\nmagnet:?xt=...  \nmagnet:?xt=...  \n```\nYou can also pause, resume, delete and add/remove and modify categories.\n\n# Table Of Contents\n- [QBittorrentBot](#qbittorrentbot)\n- [Table Of Contents](#table-of-contents)\n  - [Warning!](#warning)\n  - [Configuration](#configuration)\n    - [Retrieve Telegram API ID and API HASH](#retrieve-telegram-api-id-and-api-hash)\n    - [JSON Configuration](#json-configuration)\n  - [Running](#running)\n    - [Build docker](#build-docker)\n    - [Running without docker](#running-without-docker)\n  - [Contributing Translations on Transifex](#contributing-translations-on-transifex)\n  - [How to enable the qBittorrent Web UI](#how-to-enable-the-qbittorrent-web-ui)\n  - [Contributors ✨](#contributors-)\n\n\n## Warning!\nSince version V2, the mapping of the configuration file has been changed. Make sure you have modified it correctly before starting the bot\n\n## Configuration\n### Retrieve Telegram API ID and API HASH\nWith the change of library to [pyrogram](https://docs.pyrogram.org/) you will need the API_ID and API_HASH. Check [here](https://core.telegram.org/api/obtaining_api_id) to find out how to recover them.\n### JSON Configuration\nEdit the config.json.template file and rename it to config.json. \nThe config file is stored in the mounted /app/config/ volume\n\n```json5\n{\n    \"client\": {\n        \"type\": \"qbittorrent\",\n        \"host\": \"http://192.168.178.102:8080\",\n        \"user\": \"admin\",\n        \"password\": \"admin\"\n    },\n    \"telegram\": {\n        \"bot_token\": \"1111111:AAAAAAAA-BBBBBBBBB\",\n        \"api_id\": 1111,\n        \"api_hash\": \"aaaaaaaa\",\n        \"proxy\": {  // optional\n            \"scheme\": \"http\",\n            \"hostname\": \"myproxy.local\",\n            \"port\": 8080,\n            \"username\": \"admin\",  // optional\n            \"password\": \"admin\"  // optional\n        }\n    },\n\n    \"users\": [\n        {\n            \"user_id\": 123456,\n            \"notify\": false,\n            \"locale\": \"en\",  // optional, default \"en\"\n            \"role\": \"administrator\"  // optional, default \"administrator\"\n        },\n        {\n            \"user_id\": 78910,\n            \"notify\": true,\n            \"locale\": \"it\",\n            \"role\": \"administrator\"\n        }\n    ]\n}\n```\nNote: If notify is true then the user will receive a notification whenever a torrent has finished downloading\n\n## Running\nPull and run the image with: `docker run -d -v /home/user/docker/QBittorrentBot:/app/config:rw --name qbittorrent-bot ch3p4ll3/qbittorrent-bot:latest`\n### Build docker\n- Clone this repo ```git clone https://github.com/ch3p4ll3/QBittorrentBot.git```\n- Move in the project directory\n- Create a config.json file\n- Run `docker build -t qbittorrent-bot:latest . \u0026\u0026 docker run -d -v /home/user/docker/QBittorrentBot:/app/config:rw --name qbittorrent-bot qbittorrent-bot:latest`\n\n### Running without docker\n- Clone this repo `git clone https://github.com/ch3p4ll3/QBittorrentBot.git`\n- Move in the project directory\n- Install dependencies with `pip3 install -r requirements.txt`\n- Create a config.json file\n- Start the bot with `python3 main.py`\n\n## Contributing Translations on Transifex\nQBittorrentBot is an open-source project that relies on the contributions of its community members to provide translations for its users. If you are multilingual and would like to help us make QBittorrentBot more accessible to a wider audience, you can contribute by adding new translations or improving existing ones using Transifex:\n\n- Visit the [QBittorrentBot Transifex Project](https://app.transifex.com/ch3p4ll3/qbittorrentbot/).\n\n- If you don't have a Transifex account, sign up for one. If you already have an account, log in.\n\n- Navigate to the \"Languages\" tab to view the available languages. Choose the language you want to contribute to.\n\n- Locate the specific string you wish to translate. Please note that the text between \"${\" and \"}\" should not be edited, as they are placeholders for dynamic content.\n\n- Click on the string you want to translate, enter your translation in the provided field, and save your changes.\n\n- If your language is not listed, you can request its addition.\n\n- Once you have completed your translations, submit them for review. The project maintainers will review and approve your contributions.\n\nThank you for helping improve QBittorrentBot with your valuable translations!\n\n## How to enable the qBittorrent Web UI\nFor the bot to work, it requires qbittorrent to have the web interface active. \nYou can activate it by going on the menu bar, go to **Tools \u003e Options** qBittorrent WEB UI\n\n- In the new window, choose **Web UI** option\n- Check the **Enable the Web User Interface (Remote control)** option\n- Choose a port (by default 8080)\n- Set username and password (by default username: admin / password: adminadmin)\n\nClick on Ok to save settings.\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/bushig\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/2815779?v=4?s=100\" width=\"100px;\" alt=\"Bogdan\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eBogdan\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/ch3p4ll3/QBittorrentBot/commits?author=bushig\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/joey00797\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/52893618?v=4?s=100\" width=\"100px;\" alt=\"joey00797\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003ejoey00797\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#translation-joey00797\" title=\"Translation\"\u003e🌍\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n## Star History\n\n[![Star History Chart](https://api.star-history.com/svg?repos=ch3p4ll3/QBittorrentBot\u0026type=Date)](https://star-history.com/#ch3p4ll3/QBittorrentBot\u0026Date)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fch3p4ll3%2FQBittorrentBot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fch3p4ll3%2FQBittorrentBot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fch3p4ll3%2FQBittorrentBot/lists"}