docs

Author: userdocs

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

@@ -56,8 +56,17 @@ You can export these before you run the script to set them. The can be used for
 | `qbt_static_ish`                | `no`                                | `yes` `no`                   | `qbt_static_ish="no"`                               |
 
 <Details summary="Cross arch options">
-	`armel` `armhf` `armv7` `aarch64` `x86_64` `x86` `s390x` `powerpc` `ppc64el`
-	`mips` `mipsel` `mips64` `mips64el` `riscv64`
+	`armel` `armhf` `armv7` `aarch64`
+
+	`x86_64` `x86`
+
+	`s390x`
+
+	`powerpc` `ppc64el`
+
+	`mips` `mipsel` `mips64` `mips64el`
+
+	`riscv64`
 </Details>
 
 :::tip

docs/src/content/docs/introduction.mdx

@@ -14,15 +14,20 @@ import { Advanced, BuildInfo, Charts, Details, Modal, Steps, Tabs, TabItem, Card
 It handles a lot of the nuanced complexity around building various different dependencies on two different host platforms, towards the same outcome, whilst targeting these architectures:
 
 <Details summary=" target architectures">
-`aarch64` - `armel` - `armhf` - `armv7`
+	`armel` `armhf` `armv7` `aarch64`
 
-`x86` - `x86_64`
+	`x86_64` `x86`
 
-`powerpc` - `ppc64el`
+	`s390x`
 
-`mips` - `mipsel` - `mips64` - `mips64el`
+	`powerpc` `ppc64el`
+
+	`mips` `mipsel` `mips64` `mips64el`
+
+	`riscv64`
 </Details>
 
+
 ⭐ On supported host build platforms the `qbittorrent-nox-static.sh` will perform these three main tasks via simple prompt:
 
 <Steps>

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

@@ -5,18 +5,35 @@ description: Script Installation
 
 import { Advanced, Charts, Details, Modal, Steps, Tabs, TabItem, Card, CardGrid, LinkCard, Aside, Icon } from "/src/components/global.jsx"
 
-## Docker - Install commands
+:::note[Host environment]
+We do not support a non docker build environment. If you are not using docker, you are on your own.
+:::
+
+:::tip[Github Actions]
+If you cannot or don't want to use docker, you can use the [Github Actions](/qbittorrent-nox-static/github-actions) to build the project by forking the repository.
+:::
+
+## Bootstrapping the container
 
 <Tabs>
 <TabItem value="Notes" label="Notes">
 
 Some notes on the dockers method:
 
-- We use a subdirectory, not your `$HOME` directory, to avoid `.bashrc` and `.profile` conflicts.
+- The script itself install thes necessary dependencies so there is no docker file needed.
+- We use a subdirectory `qbt`, not your `$HOME` directory, to avoid `.bashrc` and `.profile` conflicts.
 - A subdirectory is automatically created, named `qbt` by the use of `-v $HOME/qbt:/root`
 - The default path will be `HOME/qbt` outside the docker container and `/root/qbt` inside it.
 - We use `-e "LANG=en_GB.UTF-8"` with Debian based images to avoid some errors.
 
+:::tip[env file]
+There are multiple ways to pass an env file when using Docker.
+
+- 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).
+- If a `.qbt_env` file is found in the same directory as the script, it will be used automatically.
+- Using ENV in a dockerfile is also possible.
+:::
+
 </TabItem>
 <TabItem value="Debian Linux" label="Debian">
 
@@ -27,32 +44,32 @@ You use `debian:bullseye` `debian:bookworm` `debian:latest` or a supported tag
 To bootstrap the container:
 
 ```bash
-docker run -it -w /root -e "LANG=en_GB.UTF-8" -v ~/qbt:/root debian:latest /bin/bash -c 'apt update && apt install -y curl && curl -sL git.io/qbstatic && bash'
+docker run -it -w /root -p 8080:8080 -e "LANG=en_GB.UTF-8" -v ~/qbt:/root debian:latest /bin/bash -c 'apt update && apt install -y curl && bash'
 ```
 
-All in one command:
+If you need to download the script use this command
 
 ```bash
-docker run -it -w /root -e "LANG=en_GB.UTF-8" -v ~/qbt:/root debian:latest /bin/bash -c 'apt update && apt install -y curl && curl -sL git.io/qbstatic | bash -s all'
+curl -sLo qbt-nox-static.sh git.io/qbstatic && chmod +x qbt-nox-static.sh
 ```
 
 </TabItem>
 <TabItem value="Ubuntu Linux" label="Ubuntu">
 
 :::note[tags]
-You use `ubuntu:focal` `ubuntu:jammy` `ubuntu:noble` `ubuntu:latest`
+You use `ubuntu:jammy` `ubuntu:noble` `ubuntu:latest`
 :::
 
 To bootstrap the container:
 
 ```bash
-docker run -it -w /root -e "LANG=en_GB.UTF-8" -v ~/qbt:/root ubuntu:latest /bin/bash -c 'apt update && apt install -y curl && bash'
+docker run -it -w /root -p 8080:8080 -e "LANG=en_GB.UTF-8" -v ~/qbt:/root ubuntu:latest /bin/bash -c 'apt update && apt install -y curl && bash'
 ```
 
-All in one command:
+If you need to download the script use this command
 
 ```bash
-docker run -it -w /root -e "LANG=en_GB.UTF-8" -v ~/qbt:/root ubuntu:latest /bin/bash -c 'apt update && apt install -y curl && curl -sL git.io/qbstatic | bash -s all'
+curl -sLo qbt-nox-static.sh git.io/qbstatic && chmod +x qbt-nox-static.sh
 ```
 
 </TabItem>
@@ -65,142 +82,16 @@ You use `alpine:edge` `alpine:latest`
 To bootstrap the container:
 
 ```bash
-docker run -it -w /root -v ~/qbt:/root alpine:edge /bin/ash -c 'apk update && apk add bash curl && bash'
-```
-
-All in one command:
-
-```bash
-docker run -it -w /root -v ~/qbt:/root alpine:edge /bin/ash -c 'apk update && apk add bash curl && curl -sL git.io/qbstatic | bash -s all'
-```
-</TabItem>
-</Tabs>
-
-## Host - Install commands
-
-<Tabs>
-<TabItem value="Debian" label="Debian">
-
-```bash
-wget -qO ~/qbittorrent-nox-static.sh https://git.io/qbstatic
-```
-
-</TabItem>
-<TabItem value="Alpine" label="Alpine">
-For Alpine specifically, you need to install bash to use this script.
-
-```bash
-apk add bash
-```
-
-To execute the script use this command:
-
-```bash
-wget -qO ~/qbittorrent-nox-static.sh https://git.io/qbstatic
-```
-</TabItem>
-</Tabs>
-
-## Post installation
-
-If you need to install the dependencies and you have `sudo` privileges then do this:
-
-:::caution
-This only needs to be done once, as root, to install the dependencies. Using certain enviroment variables or switches can add dependencies, like `-c` for cmake.
-
-You may need to escalate your privileges again.
-:::
-
-```bash
-sudo bash ~/qbittorrent-nox-static.sh
-```
-
-## Docker via SSH
-
-Some notes on the dockers method:
-
-- We use a subdirectory, not your `$HOME` directory, to avoid `.bashrc` and `.profile` conflicts.
-- A subdirectory is automatically created, named `qbt` by the use of `-v $HOME/qbt:/root`
-- The finale default path will be `HOME/qbt` outside the docker container and `/root/qbt` inside it.
-
-:::tip
-build envs can be passed to the docker using `-e` . Such as `-e qbt_cross_name=aarch64`
-:::
-
-<Tabs>
-  <TabItem label="Debian">
-
-:::tip
-You use `debian:bullseye` `debian:bookworm` `debian:latest`
-:::
-
-To bootstrap the container:
-
-```bash
-docker run -it -w /root -e "LANG=en_GB.UTF-8" -v ~/qbt:/root debian:latest /bin/bash -c 'apt update && apt install -y curl && bash'
-```
-
-All in one command:
-
-```bash
-docker run -it -w /root -e "LANG=en_GB.UTF-8" -v ~/qbt:/root debian:latest /bin/bash -c 'apt update && apt install -y curl && curl -sL git.io/qbstatic | bash -s all'
-```
-
-</TabItem>
-
-<TabItem label="Ubuntu">
-
-:::tip
-You use `ubuntu:focal` `ubuntu:jammy` `ubuntu:noble` `ubuntu:latest`
-:::
-
-To bootstrap the container:
-
-```bash
-docker run -it -w /root -e "LANG=en_GB.UTF-8" -v ~/qbt:/root ubuntu:latest /bin/bash -c 'apt update && apt install -y curl && bash'
-```
-
-All in one command:
-
-```bash
-docker run -it -w /root -e "LANG=en_GB.UTF-8" -v ~/qbt:/root ubuntu:latest /bin/bash -c 'apt update && apt install -y curl && curl -sL git.io/qbstatic | bash -s all'
-```
-
-</TabItem>
-
-<TabItem label="Alpine">
-
-:::tip
-You use `alpine:edge` `alpine:latest`
-:::
-
-To bootstrap the container:
-
-```bash
-docker run -it -w /root -v ~/qbt:/root alpine:edge /bin/ash -c 'apk update && apk add bash curl && bash'
+docker run -it -w /root -p 8080:8080 -v ~/qbt:/root alpine:edge /bin/ash -c 'apk update && apk add bash curl && bash'
 ```
 
