Tautulli
  • Introduction
  • Getting Started
    • Installation
      • Install as a Daemon
    • Upgrading to Python 3
  • Using Tautulli
    • Notifications Agents Guide
    • Custom Notification Conditions
    • Exporter Guide
    • 3rd Party APIs Guide
  • Support
    • Asking for Support
    • Frequently Asked Questions (FAQ)
    • Debugging Tautulli
  • Extending Tautulli
    • Custom Scripts
    • API Reference
Powered by GitBook
On this page
  • Windows
  • macOS
  • Linux
  • FreeBSD / FreeNAS
  • Docker
  • Parameters
  • User / Group Identifiers
  • Synology
  • Updating the Container
  • Western Digital
  • QNAP
  • ReadyNAS
  • Thecus NAS
  • ArchLinux

Was this helpful?

  1. Getting Started

Installation

PreviousIntroductionNextInstall as a Daemon

Last updated 4 years ago

Was this helpful?

Windows

Download and run the latest Windows .exe installer from the .

The following installation method is not recommended.

  1. Download the latest version of and complete the installation with all the default options.

  2. Download Tautulli from GitHub:

  3. Extract the ZIP file.

  4. Double click start.bat to run Tautulli.

  5. Tautulli will be loaded in your browser or listening on .

The following installation method is not recommended.

This will install extra shell extensions and make adjustments to your path environment.

  1. Go to and download git.

  2. Run the installer, select all the defaults except for the section called "Adjusting your PATH environment" - here select "Git from the command line and also from 3rd-party software".

  3. Complete the rest of the installation with the default options.

  4. Right click on your desktop and select "Git Gui".

  5. Select "Clone Existing Repository".

  6. In the "Source Location" enter: https://github.com/Tautulli/Tautulli.git

  7. In the "Target Directory" enter a new folder where you want to install Tautulli to (e.g. C:\Tautulli).

  8. Click "Clone".

  9. When it's finished a Git Gui windows will appear, just close this Window.

  10. Browse to where you cloned the Tautulli repository (e.g. C:\Tautulli) in Windows Explorer.

  11. Double click start.bat to run Tautulli.

  12. Tautulli will be loaded in your browser or listening on .

macOS

Download and run the latest macOS .pkg installer from the .

Note: The .pkg installer requires macOS 10.14 (Mojave) or newer.

The following installation method is not recommended.

Tautulli will be installed to /Applications/Tautulli

  1. Download Tautulli from GitHub:

  2. Extract the zip to /Applications/Tautulli. Make sure you extract the files directly in the root.

  3. Open a terminal.

  4. Change directory:

    cd /Applications/Tautulli
  5. Start Tautulli:

    ./start.sh
  6. Tautulli will be loaded in your browser or listening on .

The following installation method is not recommended.

Tautulli will be installed to /Applications/Tautulli.

  1. Open a terminal

  2. Install Git:

    xcode-select --install
  3. Change directory:

    cd /Applications/
  4. Clone Tautulli:

    git clone https://github.com/Tautulli/Tautulli.git
  5. Change directory:

    cd Tautulli
  6. Start Tautulli:

    ./start.sh
  7. Tautulli will be loaded in your browser or listening on .

Linux

Tautulli can be installed on most Linux distribution using a Snap package.

  1. Select your Linux distribution at the bottom of the to install snapd.

    • If your Linux distribution is not listed, additional instructions can be found .

  2. Install Tautulli:

    sudo snap install tautulli
  3. Tautulli will be loaded in your browser or listening on .

The following installation method is not recommended.

Tautulli will be installed to /opt/Tautulli.

  1. Open a terminal.

  2. Install prerequisites:

    • Ubuntu/Debian:

      sudo apt-get install git python3.7 python3-setuptools
    • Fedora:

      sudo yum install git python3 python3-setuptools
  3. Change directory:

    cd /opt
  4. Clone Tautulli:

    sudo git clone https://github.com/Tautulli/Tautulli.git
  5. Add the Tautulli user:

    • Ubuntu/Debian:

      sudo addgroup tautulli && sudo adduser --system --no-create-home tautulli --ingroup tautulli
    • CentOS/Fedora:

      sudo adduser --system --no-create-home tautulli
  6. Change ownership:

    sudo chown -R tautulli:tautulli /opt/Tautulli
  7. Copy the service script:

    sudo cp /opt/Tautulli/init-scripts/init.systemd /lib/systemd/system/tautulli.service
  8. Enable the service:

    sudo systemctl daemon-reload && sudo systemctl enable tautulli.service
  9. Start Tautulli:

    sudo systemctl start tautulli.service
  10. Tautulli will be loaded in your browser or listening on .

FreeBSD / FreeNAS

Tautulli will be installed to /usr/local/share/Tautulli.

  1. Create a new jail for Tautulli and open a shell for the jail.

  2. Install prerequisites:

    pkg install python py37-setuptools py37-sqlite3 py37-openssl py37-pycryptodomex security/ca_root_nss git-lite
  3. Change directory:

    cd /usr/local/share
  4. Clone Tautulli:

    git clone https://github.com/Tautulli/Tautulli.git
  5. Add the Tautulli user:

    pw useradd -n tautulli -c "Tautulli" -s /sbin/nologin -w no
  6. Change ownership:

    chown -R tautulli:tautulli Tautulli
  7. Copy the service script:

    mkdir -p /usr/local/etc/rc.d && cp /usr/local/share/Tautulli/init-scripts/init.freenas /usr/local/etc/rc.d/tautulli
  8. Enable the service:

    sysrc -f /etc/rc.conf tautulli_user="tautulli" && sysrc -f /etc/rc.conf tautulli_enable="YES"
  9. Start Tautulli:

    service tautulli start

Docker

Create and run the container (substitute your <values>):

docker run -d \
  --name=tautulli \
  --restart=unless-stopped \
  -v <path to data>:/config \
  -e PUID=<uid> \
  -e PGID=<gid> \
  -e TZ=<timezone> \
  -p 8181:8181 \
  tautulli/tautulli

To update the container it must be removed and recreated:

# Stop the Tautulli container
docker stop tautulli
# Remove the Tautulli container
docker rm tautulli
# Pull the latest update
docker pull tautulli/tautulli
# Run the Tautulli container with the same parameters as before
docker run -d ...

Create a docker-compose.yml file with the following contents (substitute your <values>):

docker-compose.yml
version: '3'
services:
  tautulli:
    image: tautulli/tautulli
    container_name: tautulli
    restart: unless-stopped
    volumes:
      - <path to data>:/config
    environment:
      - PUID=<uid>
      - PGID=<gid>
      - TZ=<timezone>
    ports:
      - 8181:8181

Create and start the container (run the command from the same folder as your docker-compose.yml file):

docker-compose up -d

To update the container:

# Pull the latest update
docker-compose pull
# Update and restart the container
docker-compose up -d

Parameters

You must substitute the <values> with your own settings.

Parameters are split into two halves separated by a colon. The left side represents the host and the right side the container.

Example: -p external:internal - This shows the port mapping from internal to external of the container. So -p 8181:8181 would expose port 8181 from inside the container to be accessible from the host's IP on port 8181 (e.g. http://<host_ip>:8181). The internal port must be 8181, but the external port may be changed (e.g. -p 8080:8181).

Parameter

Function

Required / Optional

-p 8181:8181

Port for web UI

Required

-v <path to data>:/config

Contains Tautulli config and database

Required

-e PUID=<uid>

User ID (see below)

Optional

-e PGID=<gid>

Group ID (see below)

Optional

-e TZ=<timezone>

Required

User / Group Identifiers

When using data volumes (-v flags) permissions issues can arise between the host OS and the container. To avoid this issue you can specify the user PUID and group PGID. Ensure the data volume directory on the host is owned by the same user you specify.

In this instance PUID=1001 and PGID=1001. To find yours use id user as below:

$ id dockeruser
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)

Synology

Depending on your preference, you can create a unique user on your system for Tautulli, or you can use the default admin user created during your first start-up. You will need the UID and GID of whatever user you have chosen. The steps to obtain these are as follows:

  1. Type id

  2. This will return a line with the uid of that user and their primary group gid.

     [user@nas ~]$ id
     uid=1001(user) gid=1001(user) groups=1001(user)

Next, you will want to make sure that you have the prerequisite folders for Tautulli to save config files to. Here's an example general/simplified setup:

/root
 └──/docker
     └──/tautulli
         └──/config

Obviously, the important folder here is /root/docker/tautulli/config. You should ensure that the permissions on this folder allows the user you picked earlier, and will set later, has full rights to the folder. You can fix the permissions by right-clicking on your folders and going to Properties and then the Permission tab. Assign the appropriate user/group Full Control and if necessary Enable the option Apply to this folder, sub-folders and files.

You may need to restart your DiskStation for the change to take effect.

Next, back in the Docker window, double click your tautulli/tautulli:latest image to open the Create Container window. On the first menu, name your container whatever you want as long as it is identifiable to you. Next, click Advanced Settings to open a new window. Next, follow the instructions for the following tabs:

  • Advanced Settings:

    • Enable Enable auto-restart

    • If you wish, create a shortcut on the desktop

  • Volume:

    • Click Add Folder and add the following paths and corresponding Mount Paths.

File/Folder

Mount Path

docker/tautulli/config

/config

  • Port Settings:

    • Change the Local Port to 8181 to match the Container Port. For some reason the default vale of Auto almost never works.

    • You may choose a different Local Port if port 8181 is already in use, but you cannot change the Container Port.

Local Port

Container Port

Type

8181

8181

TCP

  • Environment:

    • Add the following variables and their respective value

variable

value

PUID

uid from your ssh session, eg. 1001

PGID

gid from your ssh session, eg. 1001

TZ

Finalize the container by applying the advanced settings and then following the remaining prompts.

If your container doesn't immediately run, launch it from the Docker window and give it a few dozen seconds to start completely. Your Tautulli installation should now be accessible via port 8181 (or your other Local Port) on your DiskStation's local IP address. You can find this under Control Panel -> Network -> Network Interface under LAN1 or LAN2. For example if it shows 192.168.0.5, then Tautulli can be found at http://192.168.0.5:8181/.

Updating the Container

Western Digital

The package is created and maintained by a third party. For support, please contact the creator

QNAP

The package is created and maintained by a third party. For support, please contact the creator

You can install Tautulli on QNAP devices using the .qpkg by QNAP_Stephane:

ReadyNAS

The package is created and maintained by a third party. For support, please contact the creator

Thecus NAS

The package is created and maintained by a third party. For support, please contact the creator

ArchLinux

The package is created and maintained by a third party. For support, please contact the creator

Refer to the instructions in the to run Tautulli using a different user or move your Tautulli data to a different location.

Tautulli will be loaded in your browser or listening on .

Refer to the instructions in the to run Tautulli using a different user or move your Tautulli data to a different location.

Lookup TZ value (e.g. America/Toronto)

You can easily install Tautulli on Synology devices using . Depending on your Synology device you may or may not have Docker pre-installed. If your device is 'unsupported' (i.e. Docker is not pre-installed or downloadable through the Synology Package Center), follow the guide and newer versions of the Docker spk found to install it.

Once you have Docker on your Synology, add the for Tautulli. This is done by opening the Docker program and searching the Registry tab for Tautulli. At the time of this write-up, the interface looked like . The official image is named tautulli/tautulli and it may not be the first option listed. Double-click the image entry to download it. Once downloaded you will see the image show up under your Image tab. Before installing the image you will need some additional user information.

SSH into your system using (if on Windows) or through Terminal (if on Linux or Mac). Be sure to use the appropriate username when logging in.

If you're having trouble with this, make sure that in your Terminal and SNMP settings in your Synology Control Panel.

Lookup TZ value (eg. America/Los_Angeles)

See for instructions on updating a Docker container on Synology.

Installing using is recommended if it is supported by your NAS.

You can install Tautulli on Western Digital devices using the .

Installing using is recommended if it is supported by your NAS.

Installing using is recommended if it is supported by your NAS.

You can install Tautulli on ReadyNAS devices using the .

Installing using is recommended if it is supported by your NAS.

You can install Tautulli on Thecus devices using the .

Installing using is recommended if it is supported by your machine.

You can install Tautulli on ArchLinux using the .

GitHub Releases page
Python
https://github.com/Tautulli/Tautulli/zipball/master
http://localhost:8181
https://gitforwindows.org/
http://localhost:8181
GitHub Releases page
https://github.com/Tautulli/Tautulli/zipball/master
http://localhost:8181
http://localhost:8181
Tautulli Snapcraft page
here
http://localhost:8181
http://localhost:8181
service file
http://localhost:8181
service file
official image
this
PuTTy
SSH is enabled
here
WD package by Tfl
QNAP Club
QNAP forum thread
ReadyNAS app by Mhynlo
Thecus app by outkastm
AUR package by fryfrog/Sonic-Y3k
here
here
Docker
Docker
Docker
Docker
Docker
Docker
here
here