readme-vars.yml

---

# project information
project_name: qbittorrent
project_url: "https://www.qbittorrent.org/"
project_logo: "https://github.com/linuxserver/docker-templates/raw/master/linuxserver.io/img/qbittorrent-icon.png"
project_blurb: "The [{{ project_name|capitalize }}]({{ project_url }}) project aims to provide an open-source software alternative to µTorrent. qBittorrent is based on the Qt toolkit and libtorrent-rasterbar library."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"

# supported architectures
available_architectures:
  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
  - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}

# development version
development_versions: true
development_versions_items:
  - { tag: "latest", desc: "Stable qbittorrent releases" }
  - { tag: "libtorrentv1", desc: "Static qbittorrent builds using libtorrent v1" }  

# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - { vol_path: "/config", vol_host_path: "/path/to/appdata/config", desc: "Contains all relevant configuration files." }
  - { vol_path: "/downloads", vol_host_path: "/path/to/downloads", desc: "Location of downloads on disk." }
param_usage_include_ports: true
param_ports:
  - { external_port: "8080", internal_port: "8080", port_desc: "WebUI" }
  - { external_port: "6881", internal_port: "6881", port_desc: "tcp connection port" }
  - { external_port: "6881", internal_port: "6881/udp", port_desc: "udp connection port" }
param_usage_include_env: true
param_env_vars:
  - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"}
  - { env_var: "WEBUI_PORT", env_value: "8080", desc: "for changing the port of the webui, see below for explanation"}

# optional parameters
optional_block_1: false
optional_block_1_items: ""

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  The webui is at `<your-ip>:8080` and the default username/password is `admin/adminadmin`.  
  
  Change username/password via the webui in the webui section of settings.  

  ### WEBUI_PORT variable
  
  Due to issues with CSRF and port mapping, should you require to alter the port for the webui you need to change both sides of the -p 8080 switch AND set the WEBUI_PORT variable to the new port.  
  
  For example, to set the port to 8090 you need to set -p 8090:8090 and -e WEBUI_PORT=8090  
  
  This should alleviate the "white screen" issue.  
  
  If you have no webui , check the file /config/qBittorrent/qBittorrent.conf  
  
  edit or add the following lines  

  ```text
  WebUI\Address=*
  
  WebUI\ServerDomains=*
  ```
  
  If you are running a very old (3.x) kernel you may run into [this issue](https://github.com/linuxserver/docker-qbittorrent/issues/103) which can be worked around using [this method](https://github.com/linuxserver/docker-qbittorrent/issues/103#issuecomment-831238484)

# changelog
changelogs:
  - { date: "29.11.22:", desc: "Add openssl1.1-compat for qbittorrent-cli." }
  - { date: "31.10.22:", desc: "Add libtorrentv1 branch." }
  - { date: "31.08.22:", desc: "Rebase to Alpine Edge again to follow latest releases." }
  - { date: "12.08.22:", desc: "Bump unrar to 6.1.7." }
  - { date: "16.06.22:", desc: "Rebase to Alpine 3.16 from edge." }
  - { date: "25.05.22:", desc: "Fetch qbitorrent-cli from upstream repo." }
  - { date: "02.03.22:", desc: "Add unrar, 7zip, and qbitorrent-cli." }
  - { date: "01.03.22:", desc: "Add python for search plugin support." }
  - { date: "23.02.22:", desc: "Rebase to Alpine Edge, install from Alpine repos." }
  - { date: "19.02.22:", desc: "Add jq to build-stage" }
  - { date: "07.01.22:", desc: "Rebase to Alpine, build from source." }
  - { date: "06.01.22:", desc: "Deprecate unstable branch." }
  - { date: "10.02.21:", desc: "Rebase to focal." }
  - { date: "20.01.21:", desc: "Deprecate `UMASK_SET` in favor of UMASK in baseimage, see above for more information." }
  - { date: "12.11.20:", desc: "Stop creating /config/data directory on startup" }
  - { date: "03.04.20:", desc: "Fix adding search engine plugin" }
  - { date: "02.08.19:", desc: "Add qbitorrent-cli for processing scripts." }
  - { date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
  - { date: "14.01.19:", desc: "Rebase to Ubuntu, add multi arch and pipeline logic." }
  - { date: "25.09.18:", desc: "Use buildstage type build, bump qbitorrent to 4.1.3." }
  - { date: "14.08.18:", desc: "Rebase to alpine 3.8, bump libtorrent to 1.1.9 and qbitorrent to 4.1.2." }
  - { date: "08.06.18:", desc: "Bump qbitorrent to 4.1.1." }
  - { date: "26.04.18:", desc: "Bump libtorrent to 1.1.7." }
  - { date: "02.03.18:", desc: "Bump qbitorrent to 4.0.4 and libtorrent to 1.1.6." }
  - { date: "02.01.18:", desc: "Deprecate cpu_core routine lack of scaling." }
  - { date: "19.12.17:", desc: "Update to v4.0.3." }
  - { date: "09.02.17:", desc: "Rebase to alpine 3.7" }
  - { date: "01.12.17:", desc: "Update to v4.0.2." }
  - { date: "27.11.17:", desc: "Update to v4 and use cpu_core routine to speed up builds." }
  - { date: "16.09.17:", desc: "Bump to 3.3.16, Add WEBUI_PORT variable and notes to README to allow changing port of webui." }
  - { date: "01.08.17:", desc: "Initial Release." }
  - { date: "12.02.18:", desc: "Initial Release." }