tautulli_docker

Overview Versions Insights

Ansible Role: Tautulli on Docker

An Ansible role to setup and run the Tautulli Docker container.

Requirements
Role Variables
Dependencies
Example Playbooks
License
Author Information

Requirements

Requires Docker. Reecommended role for Docker installation: geerlingguy.docker.

Role Variables

See defaults/main.yml for a complete list.

Container Settings

# Name of the Docker container.
tautulli_docker_name: "tautulli"

# Base name of the Docker image to use for the container.
tautulli_docker_image_name: "ghcr.io/tautulli/tautulli"

# Specific Docker image version to use for the container.
tautulli_docker_image_version: "latest"

# TCP port number to expose to handle HTTP traffic.
tautulli_docker_web_port: "8181"

# Number of vCPUs to allocate to the container.
tautulli_docker_cpus: "1"

# Amount of memory to allocate to the container.
tautulli_docker_memory: "512M"

# User ID for the file/directory owner.
tautulli_docker_uid: null

# Group ID for the file/directory owner.
tautulli_docker_gid: null

Docker volumes and folders

# Create and use Docker volumes for storing data. True creates volumes and attaches them to the
# container. False creates folders and bind mounts them to the container.
tautulli_docker_use_volumes: true

# Name of the Docker volume to create to store data files. Only used when
# [tautulli_use_volumes] is true.
tautulli_docker_volume_name: "tautulli"

# Directory on filesystem to use for storing data files. Only used when
# [tautulli_use_volumes] is false.
tautulli_docker_data_dir: "/opt/tautulli"

Docker Networks

# Name of the default Docker network for the container. The container will *always* attach to this
# network. If [tautulli_docker_network_create] is true, this is also the name of the network which
# will be created.
tautulli_docker_network: "tautulli"

# List of additional networks the container should attach to. Elements should be dictionaries like
# https://docs.ansible.com/ansible/latest/collections/community/docker/docker_container_module.html#parameter-networks.
tautulli_docker_extra_networks: []

# List of aliases for this container in the default network. These names can be used in the default
# network to reach this container.
tautulli_docker_network_aliases: []

# The container’s IPv4 address in the default network. Defaults to using DHCP.
tautulli_docker_network_ipv4: null

# The container’s IPv6 address in the default network. Defaults to using DHCP. Only applies if
# IPv6 is enabled in the default network.
tautulli_docker_network_ipv6: null

# Create the default Docker network. True creates network and attaches the container to it. False
# does not create the network.
tautulli_docker_network_create: false

# Driver to use for the default Docker network for the container. Only used when
# [tautulli_docker_network_create] is enabled. See
# https://docs.docker.com/network/#network-drivers for available options.
tautulli_docker_network_driver: "bridge"

# Enable IPv6 in the default Docker network for the container. Only used when
# [tautulli_docker_network_create] is enabled.
tautulli_docker_network_enable_ipv6: "false"

# Restrict external access to the default network. See
# https://docs.docker.com/engine/reference/commandline/network_create/#network-internal-mode.
# Only used when [tautulli_docker_network_create] is enabled.
tautulli_docker_network_internal: "yes"

# Control the default network's scope. Only used when [tautulli_docker_network_create] is enabled.
tautulli_docker_network_scope: "local"

# IPv4 subnet for the default network. Only used when [tautulli_docker_network_create] is enabled.
tautulli_docker_network_subnet: "172.1.1.0/24"

# IPv4 gateway for the default network. Only used when [tautulli_docker_network_create] is
# enabled.
tautulli_docker_network_gateway: "172.1.1.1"

Traefik Proxy

# Enable use of Traefik as a proxy.
tautulli_docker_available_externally: "true"

# Host name to use for the Traefik endpoint. Combined with [tautulli_docker_host_domain] to form
# the FQDN for the endpoint.
tautulli_docker_hostname: "tautulli"

# Domain name to use for the Traefik endpoint. Combined with [tautulli_docker_hostname] to form
# the FQDN for the endpoint. Also used by Traefik to create the necessary Let's Encrypt certificate.
tautulli_docker_host_domain: "example.com"