JDownloader¶

Description / name	Input element
Your domain name

Overview¶

JDownloader is a free download-manager that makes downloading as easy, fast and automated as it should be. It's like your personal internet robot that does all the work for you. He will download whole photo albums, playlists or just about anything else with just one click. Go ahead and try it!.

Manual

Releases

Community

Deployment¶

sb install sandbox-jdownloader2

Usage¶

Visit https://jdownloader2.iYOUR_DOMAIN_NAMEi.

Basics¶

The configured password is taken from your Saltbox accounts.yml file located in /srv/git/saltbox/accounts.yml
Configure your myjdownloader account (Create at https://my.jdownloader.org/ if needed) and name your instance so you can connect via web or browser extensions. Use clipboard for two step copy and paste if needed. Note that some settings are only accessible via jdownloader2.yourdomain.tld. Premium accounts such as mega.nz can be added via web interface.
Use manual import from sonarr / radarr and navigate to /mnt/local/downloads/myjdownloader/output/ to import your files, note they must be already added as wanted media for import to recognise and identify your downloaded media.
See https://my.jdownloader.org/ for browser extensions and phone apps as desired.

Role Defaults¶

Use the Inventory to customize variables. (1)

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

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

BasicsWebDNSTraefikDockerDocker+Global Override Options

jdownloader2_name

# Type: string
jdownloader2_name: jdownloader2

jdownloader2_role_web_subdomain

# Type: string
jdownloader2_role_web_subdomain: "{{ jdownloader2_name }}"

jdownloader2_role_web_domain

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

jdownloader2_role_web_port

# Type: string
jdownloader2_role_web_port: "5800"

jdownloader2_role_web_url

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

jdownloader2_role_dns_record

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

jdownloader2_role_dns_zone

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

jdownloader2_role_dns_proxy

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

jdownloader2_role_traefik_sso_middleware

# Type: string
jdownloader2_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

jdownloader2_role_traefik_middleware_default

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

jdownloader2_role_traefik_middleware_custom

# Type: string
jdownloader2_role_traefik_middleware_custom: ""

jdownloader2_role_traefik_certresolver

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

jdownloader2_role_traefik_enabled

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

jdownloader2_role_traefik_api_enabled

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

jdownloader2_role_traefik_api_endpoint

# Type: string
jdownloader2_role_traefik_api_endpoint: ""

Container

jdownloader2_role_docker_container

# Type: string
jdownloader2_role_docker_container: "{{ jdownloader2_name }}"

Image

jdownloader2_role_docker_image_pull

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

jdownloader2_role_docker_image_repo

# Type: string
jdownloader2_role_docker_image_repo: "jlesage/jdownloader-2"

jdownloader2_role_docker_image_tag

# Type: string
jdownloader2_role_docker_image_tag: "latest"

jdownloader2_role_docker_image

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

Envs

jdownloader2_role_docker_envs_default

# Type: dict
jdownloader2_role_docker_envs_default:
  USER_ID: "{{ uid }}"
  GROUP_ID: "{{ gid }}"
  TZ: "{{ tz }}"
  DISPLAY_WIDTH: "1280"
  DISPLAY_HEIGHT: "768"
  VNC_PASSWORD: "{{ user.pass }}"
  CLEAN_TMP_DIR: "1"
  UMASK: "000"
  ENABLE_CJK_FONT: "1"

jdownloader2_role_docker_envs_custom

# Type: dict
jdownloader2_role_docker_envs_custom: {}

Volumes

jdownloader2_role_docker_volumes_default

# Type: list
jdownloader2_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='jdownloader2') }}/config:/config"
  - "{{ lookup('role_var', '_paths_downloads_location', role='jdownloader2') }}:/output"

jdownloader2_role_docker_volumes_custom

# Type: list
jdownloader2_role_docker_volumes_custom: []

Hostname

jdownloader2_role_docker_hostname

# Type: string
jdownloader2_role_docker_hostname: "{{ jdownloader2_name }}"

Networks

jdownloader2_role_docker_networks_alias

# Type: string
jdownloader2_role_docker_networks_alias: "{{ jdownloader2_name }}"

jdownloader2_role_docker_networks_default

# Type: list
jdownloader2_role_docker_networks_default: []

jdownloader2_role_docker_networks_custom

# Type: list
jdownloader2_role_docker_networks_custom: []

Restart Policy

jdownloader2_role_docker_restart_policy

# Type: string
jdownloader2_role_docker_restart_policy: unless-stopped

State

jdownloader2_role_docker_state

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

jdownloader2_role_docker_blkio_weight

# Type: int
jdownloader2_role_docker_blkio_weight:

jdownloader2_role_docker_cpu_period

# Type: int
jdownloader2_role_docker_cpu_period:

jdownloader2_role_docker_cpu_quota

# Type: int
jdownloader2_role_docker_cpu_quota:

jdownloader2_role_docker_cpu_shares

# Type: int
jdownloader2_role_docker_cpu_shares:

jdownloader2_role_docker_cpus

# Type: string
jdownloader2_role_docker_cpus:

jdownloader2_role_docker_cpuset_cpus

# Type: string
jdownloader2_role_docker_cpuset_cpus:

jdownloader2_role_docker_cpuset_mems

# Type: string
jdownloader2_role_docker_cpuset_mems:

jdownloader2_role_docker_kernel_memory

# Type: string
jdownloader2_role_docker_kernel_memory:

jdownloader2_role_docker_memory

# Type: string
jdownloader2_role_docker_memory:

jdownloader2_role_docker_memory_reservation

# Type: string
jdownloader2_role_docker_memory_reservation:

jdownloader2_role_docker_memory_swap

# Type: string
jdownloader2_role_docker_memory_swap:

jdownloader2_role_docker_memory_swappiness

# Type: int
jdownloader2_role_docker_memory_swappiness:

jdownloader2_role_docker_shm_size

# Type: string
jdownloader2_role_docker_shm_size:

Security & Devices

jdownloader2_role_docker_cap_drop

# Type: list
jdownloader2_role_docker_cap_drop:

jdownloader2_role_docker_cgroupns_mode

# Type: string
jdownloader2_role_docker_cgroupns_mode:

jdownloader2_role_docker_device_cgroup_rules

# Type: list
jdownloader2_role_docker_device_cgroup_rules:

jdownloader2_role_docker_device_read_bps

# Type: list
jdownloader2_role_docker_device_read_bps:

jdownloader2_role_docker_device_read_iops

# Type: list
jdownloader2_role_docker_device_read_iops:

jdownloader2_role_docker_device_requests

# Type: list
jdownloader2_role_docker_device_requests:

jdownloader2_role_docker_device_write_bps

# Type: list
jdownloader2_role_docker_device_write_bps:

jdownloader2_role_docker_device_write_iops

# Type: list
jdownloader2_role_docker_device_write_iops:

jdownloader2_role_docker_devices

# Type: list
jdownloader2_role_docker_devices:

jdownloader2_role_docker_devices_default

# Type: string
jdownloader2_role_docker_devices_default:

jdownloader2_role_docker_groups

# Type: list
jdownloader2_role_docker_groups:

jdownloader2_role_docker_privileged

# Type: bool (true/false)
jdownloader2_role_docker_privileged:

jdownloader2_role_docker_security_opts

# Type: list
jdownloader2_role_docker_security_opts:

jdownloader2_role_docker_user

# Type: string
jdownloader2_role_docker_user:

jdownloader2_role_docker_userns_mode

# Type: string
jdownloader2_role_docker_userns_mode:

Networking

jdownloader2_role_docker_dns_opts

# Type: list
jdownloader2_role_docker_dns_opts:

jdownloader2_role_docker_dns_search_domains

# Type: list
jdownloader2_role_docker_dns_search_domains:

jdownloader2_role_docker_dns_servers

# Type: list
jdownloader2_role_docker_dns_servers:

jdownloader2_role_docker_domainname

# Type: string
jdownloader2_role_docker_domainname:

jdownloader2_role_docker_exposed_ports

# Type: list
jdownloader2_role_docker_exposed_ports:

jdownloader2_role_docker_hosts

# Type: dict
jdownloader2_role_docker_hosts:

jdownloader2_role_docker_hosts_use_common

# Type: bool (true/false)
jdownloader2_role_docker_hosts_use_common:

jdownloader2_role_docker_ipc_mode

# Type: string
jdownloader2_role_docker_ipc_mode:

jdownloader2_role_docker_links

# Type: list
jdownloader2_role_docker_links:

jdownloader2_role_docker_network_mode

# Type: string
jdownloader2_role_docker_network_mode:

jdownloader2_role_docker_pid_mode

# Type: string
jdownloader2_role_docker_pid_mode:

jdownloader2_role_docker_ports

# Type: list
jdownloader2_role_docker_ports:

jdownloader2_role_docker_uts

# Type: string
jdownloader2_role_docker_uts:

Storage

jdownloader2_role_docker_keep_volumes

# Type: bool (true/false)
jdownloader2_role_docker_keep_volumes:

jdownloader2_role_docker_mounts

# Type: list
jdownloader2_role_docker_mounts:

jdownloader2_role_docker_storage_opts

# Type: dict
jdownloader2_role_docker_storage_opts:

jdownloader2_role_docker_tmpfs

# Type: list
jdownloader2_role_docker_tmpfs:

jdownloader2_role_docker_volume_driver

# Type: string
jdownloader2_role_docker_volume_driver:

jdownloader2_role_docker_volumes_from

# Type: list
jdownloader2_role_docker_volumes_from:

jdownloader2_role_docker_volumes_global

# Type: bool (true/false)
jdownloader2_role_docker_volumes_global:

jdownloader2_role_docker_working_dir

# Type: string
jdownloader2_role_docker_working_dir:

Monitoring & Lifecycle

jdownloader2_role_docker_auto_remove

# Type: bool (true/false)
jdownloader2_role_docker_auto_remove:

jdownloader2_role_docker_cleanup

# Type: bool (true/false)
jdownloader2_role_docker_cleanup:

jdownloader2_role_docker_force_kill

# Type: string
jdownloader2_role_docker_force_kill:

jdownloader2_role_docker_healthcheck

# Type: dict
jdownloader2_role_docker_healthcheck:

jdownloader2_role_docker_healthy_wait_timeout

# Type: int
jdownloader2_role_docker_healthy_wait_timeout:

jdownloader2_role_docker_init

# Type: bool (true/false)
jdownloader2_role_docker_init:

jdownloader2_role_docker_kill_signal

# Type: string
jdownloader2_role_docker_kill_signal:

jdownloader2_role_docker_log_driver

# Type: string
jdownloader2_role_docker_log_driver:

jdownloader2_role_docker_log_options

# Type: dict
jdownloader2_role_docker_log_options:

jdownloader2_role_docker_oom_killer

# Type: bool (true/false)
jdownloader2_role_docker_oom_killer:

jdownloader2_role_docker_oom_score_adj

# Type: int
jdownloader2_role_docker_oom_score_adj:

jdownloader2_role_docker_output_logs

# Type: bool (true/false)
jdownloader2_role_docker_output_logs:

jdownloader2_role_docker_paused

# Type: bool (true/false)
jdownloader2_role_docker_paused:

jdownloader2_role_docker_recreate

# Type: bool (true/false)
jdownloader2_role_docker_recreate:

jdownloader2_role_docker_restart_retries

# Type: int
jdownloader2_role_docker_restart_retries:

jdownloader2_role_docker_stop_timeout

# Type: int
jdownloader2_role_docker_stop_timeout:

Other Options

jdownloader2_role_docker_capabilities

# Type: list
jdownloader2_role_docker_capabilities:

jdownloader2_role_docker_cgroup_parent

# Type: string
jdownloader2_role_docker_cgroup_parent:

jdownloader2_role_docker_commands

# Type: list
jdownloader2_role_docker_commands:

jdownloader2_role_docker_create_timeout

# Type: int
jdownloader2_role_docker_create_timeout:

jdownloader2_role_docker_entrypoint

# Type: string
jdownloader2_role_docker_entrypoint:

jdownloader2_role_docker_env_file

# Type: string
jdownloader2_role_docker_env_file:

jdownloader2_role_docker_labels

# Type: dict
jdownloader2_role_docker_labels:

jdownloader2_role_docker_labels_use_common

# Type: bool (true/false)
jdownloader2_role_docker_labels_use_common:

jdownloader2_role_docker_read_only

# Type: bool (true/false)
jdownloader2_role_docker_read_only:

jdownloader2_role_docker_runtime

# Type: string
jdownloader2_role_docker_runtime:

jdownloader2_role_docker_sysctls

# Type: list
jdownloader2_role_docker_sysctls:

jdownloader2_role_docker_ulimits

# Type: list
jdownloader2_role_docker_ulimits:

jdownloader2_role_autoheal_enabled

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

jdownloader2_role_depends_on

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

jdownloader2_role_depends_on_delay

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

jdownloader2_role_depends_on_healthchecks

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

jdownloader2_role_diun_enabled

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

jdownloader2_role_dns_enabled

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

jdownloader2_role_docker_controller

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

jdownloader2_role_docker_image_repo

# Type: string
jdownloader2_role_docker_image_repo:

jdownloader2_role_docker_image_tag

# Type: string
jdownloader2_role_docker_image_tag:

jdownloader2_role_docker_volumes_download

# Type: bool (true/false)
jdownloader2_role_docker_volumes_download:

jdownloader2_role_paths_downloads_location

# Type: string
jdownloader2_role_paths_downloads_location:

jdownloader2_role_paths_location

# Type: string
jdownloader2_role_paths_location:

jdownloader2_role_themepark_addons

# Type: string
jdownloader2_role_themepark_addons:

jdownloader2_role_themepark_app

# Type: string
jdownloader2_role_themepark_app:

jdownloader2_role_themepark_theme

# Type: string
jdownloader2_role_themepark_theme:

jdownloader2_role_traefik_api_endpoint

# Type: dict/omit
jdownloader2_role_traefik_api_endpoint:

jdownloader2_role_traefik_api_middleware

# Type: string
jdownloader2_role_traefik_api_middleware:

jdownloader2_role_traefik_api_middleware_http

# Type: string
jdownloader2_role_traefik_api_middleware_http:

jdownloader2_role_traefik_autodetect_enabled

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

jdownloader2_role_traefik_certresolver

# Type: string
jdownloader2_role_traefik_certresolver:

jdownloader2_role_traefik_crowdsec_enabled

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

jdownloader2_role_traefik_error_pages_enabled

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

jdownloader2_role_traefik_gzip_enabled

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

jdownloader2_role_traefik_middleware_http

# Type: string
jdownloader2_role_traefik_middleware_http:

jdownloader2_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
jdownloader2_role_traefik_middleware_http_api_insecure:

jdownloader2_role_traefik_middleware_http_insecure

# Type: bool (true/false)
jdownloader2_role_traefik_middleware_http_insecure:

jdownloader2_role_traefik_priority

# Type: string
jdownloader2_role_traefik_priority:

jdownloader2_role_traefik_robot_enabled

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

jdownloader2_role_traefik_tailscale_enabled

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

jdownloader2_role_traefik_wildcard_enabled

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

jdownloader2_role_web_domain

# Type: string
jdownloader2_role_web_domain:

jdownloader2_role_web_fqdn_override

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

Example Override

jdownloader2_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "jdownloader22.{{ user.domain }}"
  - "jdownloader2.otherdomain.tld"

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

jdownloader2_role_web_host_override

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

Example Override

jdownloader2_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'jdownloader22.' + user.domain }}`)"

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

jdownloader2_role_web_http_port

# Type: string (quoted number)
jdownloader2_role_web_http_port:

jdownloader2_role_web_http_scheme

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

jdownloader2_role_web_http_serverstransport

# Type: dict/omit
jdownloader2_role_web_http_serverstransport:

jdownloader2_role_web_scheme

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

jdownloader2_role_web_serverstransport

# Type: dict/omit
jdownloader2_role_web_serverstransport:

jdownloader2_role_web_subdomain

# Type: string
jdownloader2_role_web_subdomain: