For a detailed explanation of common issues, see The Best Docker Setup and Docker Guide wiki article.

There are many ways to manage Docker images and containers too, so installation and maintenance of them will depend on the route you choose. To help you get started creating a container from this image you can either use docker-compose or the docker cli.

docker-compose (recommended)

---
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 cli

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

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.

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__MYVAR=/run/secrets/mysecretvariable

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

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:

id your_user

Example output:

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

Support Info

• 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

Updating Info

Below are the instructions for updating containers:

Via Docker Compose

• 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

Via Docker Run

• 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