kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
00f6ff3c40
commit
07be24460d
|
|
@ -0,0 +1,176 @@
|
|||
---
|
||||
title: flexget
|
||||
---
|
||||
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
||||
<!-- Please read the https://github.com/linuxserver/docker-flexget/blob/main/.github/CONTRIBUTING.md -->
|
||||
|
||||
# [linuxserver/flexget](https://github.com/linuxserver/docker-flexget)
|
||||
|
||||
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fflexget)
|
||||
[](https://github.com/linuxserver/docker-flexget)
|
||||
[](https://github.com/linuxserver/docker-flexget/releases)
|
||||
[](https://github.com/linuxserver/docker-flexget/packages)
|
||||
[](https://gitlab.com/linuxserver.io/docker-flexget/container_registry)
|
||||
[](https://quay.io/repository/linuxserver.io/flexget)
|
||||
[](https://hub.docker.com/r/linuxserver/flexget)
|
||||
[](https://hub.docker.com/r/linuxserver/flexget)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-flexget/job/main/)
|
||||
[](https://ci-tests.linuxserver.io/linuxserver/flexget/latest/index.html)
|
||||
|
||||
[Flexget](http://flexget.com/) 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](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/).
|
||||
|
||||
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](https://flexget.com/) 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 dont understand, or dont want hardlinks/atomic moves.
|
||||
|
||||
The folks over at servarr.com wrote a good [write-up](https://wiki.servarr.com/docker-guide#consistent-and-well-planned-paths) on how to get started with this.
|
||||
|
||||
## 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
|
||||
---
|
||||
version: "2.1"
|
||||
services:
|
||||
flexget:
|
||||
image: lscr.io/linuxserver/flexget:latest
|
||||
container_name: flexget
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- TZ=Etc/UTC
|
||||
- FG_LOG_LEVEL=info
|
||||
- FG_WEBUI_PASSWORD=info #optional
|
||||
volumes:
|
||||
- /path/to/data:/config
|
||||
- /path/to/downloads:/data #optional
|
||||
ports:
|
||||
- 5050:5050
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name=flexget \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
-e TZ=Etc/UTC \
|
||||
-e FG_LOG_LEVEL=info \
|
||||
-e FG_WEBUI_PASSWORD=info `#optional` \
|
||||
-p 5050:5050 \
|
||||
-v /path/to/data:/config \
|
||||
-v /path/to/downloads:/data `#optional` \
|
||||
--restart unless-stopped \
|
||||
lscr.io/linuxserver/flexget:latest
|
||||
|
||||
```
|
||||
|
||||
## 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 |
|
||||
| :----: | --- |
|
||||
| `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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
|
||||
| `FG_LOG_LEVEL=info` | Set the FlexGet logging level. |
|
||||
| `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 sabnzbd config files. |
|
||||
| `/data` | Default path for downloads. |
|
||||
|
||||
#### 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__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](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 user` as below:
|
||||
|
||||
```bash
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Docker Mods
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=flexget "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:
|
||||
* `docker exec -it flexget /bin/bash`
|
||||
* To monitor the logs of the container in realtime:
|
||||
* `docker logs -f flexget`
|
||||
* Container version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' flexget`
|
||||
* Image version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/flexget:latest`
|
||||
|
||||
## Versions
|
||||
|
||||
* **03.07.23:** - Initial Release.
|
||||
Ładowanie…
Reference in New Issue