7.4 KiB
linuxserver/pyload
Pyload is a Free and Open Source download manager written in Python and designed to be extremely lightweight, easily extensible and fully manageable via web.
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 and our announcement here.
Simply pulling linuxserver/pyload
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 | Tag |
---|---|
x86-64 | amd64-latest |
arm64 | arm64v8-latest |
armhf | arm32v7-latest |
Usage
Here are some example snippets to help you get started creating a container from this image.
docker
docker create \
--name=pyload \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-p 8000:8000 \
-p 7227:7227 `#optional` \
-v </path/to/pyload/config>:/config \
-v </path/to/downloads>:/downloads \
--restart unless-stopped \
linuxserver/pyload
docker-compose
Compatible with docker-compose v2 schemas.
---
version: "2.1"
services:
pyload:
image: linuxserver/pyload
container_name: pyload
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
volumes:
- </path/to/pyload/config>:/config
- </path/to/downloads>:/downloads
ports:
- 8000:8000
ports:
- 7227:7227 #optional
restart: unless-stopped
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.
Ports `-p`
Parameter | Function |
---|---|
8000 |
Allows HTTP access to the application |
7227 |
pyLoad control port |
Environment Variables `-e`
Env | Function |
---|---|
PUID=1000 |
for UserID - see below for explanation |
PGID=1000 |
for GroupID - see below for explanation |
TZ=Europe/London |
Specify a timezone to use EG Europe/London |
Volume Mappings `-v`
Volume | Function |
---|---|
/config |
pyLoad Configuration and files database |
/downloads |
Destination of pyLoad downloads |
Environment variables from files Docker secrets
You can set any environment variable from a file by using a special prepend FILE__
.
As an example:
-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
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 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 user
as below:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Application Setup
Access the web interface at http://your-ip:8000
the default login is: username - admin password - password
For general usage please see the pyLoad wiki here .
Docker Mods
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image if any
can be accessed via the dynamic badge above.
Support Info
- Shell access whilst the container is running:
docker exec -it pyload /bin/bash
- To monitor the logs of the container in realtime:
docker logs -f pyload
- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pyload
- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/pyload
Versions
- 18.07.19: - Add ffmpeg for plugins the do video processing.
- 28.06.19: - Rebasing to alpine 3.10.
- 08.06.19: - Initial release.