mirrors/qBittorrent
1
0
Fork 0
mirror of https://github.com/qbittorrent/qBittorrent.git synced 2024-10-22 02:36:15 +03:00
Code Issues Projects Releases Packages Wiki Activity

Improve portable mode wiki page

Francisco Pombal 2020-05-02 01:16:09 +01:00
parent 56a47552fe
commit e2536f538c
2 changed files with 21 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
How-to-get-portable-mode-up-and-running.md

@ -1,17 +0,0 @@
# For version v4.2.1 and above.
This is just a brief instruction as to how to get qBittorrent running in portable mode.
**Windows only**
1. Download the latest version of qB that supports the profile folder method which is **v4.2.1**.
2. Extract the `qbittorrent_x.x.x_xxx_setup.exe` file to any location on your PC using 7zip or any other applicable program.
3. Create a folder called `profile` in the same directory as the extracted `qbittorrent.exe` file.
4. Click on `qbittorrent.exe` and it will create the needed files required within `profile` folder to enable portable mode.
5. **Done.**
6. **Optional**: If you have a previous install of the program on your hard drive then copy all the relevant files to the matching directories inside the `profile` folder.
**These two folders are the ones in question:**
`C:\Users\yourusername\AppData\Roaming\qBittorrent`
`C:\Users\yourusername\AppData\Local\qBittorrent`

21
How-to-use-portable-mode.md Normal file

@ -0,0 +1,21 @@
# Introduction
Portable mode makes it so that all qBittorrent config files get stored and read from one "portable" directory, to make it easy to migrate and share settings between qBittorrent installations.
**NOTE: Only available for version 4.2.1 and above.**
# Linux
Use `--profile=path/to/config/dir --relative-fastresume`, where `path/to/config/dir` is the folder where you want your portable config to be stored or read from, if the config files already exist inside it.
Alternatively, create a folder literally named `profile` in the same directory as the qBittorrent executable, and just run the executable without the `--profile` and --relative-fastresume` flags. The effect is the same as above, inside the `profile` directory. However, this is usually not what you want unless you are testing a build of qBittorrent you've compiled yourself in a directory that does not require elevated privileges.
**NOTE:** there are a bunch of caveats and pitfalls associated with portable mode and the `--relative-fastresume` flag in particular. Refer to the man page for more information and things to watch out for about these options. If just you want to use multiple configurations, use `--profile=path/to/config/dir` or `--configuration=config-name-here`. TODO: work on the new, complete man page is not yet finished.
# Windows
1. Place the qBittorrent executable (`qbittorrent.exe`) anywhere you want in your PC. You can extract it from the setup `.exe` file using 7-zip or similar (setup files are just fancy self-extracting archives).
2. Create a folder called `profile` in the same directory as the `qbittorrent.exe` file.
3. Execute `qbittorrent.exe`. It will initialize the needed configuration files within the `profile` folder and use them during execution.
- Note: You can copy qBittorrent configuration files from any installation, portable or not, to the matching directories inside the `profile` directory. When started, qBittorrent will use those files if they exist. You can of course move the `profile` directory around including to different machines, and any `qbittorrent.exe` started beside it will use those configs.