Skip to content

Installation

Landon Abney edited this page Apr 16, 2019 · 44 revisions

This guide assume you have Python 2.7 installed already. Python 3.x is not supported.


Operating Systems:


Windows

Video installation guide by Byte My Bits for Method 2.

  • Install the latest version of Python 2.7.16. Download the Windows x86-64 MSI installer and complete the installation with all the default options.

  • Method 1 (easy):

  • Method 2 (preferred):

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

    • Go to https://gitforwindows.org/ and download git.
    • 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".
    • Complete the rest of the installation with the default options.
    • Right click on your desktop and select "Git Gui".
    • Select "Clone Existing Repository".
    • In the "Source Location" enter: https://github.com/Tautulli/Tautulli.git
    • In the "Target Directory" enter a new folder where you want to install Tautulli to (e.g. C:\Tautulli).
    • Click "Clone".
    • When it's finished a Git Gui windows will appear, just close this Window.
    • Browse to where you cloned the Tautulli repository (e.g. C:\Tautulli) in Windows Explorer.
    • Double click Tautulli.py to start Tautulli.
    • Tautulli will be loaded in your browser or listening on http://localhost:8181.
    • To run Tautulli in the background on startup without the console window, refer to Install as a daemon.

macOS

Tautulli will be installed to /Applications/Tautulli

  • Method 1 (easy):
  • Method 2 (preferred):
    • Open a terminal
    • Install Git. This can be done via xcode-select --install
    • Type: cd /Applications/
    • Type: git clone https://github.com/Tautulli/Tautulli.git
    • Type: cd Tautulli
  • Type: python Tautulli.py to start Tautulli
  • Tautulli will be loaded in your browser or listening on http://localhost:8181.
  • To run Tautulli in the background on startup, refer to Install as a daemon

Linux

Tautulli will be installed to /opt/Tautulli.

  • Open a terminal
  • Install Git
    • Ubuntu/Debian: sudo apt-get install git-core
    • Fedora: sudo yum install git
  • Install prerequisites:
    • Ubuntu/Debian: sudo apt-get install python python-setuptools tzdata
    • Fedora: sudo yum install python python2-setuptools
  • Type: cd /opt
  • Type: sudo git clone https://github.com/Tautulli/Tautulli.git
  • Optional:
    • Ubuntu/Debian: sudo addgroup tautulli && sudo adduser --system --no-create-home tautulli --ingroup tautulli
    • CentOS/Fedora: sudo adduser --system --no-create-home tautulli
    • sudo chown tautulli:tautulli -R /opt/Tautulli
  • Type: cd Tautulli
  • Type: python Tautulli.py to start Tautulli
  • Tautulli will be loaded in your browser or listening on http://localhost:8181
  • To run Tautulli in the background on startup, refer to Install as a daemon

FreeBSD

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

  • Open a terminal
  • Install prerequisites: sudo pkg install python2 py27-setuptools py27-sqlite3 py27-openssl py27-pycryptodome security/ca_root_nss git-lite
  • Type: cd /usr/local/share/
  • Type: sudo git clone https://github.com/Tautulli/Tautulli.git
  • Fix permissions:
    • Allow all users to run: sudo chmod -R 777 Tautulli OR
    • Allow only a certain user to run: sudo chown -R tautulli:tautulli Tautulli OR
    • If using the pkg version of plexmediaserver use: sudo chown -R plex:plex Tautulli
  • Type: cd Tautulli
  • Type: python2 Tautulli.py to start Tautulli
  • Tautulli will be loaded in your browser or listening on http://localhost:8181
  • To run Tautulli in the background on startup, refer to Install as a daemon

FreeNAS

Instructions by Supa on the FreeNAS forums.

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

  • Create a new jail for Tautulli (you can also install it within the PMS jail if you wish)
  • Open the jail shell.
  • Install prerequisites: pkg install python2 py27-setuptools py27-sqlite3 py27-openssl py27-pycryptodome security/ca_root_nss git-lite
  • Type: cd /usr/local/share/
  • Type: git clone https://github.com/Tautulli/Tautulli.git
  • Fix permissions:
    • Allow all users to run: chmod -R 777 Tautulli OR
    • Allow only a certain user to run: chown -R user:group Tautulli
  • Type: cd Tautulli
  • Type: python2 Tautulli.py to start Tautulli
  • You should be able to access Tautulli from your computer by going to http://[JAIL-IP]:8181. You can find the jail's IP address using ifconfig.
  • To run Tautulli in the background on startup, refer to Install as a daemon

Docker

You can install Tautulli on devices that support Docker using the official Docker container.

Synology

You can easily install Tautulli on Synology devices using Docker. 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 here to install it.

Once you have Docker on your Synology, add the official image 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 this. 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.

Depending on your preference, you can create unique users on your system to manage/access your media or you can use the default admin user created during your first start-up. Just make sure that whatever user you use that they have read/write access to your media folders. For this user, you will need their UID and GID. The steps to obtain these are as follows:

  1. SSH into your system using PuTTy (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 SSH is enabled in your Terminal and SNMP settings in your Synology Control Panel
  2. Type id
  3. 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
 └──/Plex
     └── …

Optional: If you want to be able to view the Plex logs inside Tautulli you will need to add the folder containing those logs to the Tautulli container. You will likely not see the Plex folder under your shares. This is because (for some reason) the folder is hidden by default. To unhide the folder:

  1. Go to Control Panel - Shared Folders
  2. Edit the Plex share.
  3. Add your username as R/W permission
  4. Save the changes

Obviously, the important folder here is /root/docker/tautulli/config. You should ensure that the permissions on this folder allows the user you 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 and enable Execute container using high privilege. 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. Only enable read-only on the Plex logs mount.
File/Folder Mount Path ☐ Read-Only
Plex/Library/Application Support/Plex Media Server/Logs /logs
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.
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 Lookup TZ value here, eg. America/Los_Angeles

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 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/.


The packages below are created and maintained by a third party. For support, please contact the creator.

Western Digital

You can install Tautulli on ReadyNAS devices using the WD package by Tfl.

QNAP

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

ReadyNAS

You can install Tautulli on ReadyNAS devices using the ReadyNAS app by Mhynlo.

Thecus NAS

You can install Tautulli on Thecus devices using the Thecus app by outkastm.

ArchLinux

You can install Tautulli on ArchLinux using the AUR package by fryfrog/Sonic-Y3k.

You can’t perform that action at this time.