qBittorrent/INSTALL

qBittorrent - A BitTorrent client in C++ / Qt
------------------------------------------

1) Install these dependencies:

  - Boost >= 1.76

  - libtorrent-rasterbar 1.2.19 - 1.2.x || 2.0.10 - 2.0.x
      * By Arvid Norberg, https://www.libtorrent.org/
      * Be careful: another library (the one used by rTorrent) uses a similar name

  - OpenSSL >= 3.0.2

  - Qt 6.5.0 - 6.x

  - zlib >= 1.2.11

  - CMake >= 3.16
      * Compile-time only

  - Python >= 3.9.0
      * Optional, run-time only
      * Used by the bundled search engine

Dependency version numbers are bumped every once in a while to keep the range of properly tested configurations manageable, even if not strictly required to build.
You may be able to build with older versions of (some of) the dependencies other than the minimum versions specified in the build scripts, but support for such builds is not provided - you are on your own.
Please ensure you are building with an officially supported configuration when reporting bugs.

2a) Compile and install qBittorrent with Qt graphical interface

  $ cmake -B build -DCMAKE_BUILD_TYPE=Release
  $ cmake --build build
  $ cmake --install build
  $ qbittorrent

  will install and execute qBittorrent.

2b) Compile and install qBittorrent without Qt graphical interface

  $ cmake -B build -DCMAKE_BUILD_TYPE=Release -DGUI=OFF
  $ cmake --build build
  $ cmake --install build
  $ qbittorrent-nox

  will install and execute qBittorrent.

DOCUMENTATION:
Please note that there is a "Compilation" section at https://wiki.qbittorrent.org.

------------------------------------------
sledgehammer999 <sledgehammer999@qbittorrent.org>
Update INSTALL file Closes #9385. 2018-08-28 06:15:20 +00:00			`qBittorrent - A BitTorrent client in C++ / Qt`
- Moved everything to trunk to create a stable branch 2006-09-30 16:02:39 +00:00			`------------------------------------------`

