transfigurr / transfigurr Goto Github PK

A modern codec management and automation tool

View Demo . Report Bug . Request Feature

Transfigurr is a modern media management tool specifically designed for automating codec encodings using FFmpeg. It streamlines the process of video file conversion according to custom ffmpeg profiles, making it an essential tool for media enthusiasts and professionals alike.

Docker manifest is utilized for multi-platform awareness. More information is available from docker here.

Simply pulling transfigurr/transfigurr: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:

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Access the webui at <your-ip>:7889, for more information check out Transfigurr.

The /series, /movies and /transcode have been set as optional paths, 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 on how to get started with this.

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

---
services:
  transfigurr:
    image: transfigurr/transfigurr:latest
    container_name: transfigurr
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/data:/config
      - /path/to/series:/series #optional
      - /path/to/movies:/movies #optional
      - /path/to/transcode/transcode #optional
    ports:
      - 7889:7889
    restart: unless-stopped

docker run -d \
  --name=transfigurr \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 7889:7889 \
  -v /path/to/data:/config \
  -v /path/to/series:/series #optional \
  -v /path/to/movies:/movies #optional \
  -v /path/to/transcode:/transcode #optional \
  --restart unless-stopped \
  transfigurr/transfigurr:latest

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.

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

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:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

• Shell access whilst the container is running:

  docker exec -it transfigurr /bin/bash

• To monitor the logs of the container in realtime:

  docker logs -f transfigurr

• Container version number:

  docker inspect -f '{{ index .Config.Labels "build_version" }}' transfigurr

• Image version number:

  docker inspect -f '{{ index .Config.Labels "build_version" }}' transfigurr/transfigurr:latest

Below are the instructions for updating containers:

• Update images:

  • All images:

    docker-compose pull

  • Single image:

    docker-compose pull transfigurr

• Update containers:

  • All containers:

    docker-compose up -d

  • Single container:

    docker-compose up -d transfigurr

• You can also remove the old dangling images:

  docker image prune

• Update the image:

  docker pull transfigurr/transfigurr:latest

• Stop the running container:

  docker stop transfigurr

• Delete the container:

  docker rm transfigurr

• 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:

  docker image prune

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/transfigurr/transfigurr.git
cd transfigurr
docker build \
  --no-cache \
  --pull \
  -t transfigurr/transfigurr:latest .