Bot Updating Templated Files

LICENSE
LinuxServer-CI 2019-04-03 04:55:42 +01:00
rodzic de206321a4
commit 8e1128523e
1 zmienionych plików z 40 dodań i 27 usunięć

Wyświetl plik

@ -1,30 +1,37 @@
# linuxserver/qbittorrent # [linuxserver/qbittorrent](https://github.com/linuxserver/docker-qbittorrent)
[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/qbittorrent.svg)](https://microbadger.com/images/linuxserver/qbittorrent) [![](https://images.microbadger.com/badges/image/linuxserver/qbittorrent.svg)](https://microbadger.com/images/linuxserver/qbittorrent) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/qbittorrent.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/qbittorrent.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-qbittorrent/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-qbittorrent/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/qbittorrent/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/qbittorrent/latest/index.html) [![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
[![](https://images.microbadger.com/badges/version/linuxserver/qbittorrent.svg)](https://microbadger.com/images/linuxserver/qbittorrent "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/qbittorrent.svg)](https://microbadger.com/images/linuxserver/qbittorrent "Get your own version badge on microbadger.com")
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/qbittorrent.svg)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/qbittorrent.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-qbittorrent/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-qbittorrent/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/qbittorrent/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/qbittorrent/latest/index.html)
The [Qbittorrent](https://www.qbittorrent.org/) project aims to provide an open-source software alternative to µTorrent. qBittorrent is based on the Qt toolkit and libtorrent-rasterbar library. The [Qbittorrent](https://www.qbittorrent.org/) project aims to provide an open-source software alternative to µTorrent. qBittorrent is based on the Qt toolkit and libtorrent-rasterbar library.
## Supported Architectures ## Supported Architectures
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
Simply pulling `linuxserver/qbittorrent` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. Simply pulling `linuxserver/qbittorrent` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are: The architectures supported by this image are:
| Architecture | Tag | | Architecture | Tag |
| :---: | :--- | | :----: | --- |
| x86-64 | amd64-latest | | x86-64 | amd64-latest |
| arm64 | arm64v8-latest | | arm64 | arm64v8-latest |
| armhf | arm32v7-latest | | armhf | arm32v7-latest |
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image. Here are some example snippets to help you get started creating a container from this image.
### docker ### docker
```text ```
docker create \ docker create \
--name=qbittorrent \ --name=qbittorrent \
-e PUID=1000 \ -e PUID=1000 \
@ -41,6 +48,7 @@ docker create \
linuxserver/qbittorrent linuxserver/qbittorrent
``` ```
### docker-compose ### docker-compose
Compatible with docker-compose v2 schemas. Compatible with docker-compose v2 schemas.
@ -70,70 +78,76 @@ services:
## Parameters ## Parameters
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
### Ports \(`-p`\) ### Ports (`-p`)
| Parameter | Function | | Parameter | Function |
| :---: | :--- | | :----: | --- |
| `6881` | tcp connection port | | `6881` | tcp connection port |
| `6881/udp` | udp connection port | | `6881/udp` | udp connection port |
| `8080` | http gui | | `8080` | http gui |
### Environment Variables \(`-e`\)
### Environment Variables (`-e`)
| Env | Function | | Env | Function |
| :---: | :--- | | :----: | --- |
| `PUID=1000` | for UserID - see below for explanation | | `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
| `UMASK_SET=022` | for umask setting of qbittorrent, optional , default if left unset is 022 | | `UMASK_SET=022` | for umask setting of qbittorrent, optional , default if left unset is 022 |
| `WEBUI_PORT=8080` | for changing the port of the webui, see below for explanation | | `WEBUI_PORT=8080` | for changing the port of the webui, see below for explanation |
### Volume Mappings \(`-v`\) ### Volume Mappings (`-v`)
| Volume | Function | | Volume | Function |
| :---: | :--- | | :----: | --- |
| `/config` | Contains all relevant configuration files. | | `/config` | Contains all relevant configuration files. |
| `/downloads` | Location of downloads on disk. | | `/downloads` | Location of downloads on disk. |
## User / Group Identifiers ## User / Group Identifiers
When using volumes \(`-v` flags\), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
```text ```
$ id username $ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
``` ```
## Application Setup ## Application Setup
The webui is at `<your-ip>:8080` and the default username/password is `admin/adminadmin`. 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. 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. ### WEBUI_PORT variable
For example, to set the port to 8090 you need to set -p 8090:8090 and -e WEBUI\_PORT=8090 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.
This should alleviate the "white screen" issue. For example, to set the port to 8090 you need to set -p 8090:8090 and -e WEBUI_PORT=8090
If you have no webui , check the file /config/qBittorrent/qBittorrent.conf This should alleviate the "white screen" issue.
edit or add the following lines If you have no webui , check the file /config/qBittorrent/qBittorrent.conf
```text edit or add the following lines
```
WebUI\Address=* WebUI\Address=*
WebUI\ServerDomains=* WebUI\ServerDomains=*
``` ```
## Support Info ## Support Info
* Shell access whilst the container is running: * Shell access whilst the container is running:
@ -154,12 +168,11 @@ WebUI\ServerDomains=*
* **08.06.18:** - Bump qbitorrent to 4.1.1. * **08.06.18:** - Bump qbitorrent to 4.1.1.
* **26.04.18:** - Bump libtorrent to 1.1.7. * **26.04.18:** - Bump libtorrent to 1.1.7.
* **02.03.18:** - Bump qbitorrent to 4.0.4 and libtorrent to 1.1.6. * **02.03.18:** - Bump qbitorrent to 4.0.4 and libtorrent to 1.1.6.
* **02.01.18:** - Deprecate cpu\_core routine lack of scaling. * **02.01.18:** - Deprecate cpu_core routine lack of scaling.
* **19.12.17:** - Update to v4.0.3. * **19.12.17:** - Update to v4.0.3.
* **09.02.17:** - Rebase to alpine 3.7 * **09.02.17:** - Rebase to alpine 3.7
* **01.12.17:** - Update to v4.0.2. * **01.12.17:** - Update to v4.0.2.
* **27.11.17:** - Update to v4 and use cpu\_core routine to speed up builds. * **27.11.17:** - Update to v4 and use cpu_core routine to speed up builds.
* **16.09.17:** - Bump to 3.3.16, Add WEBUI\_PORT variable and notes to README to allow changing port of webui. * **16.09.17:** - Bump to 3.3.16, Add WEBUI_PORT variable and notes to README to allow changing port of webui.
* **01.08.17:** - Initial Release. * **01.08.17:** - Initial Release.
* **12.02.18:** - Initial Release. * **12.02.18:** - Initial Release.