docker-documentation/images/docker-tautulli.md

9.7 KiB

title
tautulli

linuxserver/tautulli

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

Tautulli is a python based web application for monitoring, analytics and notifications for Plex Media Server.

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/tautulli: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 arm32v7-<version tag>

Version Tags

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

Tag Available Description
latest Stable Tautulli releases
develop Built at head of Tautulli nightly branch

Application Setup

Access the webui at <your-ip>:8181, for more information check out Tautulli. To use the build-in Plex LogViewer you have to add a volume, preferably ReadOnly. Then in tautulli gui settings, under Plex Media Server, turn on Show Advanced and set the Logs Folder to the folder you mapped.

Usage

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

---
version: "2.1"
services:
  tautulli:
    image: lscr.io/linuxserver/tautulli:latest
    container_name: tautulli
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
    volumes:
      - <path to data>:/config
    ports:
      - 8181:8181
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=tautulli \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -p 8181:8181 \
  -v <path to data>:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/tautulli: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
8181 WebUI

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Europe/London Specify a timezone to use EG Europe/London.

Volume Mappings (-v)

Volume Function
/config Contains tautulli config and database.

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:

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

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

Docker Mods Docker Universal 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:
    • docker exec -it tautulli /bin/bash
  • To monitor the logs of the container in realtime:
    • docker logs -f tautulli
  • Container version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' tautulli
  • Image version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/tautulli:latest

Versions

  • 10.01.22: - Rebase to Alpine 3.15.
  • 11.07.21: - Add curl package.
  • 23.01.21: - Rebasing to alpine 3.13.
  • 11.07.20: - Add py3-openssl.
  • 05.06.20: - Rebasing to alpine 3.12. Rework to python3.
  • 12.04.20: - Added mock from pip and donate links.
  • 19.12.19: - Rebasing to alpine 3.11.
  • 28.06.19: - Rebasing to alpine 3.10.
  • 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
  • 22.02.19: - Rebasing to alpine 3.9.
  • 26.01.19: - Add pipeline logic and multi arch.
  • 23.10.18: - Update plex logs info in readm.
  • 16.08.18: - Rebase to alpine 3.8.
  • 10.03.18: - Rebrand to tautulli.
  • 12.12.17: - Rebase to alpine 3.7.
  • 21.07.17: - Internal git pull instead of at runtime.
  • 12.07.17: - Add inspect commands to README, move to jenkins build and push.
  • 25.05.17: - Rebase to alpine 3.6.
  • 20.04.17: - Add pycryptodomex pip package.
  • 07.02.17: - Rebase to alpine 3.5.
  • 09.09.16: - Add layer badges to README.
  • 27.08.16: - Add badges to README.
  • 08.08.16: - Rebase to alpine linux.
  • 16.07.15: - Inital Release.