-All in one command:
+If you need to download the script use this command
 
 ```bash
-docker run -it -w /root -v ~/qbt:/root alpine:edge /bin/ash -c 'apk update && apk add bash curl && curl -sL git.io/qbstatic | bash -s all'
+curl -sLo qbt-nox-static.sh git.io/qbstatic && chmod +x qbt-nox-static.sh
 ```
 
 </TabItem>
 </Tabs>
 
-:::note
-Please see the [switches and flags summary](/build-help?id=switches-and-flags-summarised) to see what options you can pass and how to use them
-:::
-
-You can modify the installation command by editing this part of the docker command.
-
-```bash
-bash -s all
-```
-
-For example, to use `ICU` using `-i`, `-c` to trigger cmake and in turn activate Qt6 and optimise for the system CPU using `-o`:
-
-```bash
-bash -s all -i -c -o
-```
+You are now ready to run the script.

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

@@ -17,39 +17,40 @@ The guide will assume you are using docker, with example commands that are eithe
 Don't run this directly on the host system unless you know what you are doing. It's not recommended and the build will probably fail.
 :::
 
-
 <Details summary="What to expect">![](/qbittorrent-nox-static/docs_images/script_usage/first-run.png)</Details>
 
-⭐ When you are familiar with the script you can do anything you want with a one liner. It's pretty simple to use.
-
-### Host - execute script
+⭐ When you are familiar with the script you can do most builds you want with a one liner. It's pretty simple to use.
 
-To execute the script use this command:
+### Execute the script
 
 ```bash
-chmod +x ~/qbt.sh # make it executable
+./qbt-nox-static.sh
 ```
 
-```bash
-~/qbt.sh
-```
-
-<Advanced>
-
 :::note
 Please see the [switches and flags summary](./build-help?id=switches-and-flags-summarised) to see what options you can pass and how to use them
 :::
 
-You can modify the installation command by editing this part of the docker command.
+The first thing you should do is to run the script with the `-h` flag to see the help output and the script defaults.
 
 ```bash
-bash -s all
+./qbt-nox-static.sh -h
 ```
 
-For example, to use `ICU` using `-i`, `-c` to trigger cmake and in turn activate Qt6 and optimise for the system CPU using `-o`:
+By passing `all` as the first argument, you can build everything based on the default settings.
 
 ```bash
-bash -s all -i -c -o
+./qbt-nox-static.sh all
 ```
 
-</Advanced>
+For example, to use `ICU` using `-i`, optimise for the host system CPU using `-o`, `-s` to strip the binary and build using libtorrent v1.2.19
+
+```bash
+./qbt-nox-static.sh all -i -o -s -lt v1.2.19
+```
+
+Same as previous command but using `env` settings
+
+```bash
+qbt_libtorrent_tag="v1.2.19" qbt_skip_icu="yes" qbt_optimise_strip="yes" qbt_optimize="-march=native" ./qbt-nox-static.sh all
+```