Skip to content

Commit b0007a0

Browse files
committed
docs
1 parent 251f0f0 commit b0007a0

File tree

4 files changed

+26
-12
lines changed

4 files changed

+26
-12
lines changed

docs/src/components/buildinfo-introduction.astro

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
import { Code } from "@astrojs/starlight/components";
33
const response = await fetch(
4-
"https://github.com/userdocs/qbt-workflow-files/releases/latest/download/dependency-version.json"
4+
"https://github.com/userdocs/qbt-workflow-files/releases/latest/download/dependency-version.json",
55
);
66
77
const data = await response.json();
88
9-
const codeblock = `qBittorrent ${data.qbittorrent || "4.6.3"} was built with the following libraries:
10-
Qt: ${data.qt6 || "6.6.2"}
11-
Libtorrent: ${data.libtorrent_2_0 || "2.0.10"}
12-
Boost: ${data.boost || "1.84.0"}
13-
OpenSSL: ${data.openssl || "3.2.1"}
14-
zlib: ${data.zlib || "1.3.2"}-motley`;
9+
const codeblock = `qBittorrent ${data.qbittorrent || "5.1.2"} was built with the following libraries:
10+
Qt: ${data.qt6 || "6.9.1"}
11+
Libtorrent: ${data.libtorrent_2_0 || "2.0.11"}
12+
Boost: ${data.boost || "1.89.0"}
13+
OpenSSL: ${data.openssl || "3.5.2"}
14+
zlib: ${data.zlib || "1.3.1.1"}-motley`;
1515
1616
// {
1717
// "glibc_2_31": "2.31",

docs/src/content/docs/build-help.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -275,11 +275,11 @@ Here are the list of supported modules:
275275
```bash
276276
glibc (Debian based only)
277277
zlib (default)
278-
iconv (default)
278+
iconv (default libtorrent v1.2 only)
279279
icu (optional)
280280
openssl (default)
281281
boost (default)
282-
double_conversion (default for Qt6 on a modern OS - Bullseye / Jammy)
282+
double_conversion (default for Qt6 on a modern OS)
283283
qtbase (default)
284284
qttools (default)
285285
libtorrent (default)

docs/src/content/docs/script-installation.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,15 @@ Some notes on the dockers method:
2929
- We use `-e "LANG=C.UTF-8"` with Debian based images to avoid some UTF errors.
3030

3131
:::tip[env file]
32+
You do not need to configure the env while bootstrapping the container. It can be done after via the `.qbt_env` file or exporting them.
33+
3234
There are multiple ways to pass an env file when using Docker.
3335

3436
- You can use the `--env-file` switch when creating the docker and provide a file with your [envs](/qbittorrent-nox-static/build-help#env-settings).
3537
- If a `.qbt_env` file is found in the same directory as the script, it will be used automatically.
3638
- Using ENV in a dockerfile is also possible.
39+
40+
The easist method is the `.qbt_env` as the script has support flags for this purpose.
3741
:::
3842

3943
</TabItem>
@@ -73,7 +77,7 @@ docker run -it -w /root -p 8080:8080 -e "LANG=C.UTF-8" -v ~/qbt:/root debian:lat
7377
If you need to download the script use this command
7478

7579
```bash
76-
curl --sLO https://raw.githubusercontent.com/userdocs/qbittorrent-nox-static/refs/heads/master/qbt-nox-static.bash && chmod +x qbt-nox-static.bash
80+
curl -sLO https://raw.githubusercontent.com/userdocs/qbittorrent-nox-static/refs/heads/master/qbt-nox-static.bash && chmod +x qbt-nox-static.bash
7781
```
7882

7983
</TabItem>

docs/src/content/docs/script-usage.mdx

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ Don't run this directly on the host system unless you know what you are doing. I
2121

2222
### Execute the script
2323

24+
:::caution[A reminder about the `.qbt_env`]
25+
If you have a `.qbt_env` in the same folder as the script it will override any custom env settings you provide.
26+
27+
Using flags will override your `.qbt_env`
28+
:::
29+
2430
```bash
2531
./qbt-nox-static.bash
2632
```
@@ -41,7 +47,11 @@ By passing `all` as the first argument, you can build everything based on the de
4147
./qbt-nox-static.bash all
4248
```
4349

44-
For example, to use `ICU` using `-i`, optimise for the host system CPU using `-o` to set `-march=native` and `-s` to strip the binary and build using libtorrent v1.2.19
50+
For example of using custom settings,
51+
52+
- to use `ICU` using `-i`
53+
- optimise for the host system CPU using `-o` to set `-march=native`
54+
- build using libtorrent v1.2.19
4555

4656
```bash
4757
./qbt-nox-static.bash all -i -o -s -lt v1.2.19
@@ -50,7 +60,7 @@ For example, to use `ICU` using `-i`, optimise for the host system CPU using `-o
5060
Same as previous command but using `env` settings
5161

5262
```bash
53-
qbt_libtorrent_tag="v1.2.19" qbt_skip_icu="yes" qbt_optimise_strip="yes" qbt_optimize="yes" ./qbt-nox-static.bash all
63+
qbt_libtorrent_tag="v1.2.19" qbt_skip_icu="yes" qbt_optimize="yes" ./qbt-nox-static.bash all
5464
```
5565

5666
For an older version of qBittorrent, you can specify the version using `-qt` and the libtorrent version using `-lt`

0 commit comments

Comments
 (0)