Puddletag¶
| Description / name | Input element |
|---|---|
| Your domain name |
Overview¶
Puddletag is an audio tag editor (primarily created) for GNU/Linux similar to the Windows program, Mp3tag. Unlike most taggers for GNU/Linux, it uses a spreadsheet-like layout so that all the tags you want to edit by hand are visible and easily editable.
Deployment¶
sb install sandbox-puddletag
Usage¶
Visit https://puddletag.iYOUR_DOMAIN_NAMEi.
Basics¶
- Default login:
Username: "your user from accounts.yml"
Password: your_normal_password
Role Defaults¶
Use the Inventory to customize variables. (1)
-
Example override
puddletag_name: "custom_value"Avoid overriding variables ending in
_defaultWhen overriding variables that end in
_default(likepuddletag_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
_customvariable (likepuddletag_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.
puddletag_name
# Type: string
puddletag_name: puddletag
puddletag_role_web_subdomain
# Type: string
puddletag_role_web_subdomain: "{{ puddletag_name }}"
puddletag_role_web_domain
# Type: string
puddletag_role_web_domain: "{{ user.domain }}"
puddletag_role_web_port
# Type: string
puddletag_role_web_port: "8080"
puddletag_role_web_url
# Type: string
puddletag_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='puddletag') + '.' + lookup('role_var', '_web_domain', role='puddletag')
if (lookup('role_var', '_web_subdomain', role='puddletag') | length > 0)
else lookup('role_var', '_web_domain', role='puddletag')) }}"
puddletag_role_dns_record
# Type: string
puddletag_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='puddletag') }}"
puddletag_role_dns_zone
# Type: string
puddletag_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='puddletag') }}"
puddletag_role_dns_proxy
# Type: bool (true/false)
puddletag_role_dns_proxy: "{{ dns_proxied }}"
puddletag_role_traefik_sso_middleware
# Type: string
puddletag_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"
puddletag_role_traefik_middleware_default
# Type: string
puddletag_role_traefik_middleware_default: "{{ traefik_default_middleware }}"
puddletag_role_traefik_middleware_custom
# Type: string
puddletag_role_traefik_middleware_custom: ""
puddletag_role_traefik_certresolver
# Type: string
puddletag_role_traefik_certresolver: "{{ traefik_default_certresolver }}"
puddletag_role_traefik_enabled
# Type: bool (true/false)
puddletag_role_traefik_enabled: true
puddletag_role_traefik_api_enabled
# Type: bool (true/false)
puddletag_role_traefik_api_enabled: false
puddletag_role_traefik_api_endpoint
# Type: string
puddletag_role_traefik_api_endpoint: ""
Container
puddletag_role_docker_container
# Type: string
puddletag_role_docker_container: "{{ puddletag_name }}"
Image
puddletag_role_docker_image_pull
# Type: bool (true/false)
puddletag_role_docker_image_pull: true
puddletag_role_docker_image_repo
# Type: string
puddletag_role_docker_image_repo: "xirg/docker-puddletag"
puddletag_role_docker_image_tag
# Type: string
puddletag_role_docker_image_tag: "latest"
puddletag_role_docker_image
# Type: string
puddletag_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='puddletag') }}:{{ lookup('role_var', '_docker_image_tag', role='puddletag') }}"
Envs
puddletag_role_docker_envs_default
# Type: dict
puddletag_role_docker_envs_default:
PUID: "{{ uid }}"
PGID: "{{ gid }}"
TZ: "{{ tz }}"
APPNAME: "{{ puddletag_name }}"
GUAC_USER: "{{ user.name }}"
GUAC_PASS: "{{ user.pass | hash('md5') }}"
puddletag_role_docker_envs_custom
# Type: dict
puddletag_role_docker_envs_custom: {}
Volumes
puddletag_role_docker_volumes_default
# Type: list
puddletag_role_docker_volumes_default:
- "{{ lookup('role_var', '_paths_location', role='puddletag') }}:/config"
puddletag_role_docker_volumes_custom
# Type: list
puddletag_role_docker_volumes_custom: []
Hostname
puddletag_role_docker_hostname
# Type: string
puddletag_role_docker_hostname: "{{ puddletag_name }}"
Networks
puddletag_role_docker_networks_alias
# Type: string
puddletag_role_docker_networks_alias: "{{ puddletag_name }}"
puddletag_role_docker_networks_default
# Type: list
puddletag_role_docker_networks_default: []
puddletag_role_docker_networks_custom
# Type: list
puddletag_role_docker_networks_custom: []
Restart Policy
puddletag_role_docker_restart_policy
# Type: string
puddletag_role_docker_restart_policy: unless-stopped
State
puddletag_role_docker_state
# Type: string
puddletag_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
puddletag_role_docker_blkio_weight
# Type: int
puddletag_role_docker_blkio_weight:
puddletag_role_docker_cpu_period
# Type: int
puddletag_role_docker_cpu_period:
puddletag_role_docker_cpu_quota
# Type: int
puddletag_role_docker_cpu_quota:
puddletag_role_docker_cpu_shares
# Type: int
puddletag_role_docker_cpu_shares:
puddletag_role_docker_cpus
# Type: string
puddletag_role_docker_cpus:
puddletag_role_docker_cpuset_cpus
# Type: string
puddletag_role_docker_cpuset_cpus:
puddletag_role_docker_cpuset_mems
# Type: string
puddletag_role_docker_cpuset_mems:
puddletag_role_docker_kernel_memory
# Type: string
puddletag_role_docker_kernel_memory:
puddletag_role_docker_memory
# Type: string
puddletag_role_docker_memory:
puddletag_role_docker_memory_reservation
# Type: string
puddletag_role_docker_memory_reservation:
puddletag_role_docker_memory_swap
# Type: string
puddletag_role_docker_memory_swap:
puddletag_role_docker_memory_swappiness
# Type: int
puddletag_role_docker_memory_swappiness:
puddletag_role_docker_shm_size
# Type: string
puddletag_role_docker_shm_size:
Security & Devices
puddletag_role_docker_cap_drop
# Type: list
puddletag_role_docker_cap_drop:
puddletag_role_docker_cgroupns_mode
# Type: string
puddletag_role_docker_cgroupns_mode:
puddletag_role_docker_device_cgroup_rules
# Type: list
puddletag_role_docker_device_cgroup_rules:
puddletag_role_docker_device_read_bps
# Type: list
puddletag_role_docker_device_read_bps:
puddletag_role_docker_device_read_iops
# Type: list
puddletag_role_docker_device_read_iops:
puddletag_role_docker_device_requests
# Type: list
puddletag_role_docker_device_requests:
puddletag_role_docker_device_write_bps
# Type: list
puddletag_role_docker_device_write_bps:
puddletag_role_docker_device_write_iops
# Type: list
puddletag_role_docker_device_write_iops:
puddletag_role_docker_devices
# Type: list
puddletag_role_docker_devices:
puddletag_role_docker_devices_default
# Type: string
puddletag_role_docker_devices_default:
puddletag_role_docker_groups
# Type: list
puddletag_role_docker_groups:
puddletag_role_docker_privileged
# Type: bool (true/false)
puddletag_role_docker_privileged:
puddletag_role_docker_security_opts
# Type: list
puddletag_role_docker_security_opts:
puddletag_role_docker_user
# Type: string
puddletag_role_docker_user:
puddletag_role_docker_userns_mode
# Type: string
puddletag_role_docker_userns_mode:
Networking
puddletag_role_docker_dns_opts
# Type: list
puddletag_role_docker_dns_opts:
puddletag_role_docker_dns_search_domains
# Type: list
puddletag_role_docker_dns_search_domains:
puddletag_role_docker_dns_servers
# Type: list
puddletag_role_docker_dns_servers:
puddletag_role_docker_domainname
# Type: string
puddletag_role_docker_domainname:
puddletag_role_docker_exposed_ports
# Type: list
puddletag_role_docker_exposed_ports:
puddletag_role_docker_hosts
# Type: dict
puddletag_role_docker_hosts:
puddletag_role_docker_hosts_use_common
# Type: bool (true/false)
puddletag_role_docker_hosts_use_common:
puddletag_role_docker_ipc_mode
# Type: string
puddletag_role_docker_ipc_mode:
puddletag_role_docker_links
# Type: list
puddletag_role_docker_links:
puddletag_role_docker_network_mode
# Type: string
puddletag_role_docker_network_mode:
puddletag_role_docker_pid_mode
# Type: string
puddletag_role_docker_pid_mode:
puddletag_role_docker_ports
# Type: list
puddletag_role_docker_ports:
puddletag_role_docker_uts
# Type: string
puddletag_role_docker_uts:
Storage
puddletag_role_docker_keep_volumes
# Type: bool (true/false)
puddletag_role_docker_keep_volumes:
puddletag_role_docker_mounts
# Type: list
puddletag_role_docker_mounts:
puddletag_role_docker_storage_opts
# Type: dict
puddletag_role_docker_storage_opts:
puddletag_role_docker_tmpfs
# Type: list
puddletag_role_docker_tmpfs:
puddletag_role_docker_volume_driver
# Type: string
puddletag_role_docker_volume_driver:
puddletag_role_docker_volumes_from
# Type: list
puddletag_role_docker_volumes_from:
puddletag_role_docker_volumes_global
# Type: bool (true/false)
puddletag_role_docker_volumes_global:
puddletag_role_docker_working_dir
# Type: string
puddletag_role_docker_working_dir:
Monitoring & Lifecycle
puddletag_role_docker_auto_remove
# Type: bool (true/false)
puddletag_role_docker_auto_remove:
puddletag_role_docker_cleanup
# Type: bool (true/false)
puddletag_role_docker_cleanup:
puddletag_role_docker_force_kill
# Type: string
puddletag_role_docker_force_kill:
puddletag_role_docker_healthcheck
# Type: dict
puddletag_role_docker_healthcheck:
puddletag_role_docker_healthy_wait_timeout
# Type: int
puddletag_role_docker_healthy_wait_timeout:
puddletag_role_docker_init
# Type: bool (true/false)
puddletag_role_docker_init:
puddletag_role_docker_kill_signal
# Type: string
puddletag_role_docker_kill_signal:
puddletag_role_docker_log_driver
# Type: string
puddletag_role_docker_log_driver:
puddletag_role_docker_log_options
# Type: dict
puddletag_role_docker_log_options:
puddletag_role_docker_oom_killer
# Type: bool (true/false)
puddletag_role_docker_oom_killer:
puddletag_role_docker_oom_score_adj
# Type: int
puddletag_role_docker_oom_score_adj:
puddletag_role_docker_output_logs
# Type: bool (true/false)
puddletag_role_docker_output_logs:
puddletag_role_docker_paused
# Type: bool (true/false)
puddletag_role_docker_paused:
puddletag_role_docker_recreate
# Type: bool (true/false)
puddletag_role_docker_recreate:
puddletag_role_docker_restart_retries
# Type: int
puddletag_role_docker_restart_retries:
puddletag_role_docker_stop_timeout
# Type: int
puddletag_role_docker_stop_timeout:
Other Options
puddletag_role_docker_capabilities
# Type: list
puddletag_role_docker_capabilities:
puddletag_role_docker_cgroup_parent
# Type: string
puddletag_role_docker_cgroup_parent:
puddletag_role_docker_commands
# Type: list
puddletag_role_docker_commands:
puddletag_role_docker_create_timeout
# Type: int
puddletag_role_docker_create_timeout:
puddletag_role_docker_entrypoint
# Type: string
puddletag_role_docker_entrypoint:
puddletag_role_docker_env_file
# Type: string
puddletag_role_docker_env_file:
puddletag_role_docker_labels
# Type: dict
puddletag_role_docker_labels:
puddletag_role_docker_labels_use_common
# Type: bool (true/false)
puddletag_role_docker_labels_use_common:
puddletag_role_docker_read_only
# Type: bool (true/false)
puddletag_role_docker_read_only:
puddletag_role_docker_runtime
# Type: string
puddletag_role_docker_runtime:
puddletag_role_docker_sysctls
# Type: list
puddletag_role_docker_sysctls:
puddletag_role_docker_ulimits
# Type: list
puddletag_role_docker_ulimits:
puddletag_role_autoheal_enabled
# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
puddletag_role_autoheal_enabled: true
puddletag_role_depends_on
# List of container dependencies that must be running before the container start
# Type: string
puddletag_role_depends_on: ""
puddletag_role_depends_on_delay
# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
puddletag_role_depends_on_delay: "0"
puddletag_role_depends_on_healthchecks
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
puddletag_role_depends_on_healthchecks:
puddletag_role_diun_enabled
# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
puddletag_role_diun_enabled: true
puddletag_role_dns_enabled
# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
puddletag_role_dns_enabled: true
puddletag_role_docker_controller
# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
puddletag_role_docker_controller: true
puddletag_role_docker_image_repo
# Type: string
puddletag_role_docker_image_repo:
puddletag_role_docker_image_tag
# Type: string
puddletag_role_docker_image_tag:
puddletag_role_docker_volumes_download
# Type: bool (true/false)
puddletag_role_docker_volumes_download:
puddletag_role_paths_location
# Type: string
puddletag_role_paths_location:
puddletag_role_themepark_addons
# Type: string
puddletag_role_themepark_addons:
puddletag_role_themepark_app
# Type: string
puddletag_role_themepark_app:
puddletag_role_themepark_theme
# Type: string
puddletag_role_themepark_theme:
puddletag_role_traefik_api_endpoint
# Type: dict/omit
puddletag_role_traefik_api_endpoint:
puddletag_role_traefik_api_middleware
# Type: string
puddletag_role_traefik_api_middleware:
puddletag_role_traefik_api_middleware_http
# Type: string
puddletag_role_traefik_api_middleware_http:
puddletag_role_traefik_autodetect_enabled
# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
puddletag_role_traefik_autodetect_enabled: false
puddletag_role_traefik_certresolver
# Type: string
puddletag_role_traefik_certresolver:
puddletag_role_traefik_crowdsec_enabled
# Enable CrowdSec middleware for the container
# Type: bool (true/false)
puddletag_role_traefik_crowdsec_enabled: false
puddletag_role_traefik_error_pages_enabled
# Enable custom error pages middleware for the container
# Type: bool (true/false)
puddletag_role_traefik_error_pages_enabled: false
puddletag_role_traefik_gzip_enabled
# Enable gzip compression middleware for the container
# Type: bool (true/false)
puddletag_role_traefik_gzip_enabled: false
puddletag_role_traefik_middleware_http
# Type: string
puddletag_role_traefik_middleware_http:
puddletag_role_traefik_middleware_http_api_insecure
# Type: bool (true/false)
puddletag_role_traefik_middleware_http_api_insecure:
puddletag_role_traefik_middleware_http_insecure
# Type: bool (true/false)
puddletag_role_traefik_middleware_http_insecure:
puddletag_role_traefik_priority
# Type: string
puddletag_role_traefik_priority:
puddletag_role_traefik_robot_enabled
# Enable robots.txt middleware for the container
# Type: bool (true/false)
puddletag_role_traefik_robot_enabled: true
puddletag_role_traefik_tailscale_enabled
# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
puddletag_role_traefik_tailscale_enabled: false
puddletag_role_traefik_wildcard_enabled
# Enable wildcard certificate for the container
# Type: bool (true/false)
puddletag_role_traefik_wildcard_enabled: true
puddletag_role_web_domain
# Type: string
puddletag_role_web_domain:
puddletag_role_web_fqdn_override
# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
puddletag_role_web_fqdn_override:
Example Override
puddletag_role_web_fqdn_override:
- "{{ traefik_host }}"
- "puddletag2.{{ user.domain }}"
- "puddletag.otherdomain.tld"
Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries
puddletag_role_web_host_override
# Override the Traefik web host configuration for the container
# Type: string
puddletag_role_web_host_override:
Example Override
puddletag_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'puddletag2.' + user.domain }}`)"
Note: Use {{ traefik_host }} to include the default host configuration in your custom rule
puddletag_role_web_http_port
# Type: string (quoted number)
puddletag_role_web_http_port:
puddletag_role_web_http_scheme
# Type: string ("http"/"https")
puddletag_role_web_http_scheme:
puddletag_role_web_http_serverstransport
# Type: dict/omit
puddletag_role_web_http_serverstransport:
puddletag_role_web_scheme
# URL scheme to use for web access to the container
# Type: string ("http"/"https")
puddletag_role_web_scheme:
puddletag_role_web_serverstransport
# Type: dict/omit
puddletag_role_web_serverstransport:
puddletag_role_web_subdomain
# Type: string
puddletag_role_web_subdomain: