Tauticord¶

Overview¶

Tauticord is a Discord bot that will mirror live Tautulli data into a Discord server, including current stream and bandwidth information, library statistics, and live playback control.

Manual

Releases

Community

Deployment¶

sb install sandbox-tauticord

Basics¶

Rename /opt/tauticord/config/config.yml.example to /opt/tauticord/config/config.yml and fill out your configuration details.

See the Tauticord documentation for more information on each setting.

Usage¶

Once started, Tauticord will connect to your Tautulli and Discord servers and begin mirroring data.

By default, library statistics are updated once every hour, and stream data is updated once every 15 seconds.

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
tauticord_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like tauticord_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

Instead, use the corresponding _custom variable (like tauticord_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsDockerDocker+Global Override Options

tauticord_name

# Type: string
tauticord_name: tauticord

Container

tauticord_role_docker_container

# Type: string
tauticord_role_docker_container: "{{ tauticord_name }}"

Image

tauticord_role_docker_image_pull

# Type: bool (true/false)
tauticord_role_docker_image_pull: true

tauticord_role_docker_image_repo

# Type: string
tauticord_role_docker_image_repo: "nwithan8/tauticord"

tauticord_role_docker_image_tag

# Type: string
tauticord_role_docker_image_tag: "latest"

tauticord_role_docker_image

# Type: string
tauticord_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='tauticord') }}:{{ lookup('role_var', '_docker_image_tag', role='tauticord') }}"

Envs

tauticord_role_docker_envs_default

# Type: dict
tauticord_role_docker_envs_default:
  TZ: "{{ tz }}"
  USER_ID: "{{ uid }}"
  GROUP_ID: "{{ gid }}"
  UMASK: "022"

tauticord_role_docker_envs_custom

# Type: dict
tauticord_role_docker_envs_custom: {}

Volumes

tauticord_role_docker_volumes_default

# Type: list
tauticord_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='tauticord') }}/config:/config"
  - "{{ lookup('role_var', '_paths_location', role='tauticord') }}/logs:/logs"

tauticord_role_docker_volumes_custom

# Type: list
tauticord_role_docker_volumes_custom: []

Hostname

tauticord_role_docker_hostname

# Type: string
tauticord_role_docker_hostname: "{{ tauticord_name }}"

Networks

tauticord_role_docker_networks_alias

# Type: string
tauticord_role_docker_networks_alias: "{{ tauticord_name }}"

tauticord_role_docker_networks_default

# Type: list
tauticord_role_docker_networks_default: []

tauticord_role_docker_networks_custom

# Type: list
tauticord_role_docker_networks_custom: []

Restart Policy

tauticord_role_docker_restart_policy

# Type: string
tauticord_role_docker_restart_policy: unless-stopped

State

tauticord_role_docker_state

# Type: string
tauticord_role_docker_state: started

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

tauticord_role_docker_blkio_weight

# Type: int
tauticord_role_docker_blkio_weight:

tauticord_role_docker_cpu_period

# Type: int
tauticord_role_docker_cpu_period:

tauticord_role_docker_cpu_quota

# Type: int
tauticord_role_docker_cpu_quota:

tauticord_role_docker_cpu_shares

# Type: int
tauticord_role_docker_cpu_shares:

tauticord_role_docker_cpus

# Type: string
tauticord_role_docker_cpus:

tauticord_role_docker_cpuset_cpus

# Type: string
tauticord_role_docker_cpuset_cpus:

tauticord_role_docker_cpuset_mems

# Type: string
tauticord_role_docker_cpuset_mems:

tauticord_role_docker_kernel_memory

# Type: string
tauticord_role_docker_kernel_memory:

tauticord_role_docker_memory

# Type: string
tauticord_role_docker_memory:

tauticord_role_docker_memory_reservation

# Type: string
tauticord_role_docker_memory_reservation:

tauticord_role_docker_memory_swap

# Type: string
tauticord_role_docker_memory_swap:

tauticord_role_docker_memory_swappiness

# Type: int
tauticord_role_docker_memory_swappiness:

tauticord_role_docker_shm_size

# Type: string
tauticord_role_docker_shm_size:

Security & Devices

tauticord_role_docker_cap_drop

# Type: list
tauticord_role_docker_cap_drop:

tauticord_role_docker_cgroupns_mode

# Type: string
tauticord_role_docker_cgroupns_mode:

tauticord_role_docker_device_cgroup_rules

# Type: list
tauticord_role_docker_device_cgroup_rules:

tauticord_role_docker_device_read_bps

# Type: list
tauticord_role_docker_device_read_bps:

tauticord_role_docker_device_read_iops

# Type: list
tauticord_role_docker_device_read_iops:

tauticord_role_docker_device_requests

# Type: list
tauticord_role_docker_device_requests:

tauticord_role_docker_device_write_bps

# Type: list
tauticord_role_docker_device_write_bps:

tauticord_role_docker_device_write_iops

# Type: list
tauticord_role_docker_device_write_iops:

tauticord_role_docker_devices

# Type: list
tauticord_role_docker_devices:

tauticord_role_docker_devices_default

# Type: string
tauticord_role_docker_devices_default:

tauticord_role_docker_groups

# Type: list
tauticord_role_docker_groups:

tauticord_role_docker_privileged

# Type: bool (true/false)
tauticord_role_docker_privileged:

tauticord_role_docker_security_opts

# Type: list
tauticord_role_docker_security_opts:

tauticord_role_docker_user

# Type: string
tauticord_role_docker_user:

tauticord_role_docker_userns_mode

# Type: string
tauticord_role_docker_userns_mode:

Networking

tauticord_role_docker_dns_opts

# Type: list
tauticord_role_docker_dns_opts:

tauticord_role_docker_dns_search_domains

# Type: list
tauticord_role_docker_dns_search_domains:

tauticord_role_docker_dns_servers

# Type: list
tauticord_role_docker_dns_servers:

tauticord_role_docker_domainname

# Type: string
tauticord_role_docker_domainname:

tauticord_role_docker_exposed_ports

# Type: list
tauticord_role_docker_exposed_ports:

tauticord_role_docker_hosts

# Type: dict
tauticord_role_docker_hosts:

tauticord_role_docker_hosts_use_common

# Type: bool (true/false)
tauticord_role_docker_hosts_use_common:

tauticord_role_docker_ipc_mode

# Type: string
tauticord_role_docker_ipc_mode:

tauticord_role_docker_links

# Type: list
tauticord_role_docker_links:

tauticord_role_docker_network_mode

# Type: string
tauticord_role_docker_network_mode:

tauticord_role_docker_pid_mode

# Type: string
tauticord_role_docker_pid_mode:

tauticord_role_docker_ports

# Type: list
tauticord_role_docker_ports:

tauticord_role_docker_uts

# Type: string
tauticord_role_docker_uts:

Storage

tauticord_role_docker_keep_volumes

# Type: bool (true/false)
tauticord_role_docker_keep_volumes:

tauticord_role_docker_mounts

# Type: list
tauticord_role_docker_mounts:

tauticord_role_docker_storage_opts

# Type: dict
tauticord_role_docker_storage_opts:

tauticord_role_docker_tmpfs

# Type: list
tauticord_role_docker_tmpfs:

tauticord_role_docker_volume_driver

# Type: string
tauticord_role_docker_volume_driver:

tauticord_role_docker_volumes_from

# Type: list
tauticord_role_docker_volumes_from:

tauticord_role_docker_volumes_global

# Type: bool (true/false)
tauticord_role_docker_volumes_global:

tauticord_role_docker_working_dir

# Type: string
tauticord_role_docker_working_dir:

Monitoring & Lifecycle

tauticord_role_docker_auto_remove

# Type: bool (true/false)
tauticord_role_docker_auto_remove:

tauticord_role_docker_cleanup

# Type: bool (true/false)
tauticord_role_docker_cleanup:

tauticord_role_docker_force_kill

# Type: string
tauticord_role_docker_force_kill:

tauticord_role_docker_healthcheck

# Type: dict
tauticord_role_docker_healthcheck:

tauticord_role_docker_healthy_wait_timeout

# Type: int
tauticord_role_docker_healthy_wait_timeout:

tauticord_role_docker_init

# Type: bool (true/false)
tauticord_role_docker_init:

tauticord_role_docker_kill_signal

# Type: string
tauticord_role_docker_kill_signal:

tauticord_role_docker_log_driver

# Type: string
tauticord_role_docker_log_driver:

tauticord_role_docker_log_options

# Type: dict
tauticord_role_docker_log_options:

tauticord_role_docker_oom_killer

# Type: bool (true/false)
tauticord_role_docker_oom_killer:

tauticord_role_docker_oom_score_adj

# Type: int
tauticord_role_docker_oom_score_adj:

tauticord_role_docker_output_logs

# Type: bool (true/false)
tauticord_role_docker_output_logs:

tauticord_role_docker_paused

# Type: bool (true/false)
tauticord_role_docker_paused:

tauticord_role_docker_recreate

# Type: bool (true/false)
tauticord_role_docker_recreate:

tauticord_role_docker_restart_retries

# Type: int
tauticord_role_docker_restart_retries:

tauticord_role_docker_stop_timeout

# Type: int
tauticord_role_docker_stop_timeout:

Other Options

tauticord_role_docker_capabilities

# Type: list
tauticord_role_docker_capabilities:

tauticord_role_docker_cgroup_parent

# Type: string
tauticord_role_docker_cgroup_parent:

tauticord_role_docker_commands

# Type: list
tauticord_role_docker_commands:

tauticord_role_docker_create_timeout

# Type: int
tauticord_role_docker_create_timeout:

tauticord_role_docker_entrypoint

# Type: string
tauticord_role_docker_entrypoint:

tauticord_role_docker_env_file

# Type: string
tauticord_role_docker_env_file:

tauticord_role_docker_labels

# Type: dict
tauticord_role_docker_labels:

tauticord_role_docker_labels_use_common

# Type: bool (true/false)
tauticord_role_docker_labels_use_common:

tauticord_role_docker_read_only

# Type: bool (true/false)
tauticord_role_docker_read_only:

tauticord_role_docker_runtime

# Type: string
tauticord_role_docker_runtime:

tauticord_role_docker_sysctls

# Type: list
tauticord_role_docker_sysctls:

tauticord_role_docker_ulimits

# Type: list
tauticord_role_docker_ulimits:

tauticord_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
tauticord_role_autoheal_enabled: true

tauticord_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
tauticord_role_depends_on: ""

tauticord_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
tauticord_role_depends_on_delay: "0"

tauticord_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
tauticord_role_depends_on_healthchecks:

tauticord_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
tauticord_role_diun_enabled: true

tauticord_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
tauticord_role_docker_controller: true

tauticord_role_docker_image_repo

# Type: string
tauticord_role_docker_image_repo:

tauticord_role_docker_image_tag

# Type: string
tauticord_role_docker_image_tag:

tauticord_role_docker_volumes_download

# Type: bool (true/false)
tauticord_role_docker_volumes_download:

tauticord_role_paths_location

# Type: string
tauticord_role_paths_location: