Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

Latest commit

 

History

History
91 lines (60 loc) · 2.57 KB

README.md

File metadata and controls

91 lines (60 loc) · 2.57 KB
Raw

ARCHIVE NOTICE

FlexGet now publishes an official docker image that has functional parity with this image. As such, this image has been deprecated and no updates will be made. If you are attempting to run FlexGet in docker, you should look at their documentation on running in docker.

FlexGet Docker Image

FlexGet in a Docker container, with configuration in a volume, and a configurable UID/GID for said files.

Install

Docker Hub

Pull the latest image from Docker Hub:

docker pull wastrachan/flexget

Manually

Clone this repository, and run make build to build an image:

git clone https://github.com/wastrachan/docker-flexget
cd docker-flexget
make build

If you need to rebuild the image, run make clean build.

Run

Docker

Run this image with the make run shortcut, or manually with docker run.

docker run -v "$(pwd)/config:/config" \
           --name flexget \
           -e PUID=1111 \
           -e PGID=1112 \
           -e TZ=US/Eastern \
           --restart unless-stopped \
           wastrachan/flexget:latest

Docker Compose

If you wish to run this image with docker-compose, an example docker-compose.yml might read as follows:

---
version: "2"

services:
  flexget:
    image: wastrachan/flexget
    container_name: flexget
    environment:
      - PUID=1111
      - PGID=1112
    volumes:
      - </path/to/config>:/config
    restart: unless-stopped

Configuration

Configuration files are stored in the /config volume. You may wish to mount this volume as a local directory, as shown in the examples above.

The main config file for FlexGet is config.yml, and will be created automatically if the container is started without a config file present. Please review the FlexGet docs for more information.

User / Group Identifiers

If you'd like to override the UID and GID of the flexget process, you can do so with the environment variables PUID and PGID. This is helpful if other containers must access your configuration volume.

Timezone

The timezone the container uses defaults to UTC, and can be overridden with the TZ environment variable.

Volumes

Volume Description
/config Configuration directory

License

The content of this project itself is licensed under the MIT License.

View license information for the software contained in this image.