j4nk
/
xmpp-qbittorrent-bot
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

Add README

This commit is contained in:
j4nk 2024-07-28 18:14:20 -04:00
parent afd5e895c2
commit 379e4af2f8
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# xmpp-qbittorrent-bot
## Introduction
A bot designed for XMPP MUCs that queries a qbittorrent WebUI API.
## Configuration
Copy config.conf.template to config.conf, and fill out the fields
| Key | Value |
|---------------|----------------------------------|
| qb\_jid | JID that the bot should log into |
| qb\_pass | Password for the JID |
| qb\_muc | The MUC the bot should connect to |
| qb\_nick | The nickname in the MUC the bot should have |
| api\_url | The base url for the qbittorrent WebUI API |
| api\_user | The username for the qbittorrent WebUI account |
| api\_pass | The password for the qbittorrent WebUI account |
## Starting
### Native
python3 bot.py
### Docker/Podman
`{docker,podman}-compose up`