linuxserver/flexget¶
Flexget is a multipurpose automation tool for all of your media.
Supported Architectures¶
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/flexget: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¶
Default config file is /config/.flexget
See the FlexGet website for more information.
Download folders¶
We have set /data
as an optional path, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional paths if you don't understand, or don't want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
Read-Only Operation¶
This image can be run with a read-only container filesystem. For details please read the docs.
Usage¶
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
Info
Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.
docker-compose (recommended, click here for more info)¶
---
services:
flexget:
image: lscr.io/linuxserver/flexget:latest
container_name: flexget
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- FG_LOG_LEVEL=info
- FG_LOG_FILE=/config/flexget.log
- FG_CONFIG_FILE=/config/.flexget/config.yml
- FG_WEBUI_PASSWORD=info #optional
volumes:
- /path/to/flexget/data:/config
- /path/to/downloads:/data #optional
ports:
- 5050:5050
restart: unless-stopped
docker cli (click here for more info)¶
docker run -d \
--name=flexget \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e FG_LOG_LEVEL=info \
-e FG_LOG_FILE=/config/flexget.log \
-e FG_CONFIG_FILE=/config/.flexget/config.yml \
-e FG_WEBUI_PASSWORD=info `#optional` \
-p 5050:5050 \
-v /path/to/flexget/data:/config \
-v /path/to/downloads:/data `#optional` \
--restart unless-stopped \
lscr.io/linuxserver/flexget: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 |
---|---|
5050:5050 | HTTP port for the WebUI. |
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. |
FG_LOG_LEVEL=info | Set the FlexGet logging level. |
FG_LOG_FILE=/config/flexget.log | Set the FlexGet log file location. |
FG_CONFIG_FILE=/config/.flexget/config.yml | Set the FlexGet config file location. |
FG_WEBUI_PASSWORD=info | Set the FlexGet webui password. Pay attention to Bash/YAML reserved characters. |
Volume Mappings (-v
)¶
Volume | Function |
---|---|
/config | Local path for FlexGet config files. |
/data | Default path for downloads. |
Miscellaneous Options¶
Parameter | Function |
---|---|
--read-only=true | Run container with a read-only filesystem. Please read the docs. |
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__
.
As an example:
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 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:
Example output:
Docker Mods¶
We publish various 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:
-
To monitor the logs of the container in realtime:
-
Container version number:
-
Image version number:
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 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:
-
Single image:
-
-
Update containers:
-
All containers:
-
Single container:
-
-
You can also remove the old dangling images:
Via Docker Run¶
-
Update the image:
-
Stop the running container:
-
Delete the container:
-
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:
Image Update Notifications - Diun (Docker Image Update Notifier)¶
Tip
We recommend 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:
git clone https://github.com/linuxserver/docker-flexget.git
cd docker-flexget
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/flexget:latest .
The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64
.
Versions¶
- 18.09.24: - Suppress creation of empty log file when WebUI password is set.
- 17.08.24: - Revert to Alpine 3.20 due to 1st party plugin incompatibility with Python 3.12.
- 19.06.24: - Rebase to Alpine 3.20.
- 20.03.24: - Rebase to Alpine 3.19.
- 07.10.23: - Install unrar from linuxserver repo.
- 10.08.23: - Bump unrar to 6.2.10.
- 03.07.23: - Initial Release.