kopia lustrzana https://github.com/linuxserver/docker-documentation
334 wiersze
14 KiB
Markdown
334 wiersze
14 KiB
Markdown
---
|
|
title: deluge
|
|
---
|
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
|
<!-- Please read https://github.com/linuxserver/docker-deluge/blob/master/.github/CONTRIBUTING.md -->
|
|
# [linuxserver/deluge](https://github.com/linuxserver/docker-deluge)
|
|
|
|
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fdeluge)
|
|
[](https://github.com/linuxserver/docker-deluge)
|
|
[](https://github.com/linuxserver/docker-deluge/releases)
|
|
[](https://github.com/linuxserver/docker-deluge/packages)
|
|
[](https://gitlab.com/linuxserver.io/docker-deluge/container_registry)
|
|
[](https://quay.io/repository/linuxserver.io/deluge)
|
|
[](https://hub.docker.com/r/linuxserver/deluge)
|
|
[](https://hub.docker.com/r/linuxserver/deluge)
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-deluge/job/master/)
|
|
[](https://ci-tests.linuxserver.io/linuxserver/deluge/latest/index.html)
|
|
|
|
[Deluge](http://deluge-torrent.org/) is a lightweight, Free Software, cross-platform BitTorrent client.
|
|
|
|
* Full Encryption
|
|
* WebUI
|
|
* Plugin System
|
|
* Much more...
|
|
|
|
[](http://deluge-torrent.org/)
|
|
|
|
## Supported Architectures
|
|
|
|
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
|
|
|
Simply pulling `lscr.io/linuxserver/deluge:latest` 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:
|
|
|
|
| Architecture | Available | Tag |
|
|
| :----: | :----: | ---- |
|
|
| x86-64 | ✅ | amd64-\<version tag\> |
|
|
| arm64 | ✅ | arm64v8-\<version tag\> |
|
|
| armhf | ❌ | |
|
|
|
|
## Application Setup
|
|
|
|
The admin interface is available at `http://SERVER-IP:8112` with a default user/password of admin/deluge.
|
|
|
|
To change the password (recommended) log in to the web interface and go to Preferences->Interface->Password.
|
|
|
|
Change the inbound port to 6881 (or whichever port you've mapped for the container) under Preferences->Network, otherwise random ports will be used.
|
|
|
|
## Usage
|
|
|
|
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
|
|
|
|
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
|
|
|
|
```yaml
|
|
---
|
|
services:
|
|
deluge:
|
|
image: lscr.io/linuxserver/deluge:latest
|
|
container_name: deluge
|
|
environment:
|
|
- PUID=1000
|
|
- PGID=1000
|
|
- TZ=Etc/UTC
|
|
- DELUGE_LOGLEVEL=error #optional
|
|
volumes:
|
|
- /path/to/deluge/config:/config
|
|
- /path/to/your/downloads:/downloads
|
|
ports:
|
|
- 8112:8112
|
|
- 6881:6881
|
|
- 6881:6881/udp
|
|
- 58846:58846 #optional
|
|
restart: unless-stopped
|
|
```
|
|
|
|
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name=deluge \
|
|
-e PUID=1000 \
|
|
-e PGID=1000 \
|
|
-e TZ=Etc/UTC \
|
|
-e DELUGE_LOGLEVEL=error `#optional` \
|
|
-p 8112:8112 \
|
|
-p 6881:6881 \
|
|
-p 6881:6881/udp \
|
|
-p 58846:58846 `#optional` \
|
|
-v /path/to/deluge/config:/config \
|
|
-v /path/to/your/downloads:/downloads \
|
|
--restart unless-stopped \
|
|
lscr.io/linuxserver/deluge:latest
|
|
```
|
|
|
|
## Parameters
|
|
|
|
Containers 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`)
|
|
|
|
| Parameter | Function |
|
|
| :----: | --- |
|
|
| `8112` | Port for webui |
|
|
| `6881` | Inbound torrent traffic (See App Setup) |
|
|
| `6881/udp` | Inbound torrent traffic (See App Setup) |
|
|
| `58846` | Default deluged port for thin client connectivity |
|
|
|
|
### Environment Variables (`-e`)
|
|
|
|
| Env | Function |
|
|
| :----: | --- |
|
|
| `PUID=1000` | for UserID - see below for explanation |
|
|
| `PGID=1000` | for GroupID - see below for explanation |
|
|
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
|
|
| `DELUGE_LOGLEVEL=error` | set the loglevel output when running Deluge, default is info for deluged and warning for delgued-web |
|
|
|
|
### Volume Mappings (`-v`)
|
|
|
|
| Volume | Function |
|
|
| :----: | --- |
|
|
| `/config` | deluge configs |
|
|
| `/downloads` | torrent download directory |
|
|
|
|
#### Miscellaneous Options
|
|
|
|
| Parameter | Function |
|
|
| :-----: | --- |
|
|
|
|
## Environment variables from files (Docker secrets)
|
|
|
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
|
|
|
As an example:
|
|
|
|
```bash
|
|
-e FILE__MYVAR=/run/secrets/mysecretvariable
|
|
```
|
|
|
|
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
|
|
|
|
## Umask for running applications
|
|
|
|
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
|
|
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
|
|
|
## 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`.
|
|
|
|
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 your_user` as below:
|
|
|
|
```bash
|
|
id your_user
|
|
```
|
|
|
|
Example output:
|
|
|
|
```text
|
|
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
|
|
```
|
|
|
|
## Docker Mods
|
|
|
|
[](https://mods.linuxserver.io/?mod=deluge "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
|
|
|
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
|
|
|
|
## Support Info
|
|
|
|
* Shell access whilst the container is running:
|
|
|
|
```bash
|
|
docker exec -it deluge /bin/bash
|
|
```
|
|
|
|
* To monitor the logs of the container in realtime:
|
|
|
|
```bash
|
|
docker logs -f deluge
|
|
```
|
|
|
|
* Container version number:
|
|
|
|
```bash
|
|
docker inspect -f '{{ index .Config.Labels "build_version" }}' deluge
|
|
```
|
|
|
|
* Image version number:
|
|
|
|
```bash
|
|
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/deluge:latest
|
|
```
|
|
|
|
## Updating Info
|
|
|
|
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
|
|
|
|
Below are the instructions for updating containers:
|
|
|
|
### Via Docker Compose
|
|
|
|
* Update images:
|
|
* All images:
|
|
|
|
```bash
|
|
docker-compose pull
|
|
```
|
|
|
|
* Single image:
|
|
|
|
```bash
|
|
docker-compose pull deluge
|
|
```
|
|
|
|
* Update containers:
|
|
* All containers:
|
|
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
* Single container:
|
|
|
|
```bash
|
|
docker-compose up -d deluge
|
|
```
|
|
|
|
* You can also remove the old dangling images:
|
|
|
|
```bash
|
|
docker image prune
|
|
```
|
|
|
|
### Via Docker Run
|
|
|
|
* Update the image:
|
|
|
|
```bash
|
|
docker pull lscr.io/linuxserver/deluge:latest
|
|
```
|
|
|
|
* Stop the running container:
|
|
|
|
```bash
|
|
docker stop deluge
|
|
```
|
|
|
|
* Delete the container:
|
|
|
|
```bash
|
|
docker rm deluge
|
|
```
|
|
|
|
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
|
|
* You can also remove the old dangling images:
|
|
|
|
```bash
|
|
docker image prune
|
|
```
|
|
|
|
### Image Update Notifications - Diun (Docker Image Update Notifier)
|
|
|
|
!!! tip
|
|
|
|
We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
|
|
|
|
## Building locally
|
|
|
|
If you want to make local modifications to these images for development purposes or just to customize the logic:
|
|
|
|
```bash
|
|
git clone https://github.com/linuxserver/docker-deluge.git
|
|
cd docker-deluge
|
|
docker build \
|
|
--no-cache \
|
|
--pull \
|
|
-t lscr.io/linuxserver/deluge:latest .
|
|
```
|
|
|
|
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
|
|
|
|
```bash
|
|
docker run --rm --privileged multiarch/qemu-user-static:register --reset
|
|
```
|
|
|
|
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
|
|
|
|
## Versions
|
|
|
|
* **26.12.23:** - Replace source for GeoIP database.
|
|
* **07.12.23:** - Add optional port 58846 to readme for thin client connectivity.
|
|
* **07.10.23:** - Install unrar from [linuxserver repo](https://github.com/linuxserver/docker-unrar).
|
|
* **10.08.23:** - Bump unrar to 6.2.10.
|
|
* **30.06.23:** - Bump unrar to 6.2.8, deprecate armhf as per [https://www.linuxserver.io/armhf](https://www.linuxserver.io/armhf).
|
|
* **29.11.22:** - Restore geoip using py3-geoip as an interim measure.
|
|
* **24.11.22:** - Remove GeoIP packages as geoip will not build under Py 3.11 and Deluge still doesn't support geoip2.
|
|
* **22.11.22:** - Update GeoIP URL for new IPFS domain.
|
|
* **29.08.22:** - Rebase to Alpine Edge again to follow latest releases.
|
|
* **12.08.22:** - Bump unrar to 6.1.7.
|
|
* **16.06.22:** - Rebase to Alpine 3.16 from edge.
|
|
* **22.02.22:** - Rebase to Alpine, config on first startup, add GeoIP.
|
|
* **15.01.22:** - Rebase to Focal.
|
|
* **07.06.21:** - Remove host networking from readme examples
|
|
* **23.01.21:** - Deprecate `UMASK_SET` in favor of UMASK in baseimage, see above for more information.
|
|
* **09.05.19:** - Add python3 requests and future modules.
|
|
* **24.08.19:** - Add ability to set LogLevel for Deluge.
|
|
* **09.06.19:** - Update to 2.x using deluge ppa.
|
|
* **02.05.19:** - Install full version of 7zip.
|
|
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
|
|
* **15.11.18:** - Add deluge-console.
|
|
* **11.11.18:** - Rebase to Ubuntu Bionic, add pipeline multiarch logic.
|
|
* **09.04.18:** - update to libressl2.7-libssl.
|
|
* **29.03.18:** - Rebase to alpine edge.
|
|
* **07.12.17:** - Rebase to alpine 3.7.
|
|
* **20.11.17:** - Change libressl2.6-libssl repo.
|
|
* **01.07.17:** - Add curl package.
|
|
* **26.05.17:** - Rebase to alpine 3.6.
|
|
* **29.04.17:** - Add variable for user defined umask.
|
|
* **28.04.17:** - update to libressl2.5-libssl.
|
|
* **28.12.16:** - Rebase to alpine 3.5 baseimage.
|
|
* **17.11.16:** - Rebase to edge baseimage.
|
|
* **13.10.16:** - Switch to libressl as openssl deprecated from alpine linux and deluge dependency no longer installs
|
|
* **30.09.16:** - Fix umask.
|
|
* **09.09.16:** - Add layer badges to README.
|
|
* **30.08.16:** - Use pip packages for some critical dependencies.
|
|
* **28.08.16:** - Add badges to README.
|
|
* **15.08.16:** - Rebase to alpine linux.
|
|
* **09.11.15:** - Add unrar and unzip
|
|
* **15.10.15:** - Initial Release.
|