Update Compilation-Alpine-Linux.md (#14)

Userdocs 2024-10-19 05:36:16 +01:00 committed by GitHub
parent 7075471c8d
commit 0125f5a755
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

@ -1,72 +1,76 @@
# Alpine Linux build instructions
This guide will help you install qBittorrent on Alpine Linux using a combination of packages installed using `apk` and dependencies built using `cmake`.
This guide will help you install qBittorrent on Alpine Linux
This guide should work in any [Alpine arch](http://dl-cdn.alpinelinux.org/alpine/latest-stable/main) as long as the required [packages dependencies](https://pkgs.alpinelinux.org) are available to install for that arch. This guide was tested on `x86_64`
> [!NOTE]
>
> - This guide should work in any [Alpine arch](http://dl-cdn.alpinelinux.org/alpine/latest-stable/main) as long as the required [packages dependencies](https://pkgs.alpinelinux.org) are available to install for that arch. This guide was tested on `x86_64`
>
> - This guide will install qBittorrent and dependencies using shared libraries. At the point of writing this guide the latest version of Alpine is `3.20`
>
> - Check out the [common information](https://github.com/qbittorrent/qBittorrent/wiki/Compilation-with-CMake-common-information) page to learn more about the available build configuration options for qBittorrent (for example, to compile qBittorrent without the GUI) and also CMake itself, if you're new to it.
This guide will install qBittorrent and dependencies using shared libraries. At the point of writing this guide the latest version of Alpine is `3.13`
The majority of these commands are copy and paste but some can be modified. For example, in the libtorrent section there is a choice between libtorrent `v1` or `v2`. Check the notes and commented commands for more information.
Check out the [common information](https://github.com/qbittorrent/qBittorrent/wiki/Compilation-with-CMake-common-information) page to learn more about the available build configuration options for qBittorrent (for example, to compile qBittorrent without the GUI) and also CMake itself, if you're new to it.
> [!IMPORTANT]
> The majority of these commands are copy and paste but some can be modified. For example, in the libtorrent section there is a choice between libtorrent `v1` or `v2`. Check the notes and commented commands for more information.
## Build dependencies
These are the build dependencies we need to install using `apk`
```ash
apk add autoconf automake build-base cmake curl git libtool linux-headers perl pkgconf python3 python3-dev re2c tar
```shell
apk add build-base cmake curl git linux-headers ninja-build ninja-is-really-ninja python3 re2c tar xz
```
## Application dependencies
These are application dependencies we need to install using `apk`
The `iconv` libraries needed for `libtorrent` v1.2 are built into `/usr/lib/libc.so` so we do not need to install `iconv` as a dependency.
> [!WARNING]
> If you are using a desktop and want the GUI for qBittorrent, you will need to append the dependency `qt6-qtsvg-dev` to the command below
```ash
apk add icu-dev libexecinfo-dev openssl-dev qt5-qtbase-dev qt5-qttools-dev zlib-dev qt5-qtsvg-dev
```
## Ninja build
⚠️ There is no `apk` version for Alpine `3.12` or greater so we need to build it. It won't take long.
```bash
git clone --shallow-submodules --recurse-submodules https://github.com/ninja-build/ninja.git ~/ninja && cd ~/ninja
git checkout "$(git tag -l --sort=-v:refname "v*" | head -n 1)"
cmake -Wno-dev -B build \
-D CMAKE_CXX_STANDARD=17 \
-D CMAKE_INSTALL_PREFIX="/usr/local"
cmake --build build
cmake --install build
```shell
apk add icu-dev openssl-dev qt6-qtbase-dev qt6-qttools-dev zlib-dev
```
## Boost build files
All we need to bootstrap boost is to download and extract the files. There is nothing to build at this step.
> [!TIP]>
> This command should provide the latest non beta release info from Github
>
> - `curl -sL https://api.github.com/repos/boostorg/boost/releases | jq -r '.[0].name | select(contains("beta") | not)'`
>
> You can view all the tags for the boost Github repository here:
>
> - https://github.com/boostorg/boost/tags
Download and extract the boost files.
```bash
curl -sNLk https://boostorg.jfrog.io/artifactory/main/release/1.76.0/source/boost_1_76_0.tar.gz -o "$HOME/boost_1_76_0.tar.gz"
tar xf "$HOME/boost_1_76_0.tar.gz" -C "$HOME"
> [!NOTE]
> All we need to bootstrap boost is to download and extract the files. There is nothing to build at this step.
Bootstrap boost dev files
```shell
mkdir -p ~/boost-dev
curl -L https://github.com/boostorg/boost/releases/latest/download/boost-1.86.0-b2-nodocs.tar.xz -o ~/boost.tar.xz
tar xf ~/boost.tar.xz --strip-components=1 -C ~/boost-dev
```
## Libtorrent
Download and build libtorrent by checking out the `RC_1_2` branch. You can also change the `git checkout` command filter `"v1*"` to `"v2*"` to use the latest version of a specific tag
Any tag can be used to checkout the version you want - https://github.com/arvidn/libtorrent/tags
> [!TIP]
> Any tag can be used to checkout the version you want - https://github.com/arvidn/libtorrent/tags
```bash
```shell
git clone --shallow-submodules --recurse-submodules https://github.com/arvidn/libtorrent.git ~/libtorrent && cd ~/libtorrent
# git checkout "$(git tag -l --sort=-v:refname "v2*" | head -n 1)" # always checkout the latest release of libtorrent v2
git checkout "$(git tag -l --sort=-v:refname "v1*" | head -n 1)" # always checkout the latest release of libtorrent v1
# git checkout "$(git tag -l --sort=-v:refname | awk '/v2/' | head -1)" # always checkout the latest release of libtorrent v2
git checkout "$(git tag -l --sort=-v:refname | awk '/v1/' | head -1)" # always checkout the latest release of libtorrent v1
cmake -Wno-dev -G Ninja -B build \
-D CMAKE_BUILD_TYPE="Release" \
-D CMAKE_CXX_STANDARD=17 \
-D BOOST_INCLUDEDIR="$HOME/boost_1_76_0/" \
-D CMAKE_CXX_STANDARD=20 \
-D BOOST_INCLUDEDIR="$HOME/boost-dev/" \
-D CMAKE_INSTALL_LIBDIR="lib" \
-D CMAKE_INSTALL_PREFIX="/usr/local"
cmake --build build
@ -77,33 +81,51 @@ cmake --install build
Build and install qBittorrent
Any tag can be used to checkout the version you want - https://github.com/qbittorrent/qBittorrent/tags
> [!TIP]
> Any tag can be used to checkout the version you want - https://github.com/qbittorrent/qBittorrent/tags
⚠️ You are most likely not using a GUI (desktop) with Alpine, so remember to pass `-D GUI=OFF`.
> [!WARNING]
> You are most likely not using a GUI (desktop) with Alpine, so remember we pass `-D GUI=OFF`.
> Removing `-D GUI=OFF` will build the desktop version `qbittorrent` instead of the cli `qbittorrent-nox`
>
> qBittorrent v5 made Qt6 the default and removed support for Qt5 builds.
> To manually set the Qt used for v4 or earlier you can used this `cmake` option `-D QT6=ON` or `-D QT6=OFF`
```bash
This command will build qBittorrent `v5` with Libtorrent `v1.2` using `Qt6`, the defaults at the time of this guide.
```shell
git clone --shallow-submodules --recurse-submodules https://github.com/qbittorrent/qBittorrent.git ~/qbittorrent && cd ~/qbittorrent
git checkout "$(git tag -l --sort=-v:refname | head -n 1)" # always checkout the latest release of qbittorrent
git checkout "$(git tag -l --sort=-v:refname | awk '!/[0-9][a-zA-Z]/' | head -1)" # always checkout the latest release of qbittorrent
cmake -Wno-dev -G Ninja -B build \
-D CMAKE_BUILD_TYPE="release" \
-D CMAKE_CXX_STANDARD=17 \
-D BOOST_INCLUDEDIR="$HOME/boost_1_76_0/" \
-D CMAKE_CXX_STANDARD_LIBRARIES="/usr/lib/libexecinfo.so" \
-D CMAKE_INSTALL_PREFIX="/usr/local"
-D CMAKE_CXX_STANDARD=20 \
-D BOOST_INCLUDEDIR="$HOME/boost-dev/" \
-D CMAKE_INSTALL_PREFIX="/usr/local" \
-D GUI=OFF
cmake --build build
cmake --install build
```
Tidy up the downloaded build files
## Run the binary
```bash
cd && rm -rf qbittorrent libtorrent ninja boost_1_76_0 boost_1_76_0.tar.gz
You can now run `qbittorrent` or `qbittorrent-nox` as it will be in the path.
Desktop version: `-D GUI=ON`
```shell
qbittorrent
```
## Post build
cli version: `-D GUI=OFF`
You can now run `qbittorrent-no` as it will be in the path (or `qbittorrent`, if you build with the GUI).
```bash
```shell
qbittorrent-nox
```
## Post installation
Tidy up: Delete the downloaded build files and folders
```shell
cd && rm -rf qbittorrent libtorrent boost-dev ~/boost.tar.xz
```