docker-documentation/images/docker-deluge.md

166 wiersze
5.9 KiB
Markdown
Czysty Zwykły widok Historia

2019-03-21 19:47:47 +00:00
# [linuxserver/deluge](https://github.com/linuxserver/docker-deluge)
2019-02-07 19:48:25 +00:00
2019-03-21 19:47:47 +00:00
[![](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/deluge.svg)](https://microbadger.com/images/linuxserver/deluge "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/deluge.svg)](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)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/deluge.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-deluge/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-deluge/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/deluge/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/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...
2019-03-21 19:47:47 +00:00
2019-02-07 19:48:25 +00:00
## Supported Architectures
2019-03-21 19:47:47 +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
2019-02-14 19:47:38 +00:00
Simply pulling `linuxserver/deluge` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-07 19:48:25 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2019-03-21 19:47:47 +00:00
| :----: | --- |
2019-02-07 19:48:25 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v6-latest |
2019-03-21 19:47:47 +00:00
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.
### docker
2019-03-21 19:47:47 +00:00
```
2019-02-07 19:48:25 +00:00
docker create \
--name=deluge \
--net=host \
2019-03-07 19:47:40 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-07 19:48:25 +00:00
-e UMASK_SET=<022> \
-e TZ=<timezone> \
-v </path/to/deluge/config>:/config \
-v </path/to/your/downloads>:/downloads \
--restart unless-stopped \
linuxserver/deluge
```
2019-03-21 19:47:47 +00:00
2019-02-07 19:48:25 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
deluge:
image: linuxserver/deluge
container_name: deluge
network_mode: host
environment:
2019-03-07 19:47:40 +00:00
- PUID=1000
- PGID=1000
2019-02-07 19:48:25 +00:00
- UMASK_SET=<022>
- TZ=<timezone>
volumes:
- </path/to/deluge/config>:/config
- </path/to/your/downloads>:/downloads
restart: unless-stopped
```
## Parameters
2019-03-21 19:47:47 +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
2019-03-21 19:47:47 +00:00
### Ports (`-p`)
2019-02-07 19:48:25 +00:00
| Parameter | Function |
2019-03-21 19:47:47 +00:00
| :----: | --- |
2019-02-07 19:48:25 +00:00
2019-03-21 19:47:47 +00:00
#### Networking (`--net`)
2019-02-07 19:48:25 +00:00
| Parameter | Function |
2019-03-21 19:47:47 +00:00
| :-----: | --- |
2019-02-07 19:48:25 +00:00
| `--net=host` | Shares host networking with container, **required**. |
2019-03-21 19:47:47 +00:00
### Environment Variables (`-e`)
2019-02-07 19:48:25 +00:00
| Env | Function |
2019-03-21 19:47:47 +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 |
2019-03-21 19:47:47 +00:00
| `UMASK_SET=<022>` | for umask setting of deluge, *optional* , default if left unset is 022. |
2019-02-07 19:48:25 +00:00
| `TZ=<timezone>` | Specify a timezone to use EG Europe/London |
2019-03-21 19:47:47 +00:00
### Volume Mappings (`-v`)
2019-02-07 19:48:25 +00:00
| Volume | Function |
2019-03-21 19:47:47 +00:00
| :----: | --- |
2019-02-07 19:48:25 +00:00
| `/config` | deluge configs |
| `/downloads` | torrent download directory |
2019-03-21 19:47:47 +00:00
2019-02-07 19:48:25 +00:00
## User / Group Identifiers
2019-03-21 19:47:47 +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
2019-03-21 19:47:47 +00:00
```
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
```
## Application Setup
2019-03-21 19:47:47 +00:00
The admin interface is available at http://<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.
2019-02-07 19:48:25 +00:00
## Support Info
* Shell access whilst the container is running:
* `docker exec -it deluge /bin/bash`
* To monitor the logs of the container in realtime:
* `docker logs -f deluge`
* Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' deluge`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/deluge`
## Versions
* **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.