Petio¶

Description / name	Input element
Your domain name

Overview¶

Petio is a third party companion app available to Plex server owners to allow their users to request, review and discover content.

Manual

Releases

Community

Deployment¶

sb install petio

Usage¶

Visit https://petio.iYOUR_DOMAIN_NAMEi.

Basics¶

Click Login With Plex and follow the steps to log in.
After you log in with Plex you will need to specify your Petio specific admin credentials, by default it uses your Plex username and email but you still need to specify your own password.
After setting up your credentials, you need to pick your Plex server.
MongoDB: Use petio-mongo:27017 (assumes default instance and therefore default petio_name otherwise it is the value of petio_name plus the -mongo:27017 suffix)
Once the last step is finished, you will be presented with a login screen. Use your Plex username and the password you set up on Step 2. You can now get started with configuring Radarr, Sonarr and start requesting!
See the Petio documentation for more information.

Role Defaults¶

Use the Inventory to customize variables. (1)

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

When overriding variables that end in _default (like petio_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 petio_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsSettingsWebDNSTraefikDockerDocker+Global Override Options

petio_name

# Type: string
petio_name: petio

petio_role_mongodb_version

# Type: string
petio_role_mongodb_version: "4.4"

petio_role_web_subdomain

# Type: string
petio_role_web_subdomain: "{{ petio_name }}"

petio_role_web_domain

# Type: string
petio_role_web_domain: "{{ user.domain }}"

petio_role_web_port

# Type: string
petio_role_web_port: "7777"

petio_role_web_url

# Type: string
petio_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='petio') + '.' + lookup('role_var', '_web_domain', role='petio')
                     if (lookup('role_var', '_web_subdomain', role='petio') | length > 0)
                     else lookup('role_var', '_web_domain', role='petio')) }}"

petio_role_dns_record

# Type: string
petio_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='petio') }}"

petio_role_dns_zone

# Type: string
petio_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='petio') }}"

petio_role_dns_proxy

# Type: bool (true/false)
petio_role_dns_proxy: "{{ dns_proxied }}"

petio_role_traefik_sso_middleware

# Type: string
petio_role_traefik_sso_middleware: ""

petio_role_traefik_middleware_default

# Type: string
petio_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

petio_role_traefik_middleware_custom

# Type: string
petio_role_traefik_middleware_custom: ""

petio_role_traefik_certresolver

# Type: string
petio_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

petio_role_traefik_enabled

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

petio_role_traefik_api_enabled

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

petio_role_traefik_api_endpoint

# Type: string
petio_role_traefik_api_endpoint: ""

Container

petio_role_docker_container

# Type: string
petio_role_docker_container: "{{ petio_name }}"

Image

petio_role_docker_image_pull

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

petio_role_docker_image_repo

# Type: string
petio_role_docker_image_repo: "ghcr.io/petio-team/petio"

petio_role_docker_image_tag

# Type: string
petio_role_docker_image_tag: "latest"

petio_role_docker_image

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

Envs

petio_role_docker_envs_default

# Type: dict
petio_role_docker_envs_default:
  TZ: "{{ tz }}"

petio_role_docker_envs_custom

# Type: dict
petio_role_docker_envs_custom: {}

Volumes

petio_role_docker_volumes_default

# Type: list
petio_role_docker_volumes_default:
  - "{{ petio_role_paths_location }}:/app/api/config"

petio_role_docker_volumes_custom

# Type: list
petio_role_docker_volumes_custom: []

Hostname

petio_role_docker_hostname

# Type: string
petio_role_docker_hostname: "{{ petio_name }}"

Networks

petio_role_docker_networks_alias

# Type: string
petio_role_docker_networks_alias: "{{ petio_name }}"

petio_role_docker_networks_default

# Type: list
petio_role_docker_networks_default: []

petio_role_docker_networks_custom

# Type: list
petio_role_docker_networks_custom: []

Restart Policy

petio_role_docker_restart_policy

# Type: string
petio_role_docker_restart_policy: unless-stopped

State

petio_role_docker_state

# Type: string
petio_role_docker_state: started

User

petio_role_docker_user

# Type: string
petio_role_docker_user: "{{ uid }}:{{ gid }}"

Dependencies

petio_role_depends_on

# Type: string
petio_role_depends_on: "{{ petio_name }}-mongo"

petio_role_depends_on_delay

# Type: string (quoted number)
petio_role_depends_on_delay: "0"

petio_role_depends_on_healthchecks

# Type: string ("true"/"false")
petio_role_depends_on_healthchecks: "false"

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

Resource Limits

petio_role_docker_blkio_weight

# Type: int
petio_role_docker_blkio_weight:

petio_role_docker_cpu_period

# Type: int
petio_role_docker_cpu_period:

petio_role_docker_cpu_quota

# Type: int
petio_role_docker_cpu_quota:

petio_role_docker_cpu_shares

# Type: int
petio_role_docker_cpu_shares:

petio_role_docker_cpus

# Type: string
petio_role_docker_cpus:

petio_role_docker_cpuset_cpus

# Type: string
petio_role_docker_cpuset_cpus:

petio_role_docker_cpuset_mems

# Type: string
petio_role_docker_cpuset_mems:

petio_role_docker_kernel_memory

# Type: string
petio_role_docker_kernel_memory:

petio_role_docker_memory

# Type: string
petio_role_docker_memory:

petio_role_docker_memory_reservation

# Type: string
petio_role_docker_memory_reservation:

petio_role_docker_memory_swap

# Type: string
petio_role_docker_memory_swap:

petio_role_docker_memory_swappiness

# Type: int
petio_role_docker_memory_swappiness:

petio_role_docker_shm_size

# Type: string
petio_role_docker_shm_size:

Security & Devices

petio_role_docker_cap_drop

# Type: list
petio_role_docker_cap_drop:

petio_role_docker_cgroupns_mode

# Type: string
petio_role_docker_cgroupns_mode:

petio_role_docker_device_cgroup_rules

# Type: list
petio_role_docker_device_cgroup_rules:

petio_role_docker_device_read_bps

# Type: list
petio_role_docker_device_read_bps:

petio_role_docker_device_read_iops

# Type: list
petio_role_docker_device_read_iops:

petio_role_docker_device_requests

# Type: list
petio_role_docker_device_requests:

petio_role_docker_device_write_bps

# Type: list
petio_role_docker_device_write_bps:

petio_role_docker_device_write_iops

# Type: list
petio_role_docker_device_write_iops:

petio_role_docker_devices

# Type: list
petio_role_docker_devices:

petio_role_docker_devices_default

# Type: string
petio_role_docker_devices_default:

petio_role_docker_groups

# Type: list
petio_role_docker_groups:

petio_role_docker_privileged

# Type: bool (true/false)
petio_role_docker_privileged:

petio_role_docker_security_opts

# Type: list
petio_role_docker_security_opts:

petio_role_docker_userns_mode

# Type: string
petio_role_docker_userns_mode:

Networking

petio_role_docker_dns_opts

# Type: list
petio_role_docker_dns_opts:

petio_role_docker_dns_search_domains

# Type: list
petio_role_docker_dns_search_domains:

petio_role_docker_dns_servers

# Type: list
petio_role_docker_dns_servers:

petio_role_docker_domainname

# Type: string
petio_role_docker_domainname:

petio_role_docker_exposed_ports

# Type: list
petio_role_docker_exposed_ports:

petio_role_docker_hosts

# Type: dict
petio_role_docker_hosts:

petio_role_docker_hosts_use_common

# Type: bool (true/false)
petio_role_docker_hosts_use_common:

petio_role_docker_ipc_mode

# Type: string
petio_role_docker_ipc_mode:

petio_role_docker_links

# Type: list
petio_role_docker_links:

petio_role_docker_network_mode

# Type: string
petio_role_docker_network_mode:

petio_role_docker_pid_mode

# Type: string
petio_role_docker_pid_mode:

petio_role_docker_ports

# Type: list
petio_role_docker_ports:

petio_role_docker_uts

# Type: string
petio_role_docker_uts:

Storage

petio_role_docker_keep_volumes

# Type: bool (true/false)
petio_role_docker_keep_volumes:

petio_role_docker_mounts

# Type: list
petio_role_docker_mounts:

petio_role_docker_storage_opts

# Type: dict
petio_role_docker_storage_opts:

petio_role_docker_tmpfs

# Type: list
petio_role_docker_tmpfs:

petio_role_docker_volume_driver

# Type: string
petio_role_docker_volume_driver:

petio_role_docker_volumes_from

# Type: list
petio_role_docker_volumes_from:

petio_role_docker_volumes_global

# Type: bool (true/false)
petio_role_docker_volumes_global:

petio_role_docker_working_dir

# Type: string
petio_role_docker_working_dir:

Monitoring & Lifecycle

petio_role_docker_auto_remove

# Type: bool (true/false)
petio_role_docker_auto_remove:

petio_role_docker_cleanup

# Type: bool (true/false)
petio_role_docker_cleanup:

petio_role_docker_force_kill

# Type: string
petio_role_docker_force_kill:

petio_role_docker_healthcheck

# Type: dict
petio_role_docker_healthcheck:

petio_role_docker_healthy_wait_timeout

# Type: int
petio_role_docker_healthy_wait_timeout:

petio_role_docker_init

# Type: bool (true/false)
petio_role_docker_init:

