qbittorrent integration - panuozzo77/StreamingCommunity GitHub Wiki
This section documents the configuration settings for integrating StreamingCommunity with qBittorrent, allowing you to download content via torrent using qBittorrent's web API.
These settings are found in the QBIT_CONFIG
section of the config.json
file:
{
"QBIT_CONFIG": {
"host": "192.168.1.51",
"port": "6666",
"user": "admin",
"pass": "adminadmin"
}
}
- Type: String
-
Default:
"192.168.1.51"
- Description: The IP address or hostname of the qBittorrent server. This can be a local IP address if qBittorrent is running on your local network, or a remote address if you're connecting to a remote server.
- Usage: Enter the IP address or hostname where your qBittorrent WebUI is accessible.
- Type: String
-
Default:
"6666"
- Description: The port number on which the qBittorrent WebUI is running. This must match the port configured in your qBittorrent settings.
- Usage: Enter the port number configured for the qBittorrent WebUI.
- Type: String
-
Default:
"admin"
- Description: The username for authenticating with the qBittorrent WebUI. This must match a valid username configured in your qBittorrent settings.
- Usage: Enter your qBittorrent WebUI username.
- Type: String
-
Default:
"adminadmin"
- Description: The password for authenticating with the qBittorrent WebUI. This must match the password for the specified username.
- Usage: Enter your qBittorrent WebUI password.
Before you can use the qBittorrent integration, you need to enable and configure the qBittorrent WebUI:
-
Open qBittorrent on your system.
-
Access Preferences:
- On Windows/Linux: Tools > Preferences
- On macOS: qBittorrent > Preferences
-
Enable Web UI:
- Navigate to "Web UI" in the left sidebar
- Check "Web User Interface (Remote Control)"
- Set your preferred IP address and port
- Configure authentication settings (username and password)
- Click "Apply" to save changes
-
Update Configuration:
- Update the
QBIT_CONFIG
section in yourconfig.json
file to match your qBittorrent WebUI settings
- Update the
For detailed instructions on enabling the qBittorrent WebUI, refer to the qBittorrent WebUI Setup Guide.
-
Network Security: The qBittorrent WebUI transmits login credentials and torrent data. It's recommended to:
- Use HTTPS if connecting over the internet
- Restrict access to trusted networks
- Use a strong password
-
Authentication: Always change the default username and password to prevent unauthorized access.
-
Firewall Configuration: Ensure your firewall allows connections to the configured port.
When the qBittorrent integration is properly configured, StreamingCommunity can:
- Send magnet links or torrent files to qBittorrent
- Monitor download progress
- Access completed downloads
This integration is particularly useful for:
- Downloading content from torrent sites
- Managing downloads through qBittorrent's interface
- Leveraging qBittorrent's advanced features like scheduling and bandwidth management
You can access and modify these settings programmatically:
from StreamingCommunity.Util.config_json import config_manager
# Get a configuration value
qbit_host = config_manager.get('QBIT_CONFIG', 'host')
# Set a configuration value
config_manager.set_key('QBIT_CONFIG', 'host', '192.168.1.100')
config_manager.save_config()
-
Connection Refused
- Verify qBittorrent is running
- Check that the WebUI is enabled
- Ensure the IP address and port are correct
- Check firewall settings
-
Authentication Failed
- Verify username and password are correct
- Check if authentication is required in qBittorrent settings
-
Cannot Add Torrents
- Verify you have write permissions to the download directory
- Check if qBittorrent has reached its maximum number of active torrents
If you encounter issues not covered here:
- Check the Common Issues section
- Visit the GitHub Issues page
- Join the Discord community for support
- DEFAULT Settings - Configure general application behavior
- Output Folder Settings - Configure where downloaded content is saved