mirror of
https://github.com/qbittorrent/wiki.git
synced 2024-11-26 19:30:30 +00:00
Fix typos
This commit is contained in:
Chocobo1
parent
cd05ba0e3d
commit
52654f8999
12
.github/workflows/helper/pre-commit/.typos.toml
vendored
12
.github/workflows/helper/pre-commit/.typos.toml
vendored
@ -4,15 +4,7 @@
|
||||
# try adding to `identifiers` list first, if doesn't work then `words` list
|
||||
|
||||
[default.extend-identifiers]
|
||||
additionals = "additionals"
|
||||
caf = "caf"
|
||||
curren = "curren"
|
||||
FO = "FO"
|
||||
ket = "ket"
|
||||
Q_INVOKABLE = "Q_INVOKABLE"
|
||||
switchs = "switchs"
|
||||
ths = "ths"
|
||||
BigSur = "BigSur"
|
||||
mak = "mak"
|
||||
|
||||
[default.extend-words]
|
||||
BA = "BA"
|
||||
helo = "helo"
|
||||
|
||||
@ -123,7 +123,7 @@ Password: adminadmin
|
||||
|
||||
Documentation about running qBittorrent without GUI is available [here](https://github.com/qbittorrent/qBittorrent/wiki/Running-qBittorrent-without-X-server-(WebUI-only)).
|
||||
|
||||
To set up qbittorrent as a deamon see [this guide](https://github.com/qbittorrent/qBittorrent/wiki/Setting-up-qBittorrent-as-a-daemon-on-CentOS-7)
|
||||
To set up qbittorrent as a daemon see [this guide](https://github.com/qbittorrent/qBittorrent/wiki/Setting-up-qBittorrent-as-a-daemon-on-CentOS-7)
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@ This page describes the process of building qBittorrent on Windows targeting x86
|
||||
|
||||
> Note: Qt5 is currently not supported by qBittorrent.
|
||||
+ 4.8.4 is used in this article.
|
||||
+ If you can't download from the official site with official links use a direct link like that: `https://releases.qt-project.org/qt4/source/qt-everywhere-opensource-src-VERSION.tar.gz` where `VERSION` is, for exmaple, `4.8.4`
|
||||
+ If you can't download from the official site with official links use a direct link like that: `https://releases.qt-project.org/qt4/source/qt-everywhere-opensource-src-VERSION.tar.gz` where `VERSION` is, for example, `4.8.4`
|
||||
+ An example direct link: [https://releases.qt-project.org/qt4/source/qt-everywhere-opensource-src-4.8.4.tar.gz](https://releases.qt-project.org/qt4/source/qt-everywhere-opensource-src-4.8.4.tar.gz)
|
||||
1. Latest version of [Boost](http://www.boost.org/users/download/).
|
||||
+ 1.52 is used in this article.
|
||||
|
||||
@ -160,7 +160,7 @@ NOTE: Review [Ubuntu/Debian compilation guide](https://github.com/qbittorrent/qB
|
||||
|
||||
The binary should be located at `/usr/local/bin/qbittorrent-nox`. If `qbittorrent-nox` was installed using `apt` then that binary will be at `/usr/bin/qbittorrent-nox`. _Do not confuse them!_
|
||||
|
||||
**Web UI access informations**
|
||||
**Web UI access information**
|
||||
* _http://localhost:8080_
|
||||
* Username: _admin_
|
||||
* Password: _adminadmin_
|
||||
|
||||
@ -43,7 +43,7 @@ The procedure for compiling and installing Libtorrent on B-Pro is derived from t
|
||||
sudo apt-get install checkinstall
|
||||
|
||||
Your system could be configured with some option that might interfere with checkinstall.
|
||||
If previous installation fails then procede manually:
|
||||
If previous installation fails then proceed manually:
|
||||
|
||||
sudo apt-get install build-essential checkinstall libboost-system-dev libboost-python-dev libssl-dev libgeoip-dev
|
||||
|
||||
@ -77,7 +77,7 @@ To overcome this error and configure correctly you must issue the following comm
|
||||
|
||||
`sudo checkinstall`
|
||||
|
||||
_[ The `checkinstall `command replaces the `make install`. It created a DEB Package for easier removal/re-install trough dpkg. ]_
|
||||
_[ The `checkinstall `command replaces the `make install`. It created a DEB Package for easier removal/re-install through dpkg. ]_
|
||||
|
||||
`sudo ldconfig`
|
||||
|
||||
@ -150,7 +150,7 @@ To overcome this error and configure correctly you must issue the following comm
|
||||
|
||||
_[alternatively you can use the standard command `make install`, as discussed before]_
|
||||
|
||||
**That's it! qBittorrent should now be installed.** You could simply launch Qbittorrent-nox using the following comand:
|
||||
**That's it! qBittorrent should now be installed.** You could simply launch Qbittorrent-nox using the following command:
|
||||
|
||||
'qbittorrent-nox'
|
||||
|
||||
@ -195,7 +195,7 @@ _**Please Note:**_ **the following solution is based upon personal research** an
|
||||
_The following commands are based upon the assumption that you are running qBittorrent under a dedicated user._
|
||||
If you are running it under the 'bananapi' root user you need to execute the following with 'root privileges'.
|
||||
|
||||
Exceute the following command:
|
||||
Execute the following command:
|
||||
|
||||
`crontab -e`
|
||||
|
||||
@ -213,7 +213,7 @@ If you want to try it just reboot you B-Pro with the command:
|
||||
|
||||
## Final Notes
|
||||
|
||||
This work has been realized putting togheter personal knowledge and information provided by other authors.
|
||||
This work has been realized putting together personal knowledge and information provided by other authors.
|
||||
|
||||
**Credits are as follows:**
|
||||
|
||||
|
||||
@ -59,7 +59,7 @@ Downloading process consists of few steps: cloning the root repo and then clonin
|
||||
```bash
|
||||
git clone https://code.qt.io/qt/qt5.git
|
||||
cd qt5
|
||||
git checkout v5.15.2 # tag in Qt repository, 5.15.2 was the lastest at the time of writing
|
||||
git checkout v5.15.2 # tag in Qt repository, 5.15.2 was the latest at the time of writing
|
||||
```
|
||||
|
||||
Now it's time to download modules. The required modules set is slightly different depending on the qBittorrent version use are building. Suggested set assumes master version, if you want to build 4.3.x just add `qtmacextras` to list:
|
||||
@ -90,7 +90,7 @@ Actually boost is not required to be built. All parts required by libtorrent are
|
||||
|
||||
### OpenSSL
|
||||
|
||||
OpenSSL supports out-of-tree builds, so let's use it to not bloat source folder with any binaries and allow to re-use it if more that one build is planned (for both architectures).
|
||||
OpenSSL supports out-of-tree builds, so let's use it to not bloat source folder with any binaries and allow to reuse it if more that one build is planned (for both architectures).
|
||||
|
||||
```bash
|
||||
mkdir build-openssl && cd build-openssl
|
||||
@ -158,7 +158,7 @@ Nothing special is required to build Qt for x86_64 host, but some adjustments ar
|
||||
|
||||
First trick is required when building on Apple Silicon based Mac (regardless for which target architecture), without it Qt build system produces x86_64 binaries instead of arm64 even for tools required at build time, what leads to build errors (because binaries can be launched). File `qt5/qtbase/mkspecs/common/macx.conf` must be edited. Variable `QMAKE_APPLE_DEVICE_ARCHS` in it must have the value corresponding to *host architecture* (i.e. arm64 in case of Apple Silicon), so it must be adjusted if necessary.
|
||||
|
||||
Also let's cahnge `QMAKE_MACOSX_DEPLOYMENT_TARGET` to newer `10.14` allowing Qt to benefit from new C++17 features. Without this adjustment option forcing C++17 usage can't be used and configure command will fail.
|
||||
Also let's change `QMAKE_MACOSX_DEPLOYMENT_TARGET` to newer `10.14` allowing Qt to benefit from new C++17 features. Without this adjustment option forcing C++17 usage can't be used and configure command will fail.
|
||||
|
||||
Next trick is required for cross-compilation, for host-only builds it is not required. Qt has so-called mkspecs for a lot of compiler/architecture build variants. These mkspecs contain a set of configuration files used by build system to produce binaries for required architecture. Unfortunately, there are no any mkspecs applicable to clang compiler targeting arm64 (or x86_64 in case of cross-compilation on arm64 host), especially taking into account macOS specifics. so they must be created. Fortunately, there is mkspec used for host macOS build, and it can be copied and adapted easily for required target architecture.
|
||||
|
||||
@ -238,4 +238,4 @@ Happy building!
|
||||
About this document
|
||||
-------------------
|
||||
|
||||
As afterwords, it is worth to mention how this document is appeared. Someday on qBittorrent GitHub page author found an issue requesting Apple M1 support. That days an author already had suitable hardware (MacBook Pro 13 M1 2020) got from his office due to work responsibilities and decided to try to build qBittorrent on it... And that worked! Later he found the way to do cross-compilation to make it possible to get arm64 binaries using x86_64 host. This guide is result of that research and almost completely repeats the authors steps made this possible, but in much cleaner way. Also there is the [script](https://gist.github.com/Kolcha/3ccd533123b773ba110b8fd778b1c2bf) allowing to build qBittorrent master branch for desired architecture in "fully automatic mode". Script was also written by the same author as this guide.
|
||||
As afterwards, it is worth to mention how this document is appeared. Someday on qBittorrent GitHub page author found an issue requesting Apple M1 support. That days an author already had suitable hardware (MacBook Pro 13 M1 2020) got from his office due to work responsibilities and decided to try to build qBittorrent on it... And that worked! Later he found the way to do cross-compilation to make it possible to get arm64 binaries using x86_64 host. This guide is result of that research and almost completely repeats the authors steps made this possible, but in much cleaner way. Also there is the [script](https://gist.github.com/Kolcha/3ccd533123b773ba110b8fd778b1c2bf) allowing to build qBittorrent master branch for desired architecture in "fully automatic mode". Script was also written by the same author as this guide.
|
||||
|
||||
@ -80,7 +80,7 @@ for changing qBittorrent specific GUI colors, you have to use config.json, NOTE:
|
||||
}
|
||||
```
|
||||
Here
|
||||
1. Palette referes to [QPalette](https://doc.qt.io/qt-5/qpalette.html), and following string(after .) denotes [Color roles](https://doc.qt.io/qt-5/qpalette.html#ColorRole-enum)
|
||||
1. Palette refers to [QPalette](https://doc.qt.io/qt-5/qpalette.html), and following string(after .) denotes [Color roles](https://doc.qt.io/qt-5/qpalette.html#ColorRole-enum)
|
||||
2. Log refers to log messages and the following string (after .) denotes the type of messages
|
||||
3. Transfer List refers to central view containing all of your torrents entries and the following string(after .) denotes torrent state on which based on which row colors would be decided.
|
||||
|
||||
|
||||
@ -161,15 +161,15 @@ A complete list of libtorrent configuration may be found [https://www.libtorrent
|
||||
* '''IP Address to report to trackers (requires restart)''' — (default: blank) is the IP address passed along to trackers. If this value is blank, the parameter will be omitted.
|
||||
* '''Max concurrent HTTP announces''' — (default: 50) limits the number of concurrent HTTP tracker announces. Once the limit is hit, tracker requests are queued and issued when an outstanding announce completes.
|
||||
* '''Stop tracker timeout''' — (default: 5 s) is the number of seconds to wait when sending a stopped message before considering a tracker to have timed out. This is usually shorter, to make the client quit faster. If the value is set to 0, the connections to trackers with the stopped event are suppressed.
|
||||
* '''Peer turnover disconnect percentage''' — (default: 4 %) is the percentage of peers to disconnect every turnover (Peer turnover disconnect interval) (if we're at the peer limit). When we are connected to more than limit (Peer turnover thresshold percentage) peers, disconnect this percentage fraction of the peers.
|
||||
* '''Peer turnover thresshold percentage''' — (default: 90 %) See above.
|
||||
* '''Peer turnover disconnect percentage''' — (default: 4 %) is the percentage of peers to disconnect every turnover (Peer turnover disconnect interval) (if we're at the peer limit). When we are connected to more than limit (Peer turnover threshold percentage) peers, disconnect this percentage fraction of the peers.
|
||||
* '''Peer turnover threshold percentage''' — (default: 90 %) See above.
|
||||
* '''Peer turnover disconnect interval''' — (default: 300 s) is the interval (in seconds) between optimistic disconnects if the disconnects happen. See above.
|
||||
|
||||
= Deprecated options =
|
||||
|
||||
Deprecated options may be safely removed from your config file.
|
||||
|
||||
* '''Listen on IPv6 address''' — Also known as the config string <code>Connection\InterfaceListenIPv6</code> (since <code>4.2.1</code>). Replacement: "Optional IP address to bind to", confg string <code>Connection\InterfaceAddress</code>. Reason: [https://github.com/qbittorrent/qBittorrent/pull/11592 #11592].
|
||||
* '''Listen on IPv6 address''' — Also known as the config string <code>Connection\InterfaceListenIPv6</code> (since <code>4.2.1</code>). Replacement: "Optional IP address to bind to", config string <code>Connection\InterfaceAddress</code>. Reason: [https://github.com/qbittorrent/qBittorrent/pull/11592 #11592].
|
||||
* '''Maximum number of half-open connections''' — Also known as the config string <code>BitTorrent/Session/MaxHalfOpenConnections</code> (since <code>4.2.0</code>). Replacement: None. Reason: [https://github.com/arvidn/libtorrent/commit/ceccc2a4835fefce836001a7ccff8cca82d58999 option removed from libtorrent as it did not make sense anymore].
|
||||
* '''Guided read cache''' — enables the disk cache to adjust the size of a cache line generated by peers to depend on the upload rate you are sending to that peer. The intention is to optimize the RAM usage of the cache, to read ahead further for peers that you're sending faster to.
|
||||
* '''Strict super seeding''' — activate libtorrent's strict mode for super seeding ("when this is set to true, a piece has to have been forwarded to a third peer before another one is handed out. This is the traditional definition of super seeding.").
|
||||
|
||||
@ -11,7 +11,7 @@ Suppose you have the following magnet link:
|
||||
|
||||
magnet:?xt=urn:btih:WRN7ZT6NKMA6SSXYKAFRUGDDIFJUNKI2
|
||||
|
||||
if it´s added to qBittorrent and then you issue a /query/torrents command, you´ll get a JSON object like this (fields other than "hash" are ommitted):
|
||||
if it´s added to qBittorrent and then you issue a /query/torrents command, you´ll get a JSON object like this (fields other than "hash" are omitted):
|
||||
|
||||
[{...,"hash":"b45bfccfcd5301e94af8500b1a1863415346a91a",...},...]
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@ Impersonate the qbittorent user:
|
||||
|
||||
`sudo su qbtuser`
|
||||
|
||||
Create neccesary folders:
|
||||
Create necessary folders:
|
||||
```
|
||||
cd /home/qbtuser/
|
||||
mkdir ~/.config/qBittorrent/ssl
|
||||
@ -52,7 +52,7 @@ A little about self signed certificates: You will be prompted by your browser th
|
||||
|
||||
You should now be able to log in with your username and password as before, unless you changed it during the steps above.
|
||||
|
||||
If you are unsure what url (ip and port and protocol) qtorrent is using, you can find it in the logfile, asuming you followed the Ubuntu Server guide on this wiki with:
|
||||
If you are unsure what url (ip and port and protocol) qtorrent is using, you can find it in the logfile, assuming you followed the Ubuntu Server guide on this wiki with:
|
||||
|
||||
`sudo tail /var/log/qbittorrent-nox.log`
|
||||
|
||||
|
||||
@ -26,7 +26,7 @@ See [How to use custom UI themes](https://github.com/qbittorrent/qBittorrent/wik
|
||||
|
||||
- https://github.com/MahdiMirzade/Dotfiles/tree/main/.config/qbittorrent
|
||||
|
||||
A simple dark theme, with a similar color pallete as all my other configurations. (i3, kitty, qutebrowser, ...)
|
||||
A simple dark theme, with a similar color palette as all my other configurations. (i3, kitty, qutebrowser, ...)
|
||||
|
||||
- https://github.com/dracula/qbittorrent
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ services:
|
||||
- "traefik.http.middlewares.qb-redirect.redirectregex.regex=^(.*)/qb$$"
|
||||
- "traefik.http.middlewares.qb-redirect.redirectregex.replacement=$$1/qb/"
|
||||
- "traefik.http.middlewares.qb-strip.stripprefix.prefixes=/qb/"
|
||||
# appropropriate header changes
|
||||
# appropriate header changes
|
||||
- "traefik.http.middlewares.qb-headers.headers.customrequestheaders.X-Frame-Options=SAMEORIGIN"
|
||||
- "traefik.http.middlewares.qb-headers.headers.customrequestheaders.Referer="
|
||||
- "traefik.http.middlewares.qb-headers.headers.customrequestheaders.Origin="
|
||||
|
||||
@ -1274,7 +1274,7 @@ Property | Type | Description
|
||||
`completed` | integer | Amount of transfer data completed (bytes)
|
||||
`completion_on` | integer | Time (Unix Epoch) when the torrent completed
|
||||
`content_path` | string | Absolute path of torrent content (root path for multifile torrents, absolute file path for singlefile torrents)
|
||||
`dl_limit` | integer | Torrent download speed limit (bytes/s). `-1` if ulimited.
|
||||
`dl_limit` | integer | Torrent download speed limit (bytes/s). `-1` if unlimited.
|
||||
`dlspeed` | integer | Torrent download speed (bytes/s)
|
||||
`downloaded` | integer | Amount of data downloaded
|
||||
`downloaded_session` | integer | Amount of data downloaded this session
|
||||
@ -1307,7 +1307,7 @@ Property | Type | Description
|
||||
`time_active` | integer | Total active time (seconds)
|
||||
`total_size` | integer | Total size (bytes) of all file in this torrent (including unselected ones)
|
||||
`tracker` | string | The first tracker with working status. Returns empty string if no tracker is working.
|
||||
`up_limit` | integer | Torrent upload speed limit (bytes/s). `-1` if ulimited.
|
||||
`up_limit` | integer | Torrent upload speed limit (bytes/s). `-1` if unlimited.
|
||||
`uploaded` | integer | Amount of data uploaded
|
||||
`uploaded_session` | integer | Amount of data uploaded this session
|
||||
`upspeed` | integer | Torrent upload speed (bytes/s)
|
||||
@ -1499,7 +1499,7 @@ Property | Type | Description
|
||||
`num_peers` | integer | Number of peers for current torrent, as reported by the tracker
|
||||
`num_seeds` | integer | Number of seeds for current torrent, asreported by the tracker
|
||||
`num_leeches` | integer | Number of leeches for current torrent, as reported by the tracker
|
||||
`num_downloaded` | integer | Number of completed downlods for current torrent, as reported by the tracker
|
||||
`num_downloaded` | integer | Number of completed downloads for current torrent, as reported by the tracker
|
||||
`msg` | string | Tracker message (there is no way of knowing what this message is - it's up to tracker admins)
|
||||
|
||||
Possible values of `status`:
|
||||
@ -2114,7 +2114,7 @@ Parameter | Type | Description
|
||||
|
||||
`id` values correspond to file position inside the array returned by [torrent contents API](#get-torrent-contents), e.g. `id=0` for first file, `id=1` for second file, etc.
|
||||
|
||||
Since 2.8.2 it is reccomended to use `index` field returned by [torrent contents API](#get-torrent-contents) (since the files can be filtered and the `index` value may differ from the position inside the response array).
|
||||
Since 2.8.2 it is recommended to use `index` field returned by [torrent contents API](#get-torrent-contents) (since the files can be filtered and the `index` value may differ from the position inside the response array).
|
||||
|
||||
**Returns:**
|
||||
|
||||
|
||||
@ -184,11 +184,11 @@ where
|
||||
1. `pausedDL` - torrent is paused and has **NOT** finished downloading
|
||||
1. `queuedUP` - queuing is enabled and torrent is queued for upload
|
||||
1. `queuedDL` - queuing is enabled and torrent is queued for download
|
||||
1. `uploading` - torrent is being seeded and data is being transfered
|
||||
1. `uploading` - torrent is being seeded and data is being transferred
|
||||
1. `stalledUP` - torrent is being seeded, but no connection were made
|
||||
1. `checkingUP` - torrent has finished downloading and is being checked; this status also applies to preallocation (if enabled) and checking resume data on qBt startup
|
||||
1. `checkingDL` - same as `checkingUP`, but torrent has **NOT** finished downloading
|
||||
1. `downloading` - torrent is being downloaded and data is being transfered
|
||||
1. `downloading` - torrent is being downloaded and data is being transferred
|
||||
1. `stalledDL` - torrent is being downloaded, but no connection were made
|
||||
|
||||
**BIG FAT WARNING:** `size`, `dlspeed`, `upspeed` and `eta` suffixes (e.g. MiB, KiB/s) will depend on current language selected in qBt; these suffixes will be translated.
|
||||
@ -424,7 +424,7 @@ where
|
||||
`dhtSameAsBT` - true if DHT port should match TCP port<br/>
|
||||
`dht_port` - DHT port if `dhtSameAsBT` is false<br/>
|
||||
`pex` - true if PeX is enabled<br/>
|
||||
`lsd` - true if LSD is eanbled<br/>
|
||||
`lsd` - true if LSD is enabled<br/>
|
||||
`encryption` - possible values:<br/>
|
||||
|
||||
1. `0` - prefer encryption
|
||||
@ -455,7 +455,7 @@ where
|
||||
`web_ui_username` - WebUI username<br/>
|
||||
`web_ui_password` - MD5 hash of WebUI password; hash is generated from the following string: `username:Web UI Access:plain_text_web_ui_password`<br/>
|
||||
`bypass_local_auth` - true if auithetication challenge for loopback address (127.0.0.1) should be disabled<br/>
|
||||
`use_https` - true if WebUI HTTPS access is eanbled<br/>
|
||||
`use_https` - true if WebUI HTTPS access is enabled<br/>
|
||||
`ssl_key` - SSL keyfile contents (this is a not a path)<br/>
|
||||
`ssl_cert` - SSL certificate contents (this is a not a path)<br/>
|
||||
`dyndns_enabled` - true if server DNS should be updated dynamically<br/>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user