docker-documentation/images/docker-deluge.md

202 wiersze
9.9 KiB
Markdown
Czysty Zwykły widok Historia

2021-02-17 02:30:46 +00:00
---
title: deluge
---
2021-04-21 02:49:49 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-deluge/blob/master/.github/CONTRIBUTING.md -->
2020-07-02 18:47:43 +00:00
# [linuxserver/deluge](https://github.com/linuxserver/docker-deluge)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-deluge.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-deluge)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-deluge.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-deluge/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-deluge/packages)
2020-12-15 19:29:51 +00:00
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-deluge/container_registry)
2020-07-02 18:47:43 +00:00
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/deluge.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/deluge "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/deluge.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/deluge)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/deluge.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/deluge)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-deluge%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-deluge/job/master/)
2020-11-02 05:58:46 +00:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fdeluge%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/deluge/latest/index.html)
2019-02-07 19:48:25 +00:00
[Deluge](http://deluge-torrent.org/) is a lightweight, Free Software, cross-platform BitTorrent client.
* Full Encryption
* WebUI
* Plugin System
* Much more...
## Supported Architectures
2019-09-05 18:48:37 +00:00
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/).
2019-02-07 19:48:25 +00:00
2020-11-02 05:58:46 +00:00
Simply pulling `ghcr.io/linuxserver/deluge` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-14 19:47:38 +00:00
2019-02-07 19:48:25 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2020-07-02 18:47:43 +00:00
| :----: | --- |
2019-02-07 19:48:25 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 19:51:07 +00:00
| armhf | arm32v7-latest |
2019-02-07 19:48:25 +00:00
2021-04-21 02:49:49 +00:00
## 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 downloads location in the webui in Preferences->Downloads and use /downloads for completed downloads.
2020-07-02 18:47:43 +00:00
2021-06-07 15:00:52 +00:00
Change the inbound port to 6881 (or whichever port you've mapped for the container) under Preferences->Network, otherwise random ports will be used.
2019-02-07 19:48:25 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
2020-10-08 18:48:35 +00:00
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
2019-02-07 19:48:25 +00:00
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-09 18:48:18 +00:00
version: "2.1"
2019-02-07 19:48:25 +00:00
services:
deluge:
2020-11-02 05:58:46 +00:00
image: ghcr.io/linuxserver/deluge
2019-02-07 19:48:25 +00:00
container_name: deluge
environment:
2019-03-07 19:47:40 +00:00
- PUID=1000
- PGID=1000
2020-05-09 16:09:00 +00:00
- TZ=Europe/London
2019-08-25 05:49:32 +00:00
- DELUGE_LOGLEVEL=error #optional
2019-02-07 19:48:25 +00:00
volumes:
2020-05-09 16:09:00 +00:00
- /path/to/deluge/config:/config
- /path/to/your/downloads:/downloads
2021-06-07 15:00:52 +00:00
ports:
- 8112:8112
- 6881:6881
- 6881/udp:6881/udp
2019-02-07 19:48:25 +00:00
restart: unless-stopped
```
2020-10-08 18:48:35 +00:00
### docker cli
2021-04-21 02:49:49 +00:00
```bash
2020-10-08 18:48:35 +00:00
docker run -d \
--name=deluge \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-e DELUGE_LOGLEVEL=error `#optional` \
2021-06-07 15:00:52 +00:00
-p 8112:8112 \
-p 6881:6881 \
-p 6881/udp:6881/udp \
2020-10-08 18:48:35 +00:00
-v /path/to/deluge/config:/config \
-v /path/to/your/downloads:/downloads \
--restart unless-stopped \
2020-11-02 05:58:46 +00:00
ghcr.io/linuxserver/deluge
2020-10-08 18:48:35 +00:00
```
2019-02-07 19:48:25 +00:00
## Parameters
2020-07-02 18:47:43 +00:00
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.
2019-02-07 19:48:25 +00:00
2020-07-02 18:47:43 +00:00
### Ports (`-p`)
2019-02-07 19:48:25 +00:00
| Parameter | Function |
2020-07-02 18:47:43 +00:00
| :----: | --- |
2021-06-07 15:00:52 +00:00
| `8112` | Port for webui |
| `6881` | Inbound torrent traffic (See App Setup) |
| `6881/udp` | Inbound torrent traffic (See App Setup) |
2019-02-07 19:48:25 +00:00
2020-07-02 18:47:43 +00:00
### Environment Variables (`-e`)
2019-02-07 19:48:25 +00:00
| Env | Function |
2020-07-02 18:47:43 +00:00
| :----: | --- |
2019-03-07 19:47:40 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2020-05-09 16:09:00 +00:00
| `TZ=Europe/London` | Specify a timezone to use |
2019-08-25 05:49:32 +00:00
| `DELUGE_LOGLEVEL=error` | set the loglevel output when running Deluge, default is info for deluged and warning for delgued-web |
2019-02-07 19:48:25 +00:00
2020-07-02 18:47:43 +00:00
### Volume Mappings (`-v`)
2019-02-07 19:48:25 +00:00
| Volume | Function |
2020-07-02 18:47:43 +00:00
| :----: | --- |
2019-02-07 19:48:25 +00:00
| `/config` | deluge configs |
| `/downloads` | torrent download directory |
2020-07-02 18:47:43 +00:00
## Environment variables from files (Docker secrets)
2020-05-28 18:48:07 +00:00
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2021-04-21 02:49:49 +00:00
```bash
2020-05-28 18:48:07 +00:00
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
## Umask for running applications
2020-07-02 18:47:43 +00:00
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.
2019-02-07 19:48:25 +00:00
## User / Group Identifiers
2020-07-02 18:47:43 +00:00
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`.
2019-02-07 19:48:25 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-07 19:47:40 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2019-02-07 19:48:25 +00:00
2021-04-21 02:49:49 +00:00
```bash
2019-02-07 19:48:25 +00:00
$ id username
2019-03-07 19:47:40 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-07 19:48:25 +00:00
```
2020-04-09 18:48:18 +00:00
## Docker Mods
2021-04-21 02:49:49 +00:00
2020-10-08 18:48:35 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=deluge&query=%24.mods%5B%27deluge%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=deluge "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-09 18:48:18 +00:00
2020-10-08 18:48:35 +00:00
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.
2020-04-09 18:48:18 +00:00
2019-02-07 19:48:25 +00:00
## Support Info
2019-09-05 18:48:37 +00:00
* Shell access whilst the container is running:
2019-02-07 19:48:25 +00:00
* `docker exec -it deluge /bin/bash`
2019-09-05 18:48:37 +00:00
* To monitor the logs of the container in realtime:
2019-02-07 19:48:25 +00:00
* `docker logs -f deluge`
2019-09-05 18:48:37 +00:00
* Container version number
2019-02-07 19:48:25 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' deluge`
* Image version number
2020-11-02 05:58:46 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/deluge`
2019-02-07 19:48:25 +00:00
## Versions
2021-06-07 15:00:52 +00:00
* **07.06.21:** - Remove host networking from readme examples
2021-01-23 13:44:13 +00:00
* **23.01.21:** - Deprecate `UMASK_SET` in favor of UMASK in baseimage, see above for more information.
2020-05-09 16:09:00 +00:00
* **09.05.19:** - Add python3 requests and future modules.
2019-08-25 05:49:32 +00:00
* **24.08.19:** - Add ability to set LogLevel for Deluge.
2019-06-09 18:46:08 +00:00
* **09.06.19:** - Update to 2.x using deluge ppa.
2019-05-04 04:42:01 +00:00
* **02.05.19:** - Install full version of 7zip.
2019-03-24 19:51:07 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-07 19:48:25 +00:00
* **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.