petio_role_docker_kill_signal

# Type: string
petio_role_docker_kill_signal:

petio_role_docker_log_driver

# Type: string
petio_role_docker_log_driver:

petio_role_docker_log_options

# Type: dict
petio_role_docker_log_options:

petio_role_docker_oom_killer

# Type: bool (true/false)
petio_role_docker_oom_killer:

petio_role_docker_oom_score_adj

# Type: int
petio_role_docker_oom_score_adj:

petio_role_docker_output_logs

# Type: bool (true/false)
petio_role_docker_output_logs:

petio_role_docker_paused

# Type: bool (true/false)
petio_role_docker_paused:

petio_role_docker_recreate

# Type: bool (true/false)
petio_role_docker_recreate:

petio_role_docker_restart_retries

# Type: int
petio_role_docker_restart_retries:

petio_role_docker_stop_timeout

# Type: int
petio_role_docker_stop_timeout:

Other Options

petio_role_docker_capabilities

# Type: list
petio_role_docker_capabilities:

petio_role_docker_cgroup_parent

# Type: string
petio_role_docker_cgroup_parent:

petio_role_docker_commands

# Type: list
petio_role_docker_commands:

petio_role_docker_create_timeout

# Type: int
petio_role_docker_create_timeout:

petio_role_docker_entrypoint

# Type: string
petio_role_docker_entrypoint:

petio_role_docker_env_file

# Type: string
petio_role_docker_env_file:

petio_role_docker_labels

# Type: dict
petio_role_docker_labels:

petio_role_docker_labels_use_common

# Type: bool (true/false)
petio_role_docker_labels_use_common:

petio_role_docker_read_only

# Type: bool (true/false)
petio_role_docker_read_only:

petio_role_docker_runtime

# Type: string
petio_role_docker_runtime:

petio_role_docker_sysctls

# Type: list
petio_role_docker_sysctls:

petio_role_docker_ulimits

# Type: list
petio_role_docker_ulimits:

petio_role_autoheal_enabled

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

petio_role_depends_on

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

petio_role_depends_on_delay

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

petio_role_depends_on_healthchecks

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

petio_role_diun_enabled

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

petio_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
petio_role_dns_enabled: true

petio_role_docker_controller

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

petio_role_docker_image_repo

# Type: string
petio_role_docker_image_repo:

petio_role_docker_image_tag

# Type: string
petio_role_docker_image_tag:

petio_role_docker_volumes_download

# Type: bool (true/false)
petio_role_docker_volumes_download:

petio_role_themepark_addons

# Type: string
petio_role_themepark_addons:

petio_role_themepark_app

# Type: string
petio_role_themepark_app:

petio_role_themepark_theme

# Type: string
petio_role_themepark_theme:

petio_role_traefik_api_endpoint

# Type: dict/omit
petio_role_traefik_api_endpoint:

petio_role_traefik_api_middleware

# Type: string
petio_role_traefik_api_middleware:

petio_role_traefik_api_middleware_http

# Type: string
petio_role_traefik_api_middleware_http:

petio_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
petio_role_traefik_autodetect_enabled: false

petio_role_traefik_certresolver

# Type: string
petio_role_traefik_certresolver:

petio_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
petio_role_traefik_crowdsec_enabled: false

petio_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
petio_role_traefik_error_pages_enabled: false

petio_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
petio_role_traefik_gzip_enabled: false

petio_role_traefik_middleware_http

# Type: string
petio_role_traefik_middleware_http:

petio_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
petio_role_traefik_middleware_http_api_insecure:

petio_role_traefik_middleware_http_insecure

# Type: bool (true/false)
petio_role_traefik_middleware_http_insecure:

petio_role_traefik_priority

# Type: string
petio_role_traefik_priority:

petio_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
petio_role_traefik_robot_enabled: true

petio_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
petio_role_traefik_tailscale_enabled: false

petio_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
petio_role_traefik_wildcard_enabled: true

petio_role_web_domain

# Type: string
petio_role_web_domain:

petio_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
petio_role_web_fqdn_override:

Example Override

petio_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "petio2.{{ user.domain }}"
  - "petio.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

petio_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
petio_role_web_host_override:

Example Override

petio_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'petio2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

petio_role_web_http_port

# Type: string (quoted number)
petio_role_web_http_port:

petio_role_web_http_scheme

# Type: string ("http"/"https")
petio_role_web_http_scheme:

petio_role_web_http_serverstransport

# Type: dict/omit
petio_role_web_http_serverstransport:

petio_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
petio_role_web_scheme:

petio_role_web_serverstransport

# Type: dict/omit
petio_role_web_serverstransport:

petio_role_web_subdomain

# Type: string
petio_role_web_subdomain: