Mylar3¶

Description / name	Input element
Your domain name

Overview¶

Mylar3 is an automated Comic Book downloader (cbr/cbz) for use with NZB and torrents written in python. It supports SABnzbd, NZBGET, and many torrent clients in addition to DDL.

Manual

Releases

Community

Deployment¶

sb install sandbox-mylar3

Usage¶

Visit https://mylar3.iYOUR_DOMAIN_NAMEi.

Basics¶

It's highly unlikely your mylar install is up to date.
Press the Update link on the dialog in the bottom right hand corner. Mylar3 will update and then restart.
Enable some authentication. Add a username and password and set your preferred login method.
Make sure Launch Browser on startup is disabled.
You'll need a ComicVine API Key for Mylar to be useful. Create an account, and your key will be at the top of this page.
Set the Comic Location path to /comics. It will already be mounted.
Uncheck enforce permissions
Optional: Enable Series-Annual Integration
Save and then restart the app

Note

If you enable to OPDS server, DO NOT ENABLE OPDS Fetch MetaInfo. It queries the file system.

Download settings¶

(These instructions are for NZBGet. Adapt for other Download Apps)

Configure NZBGet¶

Log into https://nzbget.iYOUR_DOMAIN_NAMEi
Go to Settings > Categories
Scroll to bottom, click Add Another Category
Name it mylar

Configure Mylar¶

Set Usenet client to NZBGet
Fill in the server stuff like it would be in sonarr / radarr / etc
Set values:
Host: nzbget
Port: 6789
Username: Your NZBGet Username
Password: Your NZBGet Password
Category: mylar
Use SSL: No
NZBGet Download Directory: Leave Blank
Enable Completed Download Handling: X

Search Providers¶

Click Add Indexer (+).
Select "Newznab".
Add the following:
1. Use Newznab: X
2. NewzNab Name: NZBHydra2
3. NewzNab Host: http://nzbhydra2:5076
4. Verify SSL: Disabled
5. API Key: Your NZBHydra2 API Key
6. Enabled: X

Quality and Post Processing¶

Enable Failed Download Handling: X
Enable Automatic-Retry for Failed Downloads: X
Enable Post-Processing: X
When Post-Processing move the files

Advanced Settings¶

These settings are up to the user

Rename Files: X
Folder Format: $Series ($Year) (My recommendation)
File Format: $Series $Annual $Issue ($Year) (My recommendation)

Role Defaults¶

Use the Inventory to customize variables. (1)

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

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

BasicsWebDNSTraefikDockerDocker+Global Override Options

mylar3_name

# Type: string
mylar3_name: mylar3

mylar3_role_web_subdomain

# Type: string
mylar3_role_web_subdomain: "{{ mylar3_name }}"

mylar3_role_web_domain

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

mylar3_role_web_port

# Type: string
mylar3_role_web_port: "8090"

mylar3_role_web_url

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

mylar3_role_dns_record

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

mylar3_role_dns_zone

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

mylar3_role_dns_proxy

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

mylar3_role_traefik_sso_middleware

# Type: string
mylar3_role_traefik_sso_middleware: ""

mylar3_role_traefik_middleware_default

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

mylar3_role_traefik_middleware_custom

# Type: string
mylar3_role_traefik_middleware_custom: ""

mylar3_role_traefik_certresolver

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

mylar3_role_traefik_enabled

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

mylar3_role_traefik_api_enabled

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

mylar3_role_traefik_api_endpoint

# Type: string
mylar3_role_traefik_api_endpoint: ""

Container

mylar3_role_docker_container

# Type: string
mylar3_role_docker_container: "{{ mylar3_name }}"

Image

mylar3_role_docker_image_pull

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

mylar3_role_docker_image_tag

# Type: string
mylar3_role_docker_image_tag: "latest"

mylar3_role_docker_image_repo

# Type: string
mylar3_role_docker_image_repo: "lscr.io/linuxserver/mylar3"

mylar3_role_docker_image

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

Envs

mylar3_role_docker_envs_default

# Type: dict
mylar3_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"

mylar3_role_docker_envs_custom

# Type: dict
mylar3_role_docker_envs_custom: {}

Volumes

mylar3_role_docker_volumes_default

# Type: list
mylar3_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='mylar3') }}:/config"
  - "/mnt/unionfs/Media/Comics:/comics"

mylar3_role_docker_volumes_custom

# Type: list
mylar3_role_docker_volumes_custom: []

Hostname

mylar3_role_docker_hostname

# Type: string
mylar3_role_docker_hostname: "{{ mylar3_name }}"

Networks

mylar3_role_docker_networks_alias

# Type: string
mylar3_role_docker_networks_alias: "{{ mylar3_name }}"

mylar3_role_docker_networks_default

# Type: list
mylar3_role_docker_networks_default: []

mylar3_role_docker_networks_custom

# Type: list
mylar3_role_docker_networks_custom: []

Restart Policy

mylar3_role_docker_restart_policy

# Type: string
mylar3_role_docker_restart_policy: unless-stopped

State

mylar3_role_docker_state

# Type: string
mylar3_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

mylar3_role_docker_blkio_weight

# Type: int
mylar3_role_docker_blkio_weight:

mylar3_role_docker_cpu_period

# Type: int
mylar3_role_docker_cpu_period:

mylar3_role_docker_cpu_quota

# Type: int
mylar3_role_docker_cpu_quota:

mylar3_role_docker_cpu_shares

# Type: int
mylar3_role_docker_cpu_shares:

mylar3_role_docker_cpus

# Type: string
mylar3_role_docker_cpus:

mylar3_role_docker_cpuset_cpus

# Type: string
mylar3_role_docker_cpuset_cpus:

mylar3_role_docker_cpuset_mems

# Type: string
mylar3_role_docker_cpuset_mems:

mylar3_role_docker_kernel_memory

# Type: string
mylar3_role_docker_kernel_memory:

mylar3_role_docker_memory

# Type: string
mylar3_role_docker_memory:

mylar3_role_docker_memory_reservation

# Type: string
mylar3_role_docker_memory_reservation:

mylar3_role_docker_memory_swap

# Type: string
mylar3_role_docker_memory_swap:

mylar3_role_docker_memory_swappiness

# Type: int
mylar3_role_docker_memory_swappiness:

mylar3_role_docker_shm_size

# Type: string
mylar3_role_docker_shm_size:

Security & Devices

mylar3_role_docker_cap_drop

# Type: list
mylar3_role_docker_cap_drop:

mylar3_role_docker_cgroupns_mode

# Type: string
mylar3_role_docker_cgroupns_mode:

mylar3_role_docker_device_cgroup_rules

# Type: list
mylar3_role_docker_device_cgroup_rules:

mylar3_role_docker_device_read_bps

# Type: list
mylar3_role_docker_device_read_bps:

mylar3_role_docker_device_read_iops

# Type: list
mylar3_role_docker_device_read_iops:

mylar3_role_docker_device_requests

# Type: list
mylar3_role_docker_device_requests:

mylar3_role_docker_device_write_bps

# Type: list
mylar3_role_docker_device_write_bps:

mylar3_role_docker_device_write_iops

# Type: list
mylar3_role_docker_device_write_iops:

mylar3_role_docker_devices

# Type: list
mylar3_role_docker_devices:

mylar3_role_docker_devices_default

# Type: string
mylar3_role_docker_devices_default:

mylar3_role_docker_groups

# Type: list
mylar3_role_docker_groups:

mylar3_role_docker_privileged

# Type: bool (true/false)
mylar3_role_docker_privileged:

mylar3_role_docker_security_opts

# Type: list
mylar3_role_docker_security_opts:

mylar3_role_docker_user

# Type: string
mylar3_role_docker_user:

mylar3_role_docker_userns_mode

# Type: string
mylar3_role_docker_userns_mode:

Networking

mylar3_role_docker_dns_opts

# Type: list
mylar3_role_docker_dns_opts:

mylar3_role_docker_dns_search_domains

# Type: list
mylar3_role_docker_dns_search_domains:

mylar3_role_docker_dns_servers

# Type: list
mylar3_role_docker_dns_servers:

mylar3_role_docker_domainname

# Type: string
mylar3_role_docker_domainname:

mylar3_role_docker_exposed_ports

# Type: list
mylar3_role_docker_exposed_ports:

mylar3_role_docker_hosts

# Type: dict
mylar3_role_docker_hosts:

mylar3_role_docker_hosts_use_common

# Type: bool (true/false)
mylar3_role_docker_hosts_use_common:

mylar3_role_docker_ipc_mode

# Type: string
mylar3_role_docker_ipc_mode:

mylar3_role_docker_links

# Type: list
mylar3_role_docker_links:

mylar3_role_docker_network_mode

# Type: string
mylar3_role_docker_network_mode:

mylar3_role_docker_pid_mode

# Type: string
mylar3_role_docker_pid_mode:

mylar3_role_docker_ports

# Type: list
mylar3_role_docker_ports:

mylar3_role_docker_uts

# Type: string
mylar3_role_docker_uts:

Storage

mylar3_role_docker_keep_volumes

# Type: bool (true/false)
mylar3_role_docker_keep_volumes:

mylar3_role_docker_mounts

# Type: list
mylar3_role_docker_mounts:

mylar3_role_docker_storage_opts

# Type: dict
mylar3_role_docker_storage_opts:

mylar3_role_docker_tmpfs

# Type: list
mylar3_role_docker_tmpfs:

mylar3_role_docker_volume_driver

# Type: string
mylar3_role_docker_volume_driver:

mylar3_role_docker_volumes_from

# Type: list
mylar3_role_docker_volumes_from:

mylar3_role_docker_volumes_global

# Type: bool (true/false)
mylar3_role_docker_volumes_global:

mylar3_role_docker_working_dir

# Type: string
mylar3_role_docker_working_dir:

Monitoring & Lifecycle

mylar3_role_docker_auto_remove

# Type: bool (true/false)
mylar3_role_docker_auto_remove:

mylar3_role_docker_cleanup

# Type: bool (true/false)
mylar3_role_docker_cleanup:

mylar3_role_docker_force_kill

# Type: string
mylar3_role_docker_force_kill:

mylar3_role_docker_healthcheck

# Type: dict
mylar3_role_docker_healthcheck:

mylar3_role_docker_healthy_wait_timeout

# Type: int
mylar3_role_docker_healthy_wait_timeout:

mylar3_role_docker_init

# Type: bool (true/false)
mylar3_role_docker_init:

mylar3_role_docker_kill_signal

# Type: string
mylar3_role_docker_kill_signal:

mylar3_role_docker_log_driver

# Type: string
mylar3_role_docker_log_driver:

mylar3_role_docker_log_options

# Type: dict
mylar3_role_docker_log_options:

mylar3_role_docker_oom_killer

# Type: bool (true/false)
mylar3_role_docker_oom_killer:

mylar3_role_docker_oom_score_adj

# Type: int
mylar3_role_docker_oom_score_adj:

mylar3_role_docker_output_logs

# Type: bool (true/false)
mylar3_role_docker_output_logs:

mylar3_role_docker_paused

# Type: bool (true/false)
mylar3_role_docker_paused:

mylar3_role_docker_recreate

# Type: bool (true/false)
mylar3_role_docker_recreate:

mylar3_role_docker_restart_retries

# Type: int
mylar3_role_docker_restart_retries:

mylar3_role_docker_stop_timeout

# Type: int
mylar3_role_docker_stop_timeout:

Other Options

mylar3_role_docker_capabilities

# Type: list
mylar3_role_docker_capabilities:

mylar3_role_docker_cgroup_parent

# Type: string
mylar3_role_docker_cgroup_parent:

mylar3_role_docker_commands

# Type: list
mylar3_role_docker_commands:

mylar3_role_docker_create_timeout

# Type: int
mylar3_role_docker_create_timeout:

mylar3_role_docker_entrypoint

# Type: string
mylar3_role_docker_entrypoint:

mylar3_role_docker_env_file

# Type: string
mylar3_role_docker_env_file:

mylar3_role_docker_labels

# Type: dict
mylar3_role_docker_labels:

mylar3_role_docker_labels_use_common

# Type: bool (true/false)
mylar3_role_docker_labels_use_common:

mylar3_role_docker_read_only

# Type: bool (true/false)
mylar3_role_docker_read_only:

mylar3_role_docker_runtime

# Type: string
mylar3_role_docker_runtime:

mylar3_role_docker_sysctls

# Type: list
mylar3_role_docker_sysctls:

mylar3_role_docker_ulimits

# Type: list
mylar3_role_docker_ulimits:

mylar3_role_autoheal_enabled

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

mylar3_role_depends_on

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

mylar3_role_depends_on_delay

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

mylar3_role_depends_on_healthchecks

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

mylar3_role_diun_enabled

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

mylar3_role_dns_enabled

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

mylar3_role_docker_controller

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

mylar3_role_docker_image_repo

# Type: string
mylar3_role_docker_image_repo:

mylar3_role_docker_image_tag

# Type: string
mylar3_role_docker_image_tag:

mylar3_role_docker_volumes_download

# Type: bool (true/false)
mylar3_role_docker_volumes_download:

mylar3_role_paths_location

# Type: string
mylar3_role_paths_location:

mylar3_role_themepark_addons

# Type: string
mylar3_role_themepark_addons:

mylar3_role_themepark_app

# Type: string
mylar3_role_themepark_app:

mylar3_role_themepark_theme

# Type: string
mylar3_role_themepark_theme:

mylar3_role_traefik_api_endpoint

# Type: dict/omit
mylar3_role_traefik_api_endpoint:

mylar3_role_traefik_api_middleware

# Type: string
mylar3_role_traefik_api_middleware:

mylar3_role_traefik_api_middleware_http

# Type: string
mylar3_role_traefik_api_middleware_http:

mylar3_role_traefik_autodetect_enabled

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

mylar3_role_traefik_certresolver

# Type: string
mylar3_role_traefik_certresolver:

mylar3_role_traefik_crowdsec_enabled

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

mylar3_role_traefik_error_pages_enabled

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

mylar3_role_traefik_gzip_enabled

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

mylar3_role_traefik_middleware_http

# Type: string
mylar3_role_traefik_middleware_http:

mylar3_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
mylar3_role_traefik_middleware_http_api_insecure:

mylar3_role_traefik_middleware_http_insecure

# Type: bool (true/false)
mylar3_role_traefik_middleware_http_insecure:

mylar3_role_traefik_priority

# Type: string
mylar3_role_traefik_priority:

mylar3_role_traefik_robot_enabled

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

mylar3_role_traefik_tailscale_enabled

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

mylar3_role_traefik_wildcard_enabled

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

mylar3_role_web_domain

# Type: string
mylar3_role_web_domain:

mylar3_role_web_fqdn_override

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

Example Override

mylar3_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "mylar32.{{ user.domain }}"
  - "mylar3.otherdomain.tld"

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

mylar3_role_web_host_override

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

Example Override

mylar3_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'mylar32.' + user.domain }}`)"

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

mylar3_role_web_http_port

# Type: string (quoted number)
mylar3_role_web_http_port:

mylar3_role_web_http_scheme

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

mylar3_role_web_http_serverstransport

# Type: dict/omit
mylar3_role_web_http_serverstransport:

mylar3_role_web_scheme

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

mylar3_role_web_serverstransport

# Type: dict/omit
mylar3_role_web_serverstransport:

mylar3_role_web_subdomain

# Type: string
mylar3_role_web_subdomain: