Update README

This commit is contained in:
c0re100 2022-01-08 02:14:13 +08:00
parent cf24ec6709
commit cd17fa402b
No known key found for this signature in database
GPG Key ID: 7C3B3004FE745AAF
3 changed files with 132 additions and 14 deletions

2
.gitignore vendored
View File

@ -45,3 +45,5 @@ build/
node_modules
package-lock.json
conf.pri.*
/dist/windows/translations/*
/dist/windows/license.txt

70
NOTE.md Normal file
View File

@ -0,0 +1,70 @@
Important Note
------------------------------------------
### To user:
Please do not use this modified BitTorrent client on Private Trackers,
unless qBittorrent Enhanced Edition is allowed on the Private Tracker(_Depend on which PT you're using._).
Otherwise, you will get banned.
You should ask a tracker operator to whitelist this client rather than asking a developer to change the Client Peer ID or User Agent.
### To tracker operators:
qBittorrent Enhanced is based on qBittorrent, it's aimed at blocking leeching clients automatically.
These modifications won't take effect on private torrents.
Also, qBittorrent Enhanced has a different ID announce to trackers.
User agent: `qBittorrent Enhanced/LATEST_RELEASE_VERSION`, example: `qBittorrent Enhanced/4.3.0.10`
PeerID: `-qB430[A-Z]-`, example: `-qB430A-`
********************************
### Multiple instances tutorial
If you're an advanced(or private tracker) user and you want to open 2 qBittorrent instances at the same time.
Instance 1 for Public torrent, Instance 2 for Private torrent or something else.
You can open Official qBittorrent or qBittorrent Enhanced first, as you like.
`Method 1:` Portable mode (Most suitable for Windows user)
_**AppImage does not support this method, please use method 2.**_
1. Create profile directory under qBittorrent executable directory.
2. Open executable.
3. (Optional) Create a shortcut to the desktop.
qBittorrent should enter to Portable mode now.
`Method 2:` `configuration` command (Most suitable for *nix user)
1. Go to qBittorrent executable directory
2. Open command line, and type it in cmd
Windows:
`qbittorrent.exe --configuration="new_instance_profile_name"`
*nix:
If you're using a self-compiled version and installed to system
`qbittorrent --configuration="new_instance_profile_name"`
If you're using _qbittorrent-nox_linux_x64_static_build_
`./qbittorrent-nox --configuration="new_instance_profile_name"`
If you're using AppImage
`./qBittorrent-Enhanced-Edition.AppImage
--configuration="new_instance_profile_name"`
qBittorrent should create a new configuration and use it for the new instance.

View File

@ -1,9 +1,17 @@
qBittorrent - A BitTorrent client in Qt
qBittorrent Enhanced Edition
------------------------------------------
[Important Note for user and tracker operators](NOTE.md)
********************************
# Features:
1. Auto Ban Xunlei, QQ, Baidu, Xfplay, DLBT and Offline downloader
[![AppVeyor Status](https://ci.appveyor.com/api/projects/status/github/qbittorrent/qBittorrent?branch=master&svg=true)](https://ci.appveyor.com/project/qbittorrent/qBittorrent)
[![GitHub Actions CI Status](https://github.com/qbittorrent/qBittorrent/workflows/GitHub%20Actions%20CI/badge.svg)](https://github.com/qbittorrent/qBittorrent/actions)
[![Coverity Status](https://scan.coverity.com/projects/5494/badge.svg)](https://scan.coverity.com/projects/5494)
2. _Auto Ban Unknown Peer from China_ Option (Default: OFF)
3. Auto Update Public Trackers List (Default: OFF)
4. Auto Ban BitTorrent Media Player Peer Option (Default: OFF)
5. Peer whitelist/blacklist
********************************
### Description:
qBittorrent is a bittorrent client programmed in C++ / Qt that uses
@ -26,11 +34,52 @@ qbittorrent
will install and execute qBittorrent hopefully without any problem.
### Public key:
Starting from v3.3.4 all source tarballs and binaries are signed.<br />
The key currently used is 4096R/[5B7CC9A2](https://pgp.mit.edu/pks/lookup?op=get&search=0x6E4A2D025B7CC9A2) with fingerprint `D8F3DA77AAC6741053599C136E4A2D025B7CC9A2`.<br />
You can also download it from [here](https://github.com/qbittorrent/qBittorrent/raw/master/5B7CC9A2.asc).<br />
**PREVIOUSLY** the following key was used to sign the v3.3.4 source tarballs and v3.3.4 Windows installer **only**: 4096R/[520EC6F6](https://pgp.mit.edu/pks/lookup?op=get&search=0xA1ACCAE4520EC6F6) with fingerprint `F4A5FD201B117B1C2AB590E2A1ACCAE4520EC6F6`.<br />
## Repository
If you are using a desktop Linux distribution without any special demands, you can use AppImage from release page.
Latest AppImage download: [qBittorrent-Enhanced-Edition.AppImage](https://github.com/c0re100/qBittorrent-Enhanced-Edition/releases/latest/download/qBittorrent-Enhanced-Edition.AppImage)
#### Arch Linux (Maintainer: [c0re100](https://github.com/c0re100))
[AUR](https://aur.archlinux.org/packages/qbittorrent-enhanced-git/)
[nox AUR](https://aur.archlinux.org/packages/qbittorrent-enhanced-nox-git/)
#### Debian (Maintainer: [Kolcha](https://github.com/Kolcha))
[release repo](https://software.opensuse.org//download.html?project=home%3Anikoneko%3Atest&package=qbittorrent-enhanced)
[nightly repo](https://software.opensuse.org//download.html?project=home%3Anikoneko%3Aqbittorrent-nightly&package=qbittorrent-enhanced)
Note: 'nightly' repo **doesn't have Debian 10** builds!
#### openSUSE/RPM-based Linux distro (Maintainer: [PhoenixEmik](https://github.com/PhoenixEmik))
[openSUSE repo](https://build.opensuse.org/package/show/home:PhoenixEmik/qbittorrent-enhanced-edition)
#### Ubuntu (Maintainer: [poplite](https://github.com/poplite))
[PPA](https://launchpad.net/~poplite/+archive/ubuntu/qbittorrent-enhanced)
#### macOS (Homebrew) (Maintainer: [AlexaraWu](https://github.com/AlexaraWu))
```
brew install c0re100-qbittorrent
```
#### Windows
Chocolatey (Maintainer: [iYato](https://github.com/iYato))
```
choco install qbittorrent-enhanced
```
Scoop (Maintainer: [Chawye Hsu](https://github.com/chawyehsu))
```
scoop bucket add dorado https://github.com/chawyehsu/dorado
scoop install qbittorrent-enhanced
```
### Misc:
For more information please visit:
@ -45,8 +94,5 @@ http://forum.qbittorrent.org
Please report any bug (or feature request) to:
http://bugs.qbittorrent.org
Official IRC channel:
[#qbittorrent on irc.libera.chat](ircs://irc.libera.chat:6697/qbittorrent)
------------------------------------------
sledgehammer999 \<sledgehammer999@qbittorrent.org\>
For enhanced features bug(such as Auto Ban, API, Auto Update Tracker lists...), please report to:
https://github.com/c0re100/qBittorrent-Enhanced-Edition/issues