Update INSTALL dependencies 2019-03-02 04:58:37 +00:00			`1) Install these dependencies:`
- Moved everything to trunk to create a stable branch 2006-09-30 16:02:39 +00:00
Bump boost requirement to 1.76 std::hash specialisations for boost::asio structures is required. 2023-08-08 15:33:02 +00:00			`- Boost >= 1.76`
- Moved everything to trunk to create a stable branch 2006-09-30 16:02:39 +00:00
Raise minimum libtorrent 2 version to 2.0.10 PR #20447. 2024-04-21 06:52:51 +00:00			`- libtorrent-rasterbar 1.2.19 - 1.2.x \|\| 2.0.10 - 2.0.x`
Detect incompatible libtorrent v2 versions in build systems Although the detection is working, the error message in autotools is not perfect, i.e. it would only mention valid range for libtorrent v1 and it shouldn't be a problem since v2 support isn't fully ready yet. 2021-07-29 06:15:59 +00:00			`* By Arvid Norberg, https://www.libtorrent.org/`
Update INSTALL dependencies 2019-03-02 04:58:37 +00:00			`* Be careful: another library (the one used by rTorrent) uses a similar name`
- Moved everything to trunk to create a stable branch 2006-09-30 16:02:39 +00:00
Bump OpenSSL requirement to 3.0.2 Addresses: * [CVE-2022-0778](https://github.com/advisories/GHSA-x3mh-jvjw-3xwx) * [OpenSSL 1.1.1 End of Life](https://www.openssl.org/blog/blog/2023/09/11/eol-111/) PR #19638. 2023-09-26 03:51:53 +00:00			`- OpenSSL >= 3.0.2`
- Moved everything to trunk to create a stable branch 2006-09-30 16:02:39 +00:00
Raise minimum supported Qt version to 6.5 PR #19394. 2023-08-07 04:19:43 +00:00			`- Qt 6.5.0 - 6.x`
- Configure file now checks for pkg-config executable since it is required to detect libtorrent-rasterbar 2010-01-19 22:55:49 +00:00
Update minimum depedency versions 2020-12-04 12:16:04 +00:00			`- zlib >= 1.2.11`
- Moved everything to trunk to create a stable branch 2006-09-30 16:02:39 +00:00
Drop support of Autoconf/Automake and QMake PR #19335. 2023-07-20 08:15:46 +00:00			`- CMake >= 3.16`
			`* Compile-time only`
- Moved everything to trunk to create a stable branch 2006-09-30 16:02:39 +00:00
Bump Python version minimum requirement The new minimum version is Python 3.9. Debian Buster (oldoldstable) support ends at [2024.06.30](https://www.debian.org/releases/buster/). Ubuntu Focal (20.04LTS) support ends at [2025.04](https://ubuntu.com/about/release-cycle). By the time qbt v5.1 is released, Buster and Focal would have become EOL. https://packages.debian.org/search?keywords=python3 https://packages.ubuntu.com/search?keywords=python3 PR #21064. 2024-07-17 04:13:58 +00:00			`- Python >= 3.9.0`
Detect incompatible libtorrent v2 versions in build systems Although the detection is working, the error message in autotools is not perfect, i.e. it would only mention valid range for libtorrent v1 and it shouldn't be a problem since v2 support isn't fully ready yet. 2021-07-29 06:15:59 +00:00			`* Optional, run-time only`
			`* Used by the bundled search engine`
- Updated Changelog and INSTALL file 2010-01-02 22:29:36 +00:00
Update minimum depedency versions 2020-12-04 12:16:04 +00:00			`Dependency version numbers are bumped every once in a while to keep the range of properly tested configurations manageable, even if not strictly required to build.`
			`You may be able to build with older versions of (some of) the dependencies other than the minimum versions specified in the build scripts, but support for such builds is not provided - you are on your own.`
			`Please ensure you are building with an officially supported configuration when reporting bugs.`

Update INSTALL dependencies 2019-03-02 04:58:37 +00:00			`2a) Compile and install qBittorrent with Qt graphical interface`
- Updated Changelog and INSTALL file 2010-01-02 22:29:36 +00:00
Drop support of Autoconf/Automake and QMake PR #19335. 2023-07-20 08:15:46 +00:00			`$ cmake -B build -DCMAKE_BUILD_TYPE=Release`
			`$ cmake --build build`
			`$ cmake --install build`
Update INSTALL dependencies 2019-03-02 04:58:37 +00:00			`$ qbittorrent`
- Updated Changelog and INSTALL file 2010-01-02 22:29:36 +00:00
Update INSTALL file Closes #9385. 2018-08-28 06:15:20 +00:00			`will install and execute qBittorrent.`
- Updated Changelog and INSTALL file 2010-01-02 22:29:36 +00:00
Update INSTALL dependencies 2019-03-02 04:58:37 +00:00			`2b) Compile and install qBittorrent without Qt graphical interface`
- Updated Changelog and INSTALL file 2010-01-02 22:29:36 +00:00
Drop support of Autoconf/Automake and QMake PR #19335. 2023-07-20 08:15:46 +00:00			`$ cmake -B build -DCMAKE_BUILD_TYPE=Release -DGUI=OFF`
			`$ cmake --build build`
			`$ cmake --install build`
Update INSTALL dependencies 2019-03-02 04:58:37 +00:00			`$ qbittorrent-nox`
- Added a line in INSTALL to advise gnome users to install qt4-qtconfig package 2007-02-19 13:51:17 +00:00
Update INSTALL dependencies 2019-03-02 04:58:37 +00:00			`will install and execute qBittorrent.`
- Added geoip-database as an optional dependency in INSTALL file 2009-12-07 20:57:59 +00:00
- added doc url in INSTALL file 2007-07-24 06:20:32 +00:00			`DOCUMENTATION:`
Switch URLs to https PR #18876. 2023-04-23 07:09:58 +00:00			`Please note that there is a "Compilation" section at https://wiki.qbittorrent.org.`
- Moved everything to trunk to create a stable branch 2006-09-30 16:02:39 +00:00
			`------------------------------------------`
Update INSTALL file Closes #9385. 2018-08-28 06:15:20 +00:00			`sledgehammer999 <sledgehammer999@qbittorrent.org>`