{"id":13548148,"url":"https://github.com/crazy-max/docker-qbittorrent","last_synced_at":"2025-04-14T05:35:31.911Z","repository":{"id":36351126,"uuid":"217752671","full_name":"crazy-max/docker-qbittorrent","owner":"crazy-max","description":"qBittorrent Docker image","archived":false,"fork":false,"pushed_at":"2024-06-23T15:15:09.000Z","size":226,"stargazers_count":74,"open_issues_count":2,"forks_count":15,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-29T14:19:18.177Z","etag":null,"topics":["alpine-linux","docker","docker-compose","qbittorrent","qbittorrent-nox","traefik"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crazy-max.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":".github/SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"crazy-max","custom":"https://www.paypal.me/crazyws"}},"created_at":"2019-10-26T18:32:21.000Z","updated_at":"2024-10-05T04:41:04.000Z","dependencies_parsed_at":"2023-12-30T20:27:31.023Z","dependency_job_id":"a580de2e-a01a-4ed1-b3f7-082697bcd336","html_url":"https://github.com/crazy-max/docker-qbittorrent","commit_stats":null,"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazy-max%2Fdocker-qbittorrent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazy-max%2Fdocker-qbittorrent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazy-max%2Fdocker-qbittorrent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazy-max%2Fdocker-qbittorrent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crazy-max","download_url":"https://codeload.github.com/crazy-max/docker-qbittorrent/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248829158,"owners_count":21168162,"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":["alpine-linux","docker","docker-compose","qbittorrent","qbittorrent-nox","traefik"],"created_at":"2024-08-01T12:01:06.357Z","updated_at":"2025-04-14T05:35:31.881Z","avatar_url":"https://github.com/crazy-max.png","language":"Dockerfile","funding_links":["https://github.com/sponsors/crazy-max","https://www.paypal.me/crazyws"],"categories":["Dockerfile","docker"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003ca href=\"https://github.com/crazy-max/docker-qbittorrent\" target=\"_blank\"\u003e\u003cimg height=\"128\" src=\".github/docker-qbittorrent.jpg\"\u003e\u003c/a\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://hub.docker.com/r/crazymax/qbittorrent/tags?page=1\u0026ordering=last_updated\"\u003e\u003cimg src=\"https://img.shields.io/github/v/tag/crazy-max/docker-qbittorrent?label=version\u0026style=flat-square\" alt=\"Latest Version\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/crazy-max/docker-qbittorrent/actions?workflow=build\"\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/crazy-max/docker-qbittorrent/build.yml?branch=master\u0026label=build\u0026logo=github\u0026style=flat-square\" alt=\"Build Status\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://hub.docker.com/r/crazymax/qbittorrent/\"\u003e\u003cimg src=\"https://img.shields.io/docker/stars/crazymax/qbittorrent.svg?style=flat-square\u0026logo=docker\" alt=\"Docker Stars\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://hub.docker.com/r/crazymax/qbittorrent/\"\u003e\u003cimg src=\"https://img.shields.io/docker/pulls/crazymax/qbittorrent.svg?style=flat-square\u0026logo=docker\" alt=\"Docker Pulls\"\u003e\u003c/a\u003e\n  \u003cbr /\u003e\u003ca href=\"https://github.com/sponsors/crazy-max\"\u003e\u003cimg src=\"https://img.shields.io/badge/sponsor-crazy--max-181717.svg?logo=github\u0026style=flat-square\" alt=\"Become a sponsor\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.paypal.me/crazyws\"\u003e\u003cimg src=\"https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal\u0026style=flat-square\" alt=\"Donate Paypal\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## About\n\n[qBittorrent](https://www.qbittorrent.org/) Docker image.\n\n\u003e [!TIP] \n\u003e Want to be notified of new releases? Check out 🔔 [Diun (Docker Image Update Notifier)](https://github.com/crazy-max/diun)\n\u003e project!\n\n___\n\n* [Features](#features)\n* [Build locally](#build-locally)\n* [Image](#image)\n* [Environment variables](#environment-variables)\n* [Volumes](#volumes)\n* [Ports](#ports)\n* [Usage](#usage)\n  * [Docker Compose](#docker-compose)\n  * [Command line](#command-line)\n* [Upgrade](#upgrade)\n* [Notes](#notes)\n  * [qBittorrent Web API](#qbittorrent-web-api)\n  * [Change username and password](#change-username-and-password)\n  * [Watch torrents](#watch-torrents)\n* [Contributing](#contributing)\n* [License](#license)\n\n## Features\n\n* Run as non-root user\n* Multi-platform image\n* Latest [qBittorrent](https://github.com/qbittorrent/qBittorrent) / [libtorrent-rasterbar](https://github.com/arvidn/libtorrent) release compiled from source\n* WAN IP address automatically resolved for reporting to the tracker\n* Finished torrents automatically saved to `/data/torrents`\n* Handle [watch directory](#watch-torrents) from `/data/watch`\n* Ability to use an [alternative WebUI](https://github.com/qbittorrent/qBittorrent/wiki/Alternate-WebUI-usage) in `/data/webui`\n* Healthcheck through [qBittorrent API](https://github.com/qbittorrent/qBittorrent/wiki/Web-API-Documentation)\n* Logs managed through a [dedicated container](examples/traefik/compose.yml)\n* [Traefik](https://github.com/containous/traefik-library-image) as reverse proxy and creation/renewal of Let's Encrypt certificates (see [this template](examples/traefik))\n\n## Build locally\n\n```shell\ngit clone https://github.com/crazy-max/docker-qbittorrent.git\ncd docker-qbittorrent\n\n# Build image and output to docker (default)\ndocker buildx bake\n\n# Build multi-platform image\ndocker buildx bake image-all\n```\n\n## Image\n\n| Registry                                                                                         | Image                           |\n|--------------------------------------------------------------------------------------------------|---------------------------------|\n| [Docker Hub](https://hub.docker.com/r/crazymax/qbittorrent/)                                            | `crazymax/qbittorrent`                 |\n| [GitHub Container Registry](https://github.com/users/crazy-max/packages/container/package/qbittorrent)  | `ghcr.io/crazy-max/qbittorrent`        |\n\nFollowing platforms for this image are available:\n\n```\n$ docker buildx imagetools inspect crazymax/qbittorrent --format \"{{json .Manifest}}\" | \\\n  jq -r '.manifests[] | select(.platform.os != null and .platform.os != \"unknown\") | .platform | \"\\(.os)/\\(.architecture)\\(if .variant then \"/\" + .variant else \"\" end)\"'\n\nlinux/amd64\nlinux/arm/v6\nlinux/arm/v7\nlinux/arm64\n```\n\n## Environment variables\n\n* `TZ`: Timezone assigned to the container (default `UTC`)\n* `PUID`: qBittorrent user id (default `1000`)\n* `PGID`: qBittorrent group id (default `1000`)\n* `WAN_IP`: Public IP address reported to the tracker (default auto resolved with `dig +short myip.opendns.com @resolver1.opendns.com`)\n* `WEBUI_PORT`: WebUI port to be used (default `8080`)\n* `ALT_WEBUI`: Enable alternative WebUI located in `/data/webui` (default `false`)\n\n## Volumes\n\n* `/data`: qBittorrent config, downloads, temp, torrents, watch, webui...\n\n\u003e :warning: Note that the volumes should be owned by the user/group with the specified `PUID` and `PGID`.\n\u003e If you don't give the volume correct permissions, the container may not start.\n\n## Ports\n\n* `6881`: DHT port\n* `8080`: qBittorrent HTTP port\n\n## Usage\n\n### Docker Compose\n\nDocker compose is the recommended way to run this image. You can use the following\n[compose template](examples/compose/compose.yml), then run the container:\n\n```bash\n$ docker compose up -d\n$ docker compose logs -f\n```\n\n### Command line\n\nYou can also use the following minimal command:\n\n```bash\n$ docker run -d --name qbittorrent \\\n  --ulimit nproc=65535 \\\n  --ulimit nofile=32000:40000 \\\n  -p 6881:6881/tcp \\\n  -p 6881:6881/udp \\\n  -p 8080:8080 \\\n  -v $(pwd)/data:/data \\\n  crazymax/qbittorrent:latest\n```\n\n## Upgrade\n\nRecreate the container whenever I push an update:\n\n```bash\ndocker compose pull\ndocker compose up -d\n```\n\n## Notes\n\n### qBittorrent Web API\n\n[qBittorrent Web API](https://github.com/qbittorrent/qBittorrent/wiki/Web-API-Documentation) can be used within\nthis image using curl.\n\n```\n$ docker compose exec qbittorrent curl --fail http://127.0.0.1:8080/api/v2/app/version\nv4.1.8\n```\n\n### Change username and password\n\nYou can change the default username `admin` and password `adminadmin` through the API or WebUI.\n\n```shell\ndocker compose exec qbittorrent curl --fail -X POST \\\n  -d 'json={\"web_ui_username\":\"myuser\",\"web_ui_password\":\"mypassword\"}' \\\n  http://127.0.0.1:8080/api/v2/app/setPreferences\n```\n\n### Watch torrents\n\nYou can configure the monitored folders on the qBittorrent interface:\n\n![](.github/qbittorrent-watch.png)\n\nOr through the API:\n\n```shell\ndocker compose exec qbittorrent curl --fail -X POST \\\n  -d 'json={\"scan_dirs\":{\"/data/watch\": 1}}' \\\n  http://127.0.0.1:8080/api/v2/app/setPreferences\n```\n\n## Contributing\n\nWant to contribute? Awesome! The most basic way to show your support is to star\nthe project, or to raise issues. You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max)\nor by making a [PayPal donation](https://www.paypal.me/crazyws) to ensure this\njourney continues indefinitely!\n\nThanks again for your support, it is much appreciated! :pray:\n\n## License\n\nMIT. See `LICENSE` for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrazy-max%2Fdocker-qbittorrent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrazy-max%2Fdocker-qbittorrent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrazy-max%2Fdocker-qbittorrent/lists"}