qbittorrent-exporter

qbittorrent-exporter

Docker app from wupasscat's Repository

Overview

This app is a Prometheus exporter for the qBittorrent application.

qbittorrent-exporter

Gradle Build Release

This app is a Prometheus exporter for the qBittorrent application. You must have version 4.1.0 of qBittorrent or higher for this plugin to work.

This is especially useful when integrated with the qbittorrent-grafana-dashboard.

See it on DockerHub.

Usage

docker

docker run \
    --name=qbittorrent-exporter \
    -e QBITTORRENT_USERNAME=username \
    -e QBITTORRENT_PASSWORD=password \
    -e QBITTORRENT_BASE_URL=http://localhost:8080 \
    -p 17871:17871 \
    caseyscarborough/qbittorrent-exporter:latest

Parameters

Parameter Function Default Value
-p 17871 The webservice port. N/A
-e QBITTORRENT_USERNAME The qBittorrent username. admin
-e QBITTORRENT_PASSWORD The qBittorrent password. adminadmin
-e QBITTORRENT_BASE_URL The qBittorrent base URL. http://localhost:8080
-e QBITTORRENT_HOST The qBittorrent host. Ignored when using QBITTORRENT_BASE_URL. localhost
-e QBITTORRENT_PORT The qBittorrent port. Ignored when using QBITTORRENT_BASE_URL. 8080
-e QBITTORRENT_PROTOCOL The qBittorrent protocol. Ignored when using QBITTORRENT_BASE_URL. http

Setup

Add the target to your scrape_configs in your prometheus.yml configuration file of your Prometheus server.

scrape_configs:

  - job_name: 'qbittorrent'
    static_configs:

      # Update your IP address and port here
      - targets: [ '192.168.1.100:17871' ]

Building Locally

Build the app and the docker container using the following commands:

./gradlew build
docker build .

Install qbittorrent-exporter on Unraid in a few clicks.

Find qbittorrent-exporter in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for qbittorrent-exporter Review the template variables and paths Click Install

Requirements

qBittorrent version 4.1.0 or higher

Download Statistics

522,204
Total Downloads
9,512
This Month
9,808
Avg / Month

Total Downloads Over Time

Loading chart...

Related apps

Explore more like this

Explore all

Details

Repository
caseyscarborough/qbittorrent-exporter
Last Updated2023-10-23
First Seen2023-02-17

Runtime arguments

Network
bridge
Shell
sh
Privileged
false

Template configuration

qBittorrent HostVariable

Hostname/IP of your qBittorrent instance

Target
QBITTORRENT_BASE_URL
qBittorrent UserVariable

Username to your qBittorrent instance

Target
QBITTORRENT_USERNAME
qBittorrent PasswordVariable

Password to your qBittorrent instance

Target
QBITTORRENT_PASSWORD
PortPorttcp

Port for the exporter

Target
17871
Default
17871
Value
17871