{"id":19476865,"url":"https://github.com/jlesage/docker-jdownloader-2","last_synced_at":"2026-02-23T04:01:41.731Z","repository":{"id":41548715,"uuid":"96315574","full_name":"jlesage/docker-jdownloader-2","owner":"jlesage","description":"Docker container for JDownloader 2","archived":false,"fork":false,"pushed_at":"2026-02-19T05:10:51.000Z","size":2988,"stargazers_count":1365,"open_issues_count":48,"forks_count":98,"subscribers_count":16,"default_branch":"master","last_synced_at":"2026-02-19T07:54:13.209Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jlesage.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"jlesage","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://paypal.me/JocelynLeSage","https://www.tesla.com/referral/jocelyn4590"]}},"created_at":"2017-07-05T12:13:42.000Z","updated_at":"2026-02-19T07:42:45.000Z","dependencies_parsed_at":"2023-02-07T21:01:54.559Z","dependency_job_id":"af817b0b-aa0b-419b-829f-8f154be2515d","html_url":"https://github.com/jlesage/docker-jdownloader-2","commit_stats":{"total_commits":256,"total_committers":2,"mean_commits":128.0,"dds":0.00390625,"last_synced_commit":"7ce598f40d7c419c90c3827be6b0878e549f3270"},"previous_names":[],"tags_count":62,"template":false,"template_full_name":null,"purl":"pkg:github/jlesage/docker-jdownloader-2","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlesage%2Fdocker-jdownloader-2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlesage%2Fdocker-jdownloader-2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlesage%2Fdocker-jdownloader-2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlesage%2Fdocker-jdownloader-2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jlesage","download_url":"https://codeload.github.com/jlesage/docker-jdownloader-2/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlesage%2Fdocker-jdownloader-2/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29736978,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-23T02:24:00.660Z","status":"ssl_error","status_checked_at":"2026-02-23T02:22:56.087Z","response_time":90,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T19:42:21.272Z","updated_at":"2026-02-23T04:01:41.721Z","avatar_url":"https://github.com/jlesage.png","language":"Shell","funding_links":["https://github.com/sponsors/jlesage","https://paypal.me/JocelynLeSage","https://www.tesla.com/referral/jocelyn4590"],"categories":["Shell","Application Recommendation"],"sub_categories":["🤖 Automation Tools"],"readme":"# Docker container for JDownloader 2\n[![Release](https://img.shields.io/github/release/jlesage/docker-jdownloader-2.svg?logo=github\u0026style=for-the-badge)](https://github.com/jlesage/docker-jdownloader-2/releases/latest)\n[![Docker Image Size](https://img.shields.io/docker/image-size/jlesage/jdownloader-2/latest?logo=docker\u0026style=for-the-badge)](https://hub.docker.com/r/jlesage/jdownloader-2/tags)\n[![Docker Pulls](https://img.shields.io/docker/pulls/jlesage/jdownloader-2?label=Pulls\u0026logo=docker\u0026style=for-the-badge)](https://hub.docker.com/r/jlesage/jdownloader-2)\n[![Docker Stars](https://img.shields.io/docker/stars/jlesage/jdownloader-2?label=Stars\u0026logo=docker\u0026style=for-the-badge)](https://hub.docker.com/r/jlesage/jdownloader-2)\n[![Build Status](https://img.shields.io/github/actions/workflow/status/jlesage/docker-jdownloader-2/build-image.yml?logo=github\u0026branch=master\u0026style=for-the-badge)](https://github.com/jlesage/docker-jdownloader-2/actions/workflows/build-image.yml)\n[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg?style=for-the-badge)](https://paypal.me/JocelynLeSage)\n\nThis project provides a Docker container for [JDownloader 2](https://jdownloader.org).\n\nThe graphical user interface (GUI) of the application can be accessed through a\nmodern web browser, requiring no installation or configuration on the client\nside, or via any VNC client.\n\n\u003e [!NOTE]\n\u003e This Docker container is entirely unofficial and not made by the creators of\n\u003e JDownloader 2.\n\n---\n\n[![JDownloader 2 logo](https://images.weserv.nl/?url=raw.githubusercontent.com/jlesage/docker-templates/master/jlesage/images/jdownloader-2-icon.png\u0026w=110)](https://jdownloader.org)[![JDownloader 2](https://images.placeholders.dev/?width=416\u0026height=110\u0026fontFamily=monospace\u0026fontWeight=400\u0026fontSize=52\u0026text=JDownloader%202\u0026bgColor=rgba(0,0,0,0.0)\u0026textColor=rgba(121,121,121,1))](https://jdownloader.org)\n\nJDownloader 2 is a free, open-source download management tool with a huge\ncommunity of developers that makes downloading as easy and fast as it should be.\nUsers can start, stop or pause downloads, set bandwith limitations, auto-extract\narchives and much more. It's an easy-to-extend framework that can save hours of\nyour valuable time every day!\n\n---\n\n## Table of Contents\n\n   * [Quick Start](#quick-start)\n   * [Usage](#usage)\n      * [Environment Variables](#environment-variables)\n         * [Deployment Considerations](#deployment-considerations)\n      * [Data Volumes](#data-volumes)\n      * [Ports](#ports)\n      * [Changing Parameters of a Running Container](#changing-parameters-of-a-running-container)\n      * [Docker Compose File](#docker-compose-file)\n   * [Docker Image Versioning and Tags](#docker-image-versioning-and-tags)\n   * [Docker Image Update](#docker-image-update)\n      * [Synology](#synology)\n      * [unRAID](#unraid)\n   * [User/Group IDs](#usergroup-ids)\n   * [Accessing the GUI](#accessing-the-gui)\n   * [Security](#security)\n      * [SSVNC](#ssvnc)\n      * [Certificates](#certificates)\n      * [VNC Password](#vnc-password)\n      * [Web Authentication](#web-authentication)\n         * [Configuring Users Credentials](#configuring-users-credentials)\n   * [Reverse Proxy](#reverse-proxy)\n      * [Routing Based on Hostname](#routing-based-on-hostname)\n      * [Routing Based on URL Path](#routing-based-on-url-path)\n   * [Web Control Panel](#web-control-panel)\n   * [Automatic Clipboard Sync](#automatic-clipboard-sync)\n   * [Web Audio](#web-audio)\n   * [Web File Manager](#web-file-manager)\n   * [Web Notifications](#web-notifications)\n      * [Web Terminal](#web-terminal)\n   * [GPU Acceleration Support](#gpu-acceleration-support)\n   * [Shell Access](#shell-access)\n   * [MyJDownloader](#myjdownloader)\n      * [Direct Connection](#direct-connection)\n   * [Click'n'Load](#clicknload)\n   * [Troubleshooting](#troubleshooting)\n      * [JDownloader Fails to Start](#jdownloader-fails-to-start)\n   * [Support or Contact](#support-or-contact)\n\n## Quick Start\n\n\u003e [!IMPORTANT]\n\u003e The Docker command provided in this quick start is an example, and parameters\n\u003e should be adjusted to suit your needs.\n\nLaunch the JDownloader 2 docker container with the following command:\n\n```shell\ndocker run -d \\\n    --name=jdownloader-2 \\\n    -p 5800:5800 \\\n    -v /docker/appdata/jdownloader-2:/config:rw \\\n    -v /home/user/Downloads:/output:rw \\\n    jlesage/jdownloader-2\n```\n\nWhere:\n\n  - `/docker/appdata/jdownloader-2`: Stores the application's configuration, state, logs, and any files requiring persistency.\n  - `/home/user/Downloads`: This is where downloaded files are stored.\n\nAccess the JDownloader 2 GUI by browsing to `http://your-host-ip:5800`.\n\n## Usage\n\n```shell\ndocker run [-d] \\\n    --name=jdownloader-2 \\\n    [-e \u003cVARIABLE_NAME\u003e=\u003cVALUE\u003e]... \\\n    [-v \u003cHOST_DIR\u003e:\u003cCONTAINER_DIR\u003e[:PERMISSIONS]]... \\\n    [-p \u003cHOST_PORT\u003e:\u003cCONTAINER_PORT\u003e]... \\\n    jlesage/jdownloader-2\n```\n\n| Parameter | Description |\n|-----------|-------------|\n| -d        | Runs the container in the background. If not set, the container runs in the foreground. |\n| -e        | Passes an environment variable to the container. See [Environment Variables](#environment-variables) for details. |\n| -v        | Sets a volume mapping to share a folder or file between the host and the container. See [Data Volumes](#data-volumes) for details. |\n| -p        | Sets a network port mapping to expose an internal container port to the host). See [Ports](#ports) for details. |\n\n### Environment Variables\n\nTo customize the container's behavior, you can pass environment variables using\nthe `-e` parameter in the format `\u003cVARIABLE_NAME\u003e=\u003cVALUE\u003e`.\n\n| Variable       | Description                                  | Default |\n|----------------|----------------------------------------------|---------|\n|`USER_ID`| ID of the user the application runs as. See [User/Group IDs](#usergroup-ids) for details. | `1000` |\n|`GROUP_ID`| ID of the group the application runs as. See [User/Group IDs](#usergroup-ids) for details. | `1000` |\n|`SUP_GROUP_IDS`| Comma-separated list of supplementary group IDs for the application. | (no value) |\n|`UMASK`| Mask controlling permissions for newly created files and folders, specified in octal notation. By default, `0022` ensures files and folders are readable by all but writable only by the owner. See the umask calculator at http://wintelguy.com/umask-calc.pl. | `0022` |\n|`LANG`| Sets the [locale](https://en.wikipedia.org/wiki/Locale_(computer_software)), defining the application's language, if supported. Format is `language[_territory][.codeset]`, where language is an [ISO 639 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes), territory is an [ISO 3166 country code](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes), and codeset is a character set, like `UTF-8`. For example, Australian English using UTF-8 is `en_AU.UTF-8`. | `en_US.UTF-8` |\n|`TZ`| [TimeZone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones) used by the container. The timezone can also be set by mapping `/etc/localtime` between the host and the container. | `Etc/UTC` |\n|`KEEP_APP_RUNNING`| When set to `1`, the application is automatically restarted if it crashes or terminates. | `0` |\n|`APP_NICENESS`| Priority at which the application runs. A niceness value of `-20` is the highest, `19` is the lowest and `0` the default. **NOTE**: A negative niceness (priority increase) requires additional permissions. The container must be run with the Docker option `--cap-add=SYS_NICE`. | `0` |\n|`INSTALL_PACKAGES`| Space-separated list of packages to install during container startup. List of available packages can be found at https://pkgs.alpinelinux.org. | (no value) |\n|`PACKAGES_MIRROR`| Mirror of the repository to use when installing packages. List of mirrors is available at https://mirrors.alpinelinux.org. | (no value) |\n|`CONTAINER_DEBUG`| When set to `1`, enables debug logging. | `0` |\n|`DISPLAY_WIDTH`| Width (in pixels) of the application's window. | `1920` |\n|`DISPLAY_HEIGHT`| Height (in pixels) of the application's window. | `1080` |\n|`DARK_MODE`| When set to `1`, enables dark mode for the application. See Dark Mode](#dark-mode) for details. | `0` |\n|`WEB_AUDIO`| When set to `1`, enables audio support, allowing audio produced by the application to play through the browser. See [Web Audio](#web-audio) for details. | `0` |\n|`WEB_FILE_MANAGER`| When set to `1`, enables the web file manager, allowing interaction with files inside the container through the web browser, supporting operations like renaming, deleting, uploading, and downloading. See [Web File Manager](#web-file-manager) for details. | `0` |\n|`WEB_FILE_MANAGER_ALLOWED_PATHS`| Comma-separated list of paths within the container that the file manager can access. By default, the container's entire filesystem is not accessible, and this variable specifies allowed paths. If set to `AUTO`, commonly used folders and those mapped to the container are automatically allowed. The value `ALL` allows access to all paths (no restrictions). See [Web File Manager](#web-file-manager) for details. | `AUTO` |\n|`WEB_FILE_MANAGER_DENIED_PATHS`| Comma-separated list of paths within the container that the file manager cannot access. A denied path takes precedence over an allowed path. See [Web File Manager](#web-file-manager) for details. | (no value) |\n|`WEB_NOTIFICATION`| When set to `1`, enables the web notification service, allowing the browser to display desktop notifications from the application. Requires the container to be configured with secure web access (HTTPS). See [Web Notifications](#web-notifications) for details. | `0` |\n|`WEB_TERMINAL`| When set to `1`, enables access to a terminal from the web interface. It is strongly recommended to configure the container with secure web access (HTTPS). See [Web Terminal](#web-terminal) for details. | `0` |\n|`WEB_AUTHENTICATION`| When set to `1`, protects the application's GUI with a login page when accessed via a web browser. Access is granted only with valid credentials. Requires the container to be configured with secure web access (HTTPS). See [Web Authentication](#web-authentication) for details. | `0` |\n|`WEB_AUTHENTICATION_TOKEN_VALIDITY_TIME`| Lifetime of a token, in hours. A token is assigned to the user after successful login. As long as the token is valid, the user can access the application's GUI without logging in again. Once the token expires, the login page is displayed again. | `24` |\n|`WEB_AUTHENTICATION_USERNAME`| Optional username for web authentication. Provides a quick and easy way to configure credentials for a single user. For more secure configuration or multiple users, see the [Web Authentication](#web-authentication) section. | (no value) |\n|`WEB_AUTHENTICATION_PASSWORD`| Optional password for web authentication. Provides a quick and easy way to configure credentials for a single user. For more secure configuration or multiple users, see the [Web Authentication](#web-authentication) section. | (no value) |\n|`SECURE_CONNECTION`| When set to `1`, uses an encrypted connection to access the application's GUI (via web browser or VNC client). See [Security](#security) for details. | `0` |\n|`SECURE_CONNECTION_VNC_METHOD`| Method used for encrypted VNC connections. Possible values are `SSL` or `TLS`. See [Security](#security) for details. | `SSL` |\n|`SECURE_CONNECTION_CERTS_CHECK_INTERVAL`| Interval, in seconds, at which the system checks if web or VNC certificates have changed. When a change is detected, affected services are automatically restarted. A value of `0` disables the check. | `60` |\n|`WEB_LOCALHOST_ONLY`| When set to `1`, allows web connections only from localhost (127.0.0.1 and ::1). | `0` |\n|`VNC_LOCALHOST_ONLY`| When set to `1`, allows VNC connections only from localhost (127.0.0.1 and ::1). | `0` |\n|`WEB_LISTENING_PORT`| Port used by the web server to serve the application's GUI. This port is internal to the container and typically does not need to be changed. By default, a container uses the default bridge network, requiring each internal port to be mapped to an external port (using the `-p` or `--publish` argument). If another network type is used, changing this port may prevent conflicts with other services/containers. **NOTE**: A value of `-1` disables HTTP/HTTPS access to the application's GUI. | `5800` |\n|`VNC_LISTENING_PORT`| Port used by the VNC server to serve the application's GUI. This port is internal to the container and typically does not need to be changed. By default, a container uses the default bridge network, requiring each internal port to be mapped to an external port (using the `-p` or `--publish` argument). If another network type is used, changing this port may prevent conflicts with other services/containers. **NOTE**: A value of `-1` disables VNC access to the application's GUI. | `5900` |\n|`VNC_PASSWORD`| Password required to connect to the application's GUI. See the [VNC Password](#vnc-password) section for details. | (no value) |\n|`ENABLE_CJK_FONT`| When set to `1`, installs the open-source font `WenQuanYi Zen Hei`, supporting a wide range of Chinese/Japanese/Korean characters. | `0` |\n|`MYJDOWNLOADER_EMAIL`| Email address of the MyJDownloader account to use. Note that this can also be configured via the JDownloader GUI. | (no value) |\n|`MYJDOWNLOADER_PASSWORD`| Password of the MyJDownloader account to use. Note that this can also be configured via the JDownloader GUI. | (no value) |\n|`MYJDOWNLOADER_DEVICE_NAME`| The name of this JDownloader instance. Note that this can also be configured via the JDownloader GUI. | (no value) |\n|`JDOWNLOADER_HEADLESS`| When set to `1`, JDownloader is running in headless mode, meaning that no GUI is available. In this mode, MyJDownloader should be used to remote control JDownloader. | `0` |\n|`JDOWNLOADER_MAX_MEM`| Maximum amount of memory JDownloader is allowed to use. One of the following memory unit (case insensitive) should be added as a suffix to the size: `G`, `M` or `K`. When this variable is not set, the limit is automatically calculated based on the amount of RAM of the system. | (no value) |\n\n#### Deployment Considerations\n\nMany tools used to manage Docker containers extract environment variables\ndefined by the Docker image to create or deploy the container.\n\nFor example, this behavior is seen in:\n  - The Docker application on Synology NAS\n  - The Container Station on QNAP NAS\n  - Portainer\n  - etc.\n\nWhile this is useful for users to adjust environment variable values to suit\ntheir needs, keeping all of them can be confusing and even risky.\n\nA good practice is to set or retain only the variables necessary for the\ncontainer to function as desired in your setup. If a variable is left at its\ndefault value, it can be removed. Keep in mind that all environment variables\nare optional; none are required for the container to start.\n\nRemoving unneeded environment variables offers several benefits:\n\n  - Prevents retaining variables no longer used by the container. Over time,\n    with image updates, some variables may become obsolete.\n  - Allows the Docker image to update or fix default values. With image updates,\n    default values may change to address issues or support new features.\n  - Avoids changes to variables that could disrupt the container's\n    functionality. Some undocumented variables, like `PATH` or `ENV`, are\n    required but not meant to be modified by users, yet container management\n    tools may expose them.\n  - Addresses a bug in Container Station on QNAP and the Docker application on\n    Synology, where variables without values may not be allowed. This behavior\n    is incorrect, as variables without values are valid. Removing unneeded\n    variables prevents deployment issues on these devices.\n\n### Data Volumes\n\nThe following table describes the data volumes used by the container. Volume\nmappings are set using the `-v` parameter with a value in the format\n`\u003cHOST_DIR\u003e:\u003cCONTAINER_DIR\u003e[:PERMISSIONS]`.\n\n| Container path  | Permissions | Description |\n|-----------------|-------------|-------------|\n|`/config`| rw | Stores the application's configuration, state, logs, and any files requiring persistency. |\n|`/output`| rw | This is where downloaded files are stored. |\n\n### Ports\n\nThe following table lists the ports used by the container.\n\nWhen using the default bridge network, ports can be mapped to the host using the\n`-p` parameter with value in the format `\u003cHOST_PORT\u003e:\u003cCONTAINER_PORT\u003e`. The\ninternal container port may not be changeable, but you can use any port on the\nhost side.\n\nSee the Docker [Docker Container Networking](https://docs.docker.com/config/containers/container-networking)\ndocumentation for details.\n\n| Port | Protocol | Mapping to Host | Description |\n|------|----------|-----------------|-------------|\n| 5800 | TCP | Optional | Port to access the application's GUI via the web interface. Mapping to the host is optional if web access is not needed. For non-default bridge networks, the port can be changed with the `WEB_LISTENING_PORT` environment variable. |\n| 5900 | TCP | Optional | Port to access the application's GUI via the VNC protocol. Mapping to the host is optional if VNC access is not needed. For non-default bridge networks, the port can be changed with the `VNC_LISTENING_PORT` environment variable. |\n| 3129 | TCP | Optional | Port used by *MyJDownloader* mobile applications and browser extensions to establish a direct connect to the JDownloader Docker container instance. Port needs to be exposed only if *MyJDownloader* is enabled and configured in *Direct Connection* mode. **NOTE**: Since this port is being reported to the *MyJDownloader* online service, the port mapped on the host side **must** be the same (i.e. 3129). |\n\n### Changing Parameters of a Running Container\n\nEnvironment variables, volume mappings, and port mappings are specified when\ncreating the container. To modify these parameters for an existing container,\nfollow these steps:\n\n  1. Stop the container (if it is running):\n```shell\ndocker stop jdownloader-2\n```\n\n  2. Remove the container:\n```shell\ndocker rm jdownloader-2\n```\n\n  3. Recreate and start the container using the `docker run` command, adjusting\n     parameters as needed.\n\n\u003e [!NOTE]\n\u003e Since all application data is saved under the `/config` container folder,\n\u003e destroying and recreating the container does not result in data loss, and the\n\u003e application resumes with the same state, provided the `/config` folder\n\u003e mapping remains unchanged.\n\n### Docker Compose File\n\nBelow is an example `docker-compose.yml` file for use with\n[Docker Compose](https://docs.docker.com/compose/overview/).\n\nAdjust the configuration to suit your needs. Only mandatory settings are\nincluded in this example.\n\n```yaml\nversion: '3'\nservices:\n  jdownloader-2:\n    image: jlesage/jdownloader-2\n    ports:\n      - \"5800:5800\"\n    volumes:\n      - \"/docker/appdata/jdownloader-2:/config:rw\"\n      - \"/home/user/Downloads:/output:rw\"\n```\n\n## Docker Image Versioning and Tags\n\nEach release of a Docker image is versioned, and each version as its own image\ntag. Before October 2022, the versioning scheme followed\n[semantic versioning](https://semver.org).\n\nSince then, the versioning scheme has shifted to\n[calendar versioning](https://calver.org) with the format `YY.MM.SEQUENCE`,\nwhere:\n  - `YY` is the zero-padded year (relative to year 2000).\n  - `MM` is the zero-padded month.\n  - `SEQUENCE` is the incremental release number within the month (first release\n    is 1, second is 2, etc).\n\nView all available tags on [Docker Hub] or check the [Releases] page for version\ndetails.\n\n[Releases]: https://github.com/jlesage/docker-jdownloader-2/releases\n[Docker Hub]: https://hub.docker.com/r/jlesage/jdownloader-2/tags\n\n## Docker Image Update\n\nThe Docker image is regularly updated to incorporate new features, fix issues,\nor integrate newer versions of the containerized application. Several methods\ncan be used to update the Docker image.\n\nIf your system provides a built-in method for updating containers, this should\nbe your primary approach.\n\nAlternatively, you can use [Watchtower], a container-based solution for\nautomating Docker image updates. Watchtower seamlessly handles updates when a\nnew image is available.\n\nTo manually update the Docker image, follow these steps:\n\n  1. Fetch the latest image:\n```shell\ndocker pull jlesage/jdownloader-2\n```\n\n  2. Stop the container:\n```shell\ndocker stop jdownloader-2\n```\n\n  3. Remove the container:\n```shell\ndocker rm jdownloader-2\n```\n\n  4. Recreate and start the container using the `docker run` command, with the\n     same parameters used during initial deployment.\n\n[Watchtower]: https://github.com/containrrr/watchtower\n\n### Synology\n\nFor Synology NAS users, follow these steps to update a container image:\n\n  1.  Open the *Docker* application.\n  2.  Click *Registry* in the left pane.\n  3.  In the search bar, type the name of the container (`jlesage/jdownloader-2`).\n  4.  Select the image, click *Download*, and choose the `latest` tag.\n  5.  Wait for the download to complete. A notification will appear once done.\n  6.  Click *Container* in the left pane.\n  7.  Select your JDownloader 2 container.\n  8.  Stop it by clicking *Action* -\u003e *Stop*.\n  9.  Clear the container by clicking *Action* -\u003e *Reset* (or *Action* -\u003e\n      *Clear* if you don't have the latest *Docker* application). This removes\n      the container while keeping its configuration.\n  10. Start the container again by clicking *Action* -\u003e *Start*. **NOTE**:  The\n      container may temporarily disappear from the list while it is recreated.\n\n### unRAID\n\nFor unRAID users, update a container image with these steps:\n\n  1. Select the *Docker* tab.\n  2. Click the *Check for Updates* button at the bottom of the page.\n  3. Click the *apply update* link of the container to be updated.\n\n## User/Group IDs\n\nWhen mapping data volumes (using the `-v` flag of the `docker run` command),\npermission issues may arise between the host and the container. Files and\nfolders in a data volume are owned by a user, which may differ from the user\nrunning the application. Depending on permissions, this could prevent the\ncontainer from accessing the shared volume.\n\nTo avoid this, specify the user the application should run as using the\n`USER_ID` and `GROUP_ID` environment variables.\n\nTo find the appropriate IDs, run the following command on the host for the user\nowning the data volume:\n\n```shell\nid \u003cusername\u003e\n```\n\nThis produces output like:\n\n```\nuid=1000(myuser) gid=1000(myuser) groups=1000(myuser),4(adm),24(cdrom),27(sudo),46(plugdev),113(lpadmin)\n```\n\nUse the `uid` (user ID) and `gid` (group ID) values to configure the container.\n\n## Accessing the GUI\n\nAssuming the container's ports are mapped to the same host's ports, access the\napplication's GUI as follows:\n\n  - Via a web browser:\n\n```text\nhttp://\u003cHOST_IP_ADDR\u003e:5800\n```\n\n  - Via any VNC client:\n\n```text\n\u003cHOST_IP_ADDR\u003e:5900\n```\n\n## Security\n\nBy default, access to the application's GUI uses an unencrypted connection (HTTP\nor VNC).\n\nA secure connection can be enabled via the `SECURE_CONNECTION` environment\nvariable. See the [Environment Variables](#environment-variables) section for\ndetails on configuring environment variables.\n\nWhen enabled, the GUI is accessed over HTTPS when using a browser, with all HTTP\naccesses redirected to HTTPS.\n\nFor VNC clients, the connection can be secured using on of two methods,\nconfigured via the `SECURE_CONNECTION_VNC_METHOD` environment variable:\n\n  - `SSL`: An SSL tunnel is used to transport the VNC connection. Few VNC\n    clients supports this method; [SSVNC] is one that does.\n  - `TLS`: A VNC security type negotiated during the VNC handshake. It uses TLS\n    to establish a secure connection. Clients may optionally validate the\n    server’s certificate. Valid certificates must be provided for this\n    validation to succeed. See [Certificates](#certificates) for details.\n    [TigerVNC] is a client that supports TLS encryption.\n\n[TigerVNC]: https://tigervnc.org\n\n### SSVNC\n\n[SSVNC] is a VNC viewer that adds encryption to VNC connections by using an\nSSL tunnel to transport the VNC traffic.\n\nWhile the Linux version of [SSVNC] works well, the Windows version has issues.\nAt the time of writing, the latest version `1.0.30` fails with the error:\n\n```text\nReadExact: Socket error while reading\n```\n\nFor convenience, an unofficial, working version is provided here:\n\nhttps://github.com/jlesage/docker-baseimage-gui/raw/master/tools/ssvnc_windows_only-1.0.30-r1.zip\n\nThis version upgrades the bundled `stunnel` to version `5.49`, resolving the\nconnection issues.\n\n[SSVNC]: http://www.karlrunge.com/x11vnc/ssvnc.html\n\n### Certificates\n\nThe following certificate files are required by the container. If missing,\nself-signed certificates are generated and used. All files are PEM-encoded x509\ncertificates.\n\n| Container Path                  | Purpose                    | Content |\n|---------------------------------|----------------------------|---------|\n|`/config/certs/vnc-server.pem`   |VNC connection encryption.  |VNC server's private key and certificate, bundled with any root and intermediate certificates.|\n|`/config/certs/web-privkey.pem`  |HTTPS connection encryption.|Web server's private key.|\n|`/config/certs/web-fullchain.pem`|HTTPS connection encryption.|Web server's certificate, bundled with any root and intermediate certificates.|\n\n\u003e [!TIP]\n\u003e To avoid certificate validity warnings or errors in browsers or VNC clients,\n\u003e provide your own valid certificates.\n\n\u003e [!NOTE]\n\u003e Certificate files are monitored, and relevant services are restarted when\n\u003e changes are detected.\n\n### VNC Password\n\nTo restrict access to your application, set a password using one of two methods:\n  - Via the `VNC_PASSWORD` environment variable.\n  - Via a `.vncpass_clear` file at the root of the `/config` volume, containing\n    the password in clear text. During container startup, the content is\n    obfuscated and moved to `.vncpass`.\n\nThe security of the VNC password depends on:\n  - The communication channel (encrypted or unencrypted).\n  - The security of host access.\n\nWhen using a VNC password, configure the container with secure web access\n(HTTPS) to prevent sending the password in clear text over an unencrypted\nchannel.\n\nUnauthorized users with sufficient host privileges can retrieve the password by:\n\n  - Viewing the `VNC_PASSWORD` environment variable via `docker inspect`. By\n    default, the `docker` command requires root access, but it can be configured\n    to allow users in a specific group.\n  - Decrypting the `/config/.vncpass` file, which requires root or `USER_ID`\n    permissions.\n\n\u003e [!CAUTION]\n\u003e VNC password is limited to 8 characters. This limitation comes from the Remote\n\u003e Framebuffer Protocol [RFC](https://tools.ietf.org/html/rfc6143) (see section\n\u003e [7.2.2](https://tools.ietf.org/html/rfc6143#section-7.2.2)).\n\n### Web Authentication\n\nAccess to the application's GUI via a web browser can be protected with a login\npage. When enabled, users must provide valid credentials to gain access.\n\nEnable web authentication by setting the `WEB_AUTHENTICATION` environment\nvariable to `1`. See the [Environment Variables](#environment-variables) section\nfor details on configuring environment variables.\n\n\u003e [!IMPORTANT]\n\u003e Web authentication requires the container to be configured with secure web\n\u003e access (HTTPS). See [Security](#security) for details.\n\n\u003e [!NOTE]\n\u003e This feature is not available to VNC clients.\n\n#### Configuring Users Credentials\n\nUser credentials can be configured in two ways:\n\n  1. Via container environment variables.\n  2. Via a password database.\n\nContainer environment variables provide a quick way to configure a single user.\nSet the username and password using:\n  - `WEB_AUTHENTICATION_USERNAME`\n  - `WEB_AUTHENTICATION_PASSWORD`\n\nSee the [Environment Variables](#environment-variables) section for details on\nconfiguring environment variables.\n\nFor a more secure method or to configure multiple users, use a password database\nat `/config/webauth-htpasswd` within the container. This file uses the Apache\nHTTP server's htpasswd format, storing bcrypt-hashed passwords.\n\nManage users with the `webauth-user` tool:\n  - Add a user: `docker exec -ti \u003ccontainer name\u003e webauth-user add \u003cusername\u003e`\n  - Update a user: `docker exec -ti \u003ccontainer name\u003e webauth-user update \u003cusername\u003e`\n  - Remove a user: `docker exec \u003ccontainer name\u003e webauth-user del \u003cusername\u003e`\n  - List users: `docker exec \u003ccontainer name\u003e webauth-user list`\n\n## Reverse Proxy\n\nThe following sections provide NGINX configurations for setting up a reverse\nproxy to this container.\n\nA reverse proxy server can route HTTP requests based on the hostname or URL\npath.\n\n### Routing Based on Hostname\n\nIn this scenario, each hostname is routed to a different application or\ncontainer.\n\nFor example, if the reverse proxy server runs on the same machine as this\ncontainer, it would proxy all HTTP requests for `jdownloader-2.domain.tld` to\nthe container at `127.0.0.1:5800`.\n\nHere are the relevant configuration elements to add to the NGINX configuration:\n\n```nginx\nmap $http_upgrade $connection_upgrade {\n\tdefault upgrade;\n\t''      close;\n}\n\nupstream docker-jdownloader-2 {\n\t# If the reverse proxy server is not running on the same machine as the\n\t# Docker container, use the IP of the Docker host here.\n\t# Make sure to adjust the port according to how port 5800 of the\n\t# container has been mapped on the host.\n\tserver 127.0.0.1:5800;\n}\n\nserver {\n\t[...]\n\n\tserver_name jdownloader-2.domain.tld;\n\n\tlocation / {\n\t\tproxy_pass http://docker-jdownloader-2;\n\t\tproxy_http_version 1.1;\n\t\tproxy_set_header Upgrade $http_upgrade;\n\t\tproxy_set_header Connection $connection_upgrade;\n\t\tproxy_buffering off;\n\t\tproxy_read_timeout 86400s;\n\t\tproxy_send_timeout 86400s;\n\t}\n}\n```\n\n### Routing Based on URL Path\n\nIn this scenario, the same hostname is used, but different URL paths route to\ndifferent applications or containers. For example, if the reverse proxy server\nruns on the same machine as this container, it would proxy all HTTP requests for\n`server.domain.tld/filebot` to the container at `127.0.0.1:5800`.\n\nHere are the relevant configuration elements to add to the NGINX configuration:\n\n```nginx\nmap $http_upgrade $connection_upgrade {\n\tdefault upgrade;\n\t''      close;\n}\n\nupstream docker-jdownloader-2 {\n\t# If the reverse proxy server is not running on the same machine as the\n\t# Docker container, use the IP of the Docker host here.\n\t# Make sure to adjust the port according to how port 5800 of the\n\t# container has been mapped on the host.\n\tserver 127.0.0.1:5800;\n}\n\nserver {\n\t[...]\n\n\tlocation = /jdownloader-2 {return 301 $scheme://$http_host/jdownloader-2/;}\n\tlocation /jdownloader-2/ {\n\t\tproxy_pass http://docker-jdownloader-2/;\n\t\tproxy_http_version 1.1;\n\t\tproxy_set_header Upgrade $http_upgrade;\n\t\tproxy_set_header Connection $connection_upgrade;\n\t\tproxy_buffering off;\n\t\tproxy_read_timeout 86400s;\n\t\tproxy_send_timeout 86400s;\n\t\t# Uncomment the following line if your Nginx server runs on a port that\n\t\t# differs from the one seen by external clients.\n\t\t#port_in_redirect off;\n\t}\n}\n```\n\n## Web Control Panel\n\nThe control panel is available whenever the application GUI is accessed through\na web browser. Click the small three-dots tab on the left edge of the browser\nwindow to open it.\n\n![Web Control Panel](https://images.weserv.nl/?url=raw.githubusercontent.com/jlesage/docker-templates/master/jlesage/images/control-panel.png\u0026w=500)\n\n| Control | Action / Purpose |\n|---------|------------------|\n| **X** icon | Closes the control panel. |\n| **Logout** icon | Logs out from the web interface. Visible only when [web authentication](#web-authentication) is enabled. |\n| **Keyboard** icon | Toggle the on-screen keyboard. Visible only on touch devices. |\n| **Fullscreen** icon | Toggle fullscreen mode for the browser window. |\n| **Hand** icon| Allows dragging/moving the application window. Visible only when **Scaling Mode** is *None* and **Clip to Window** is enabled.\n| **Folder** icon | Opens the intgegrated file browser. Visible only when the [file manager](#web-file-manager) is enabled. |\n| **Terminal** icon | Opens the integrated terminal. Visibile only when the [terminal](#web-terminal) is enabled. |\n| **Clipboard** text box| Mirrors the application’s clipboard. Any text typed or pasted here is sent to the application, and text copied inside the application automatically appears here. Hidden when [automatic clipboard synchronization](#automatic-clipboard-sync) is active. |\n| **Clear** button | Clears the clipboard. Hidden when [automatic clipboard synchronization](#automatic-clipboard-sync) is active. |\n| **Audio** icon | Mutes or unmutes audio streaming from the container. Visible only when [audio support](#web-audio) is enabled. |\n| **Volume** slider| Controls the playback volume of the audio streaming from the container. Visible only when [audio support](#web-audio) is enabled. |\n| **Clip to Window** toggle | Only applies when **Scaling Mode** is *None*. When disabled, scrollbars appear if the application window is larger than the browser window. When enabled, no scrollbars are shown and the hand icon is used to pan. |\n| **Scaling Mode** dropdown | Controls how the application window is scaled to fit the browser. **None** – no scaling, the application window keeps its original size. **Local Scaling** – the image is scaled in the browser (application window size unchanged). **Remote Scaling** – the application window inside the container is automatically resized to match the browser window size. |\n| **Quality** slider | Adjusts image quality. Moving the slider left reduces bandwidth at the cost of visual quality. |\n| **Compression** slider | Adjusts compression level applied to screen updates. Moving the slider right increases compression, which lowers bandwidth but raises CPU usage. |\n| **Logging** dropdown | Sets the verbosity level of the web interface logs shown in the browser console. |\n| **Application version** label | Displays the version of JDownloader 2 integrated into Docker image. |\n| **Docker image** version label | Displays the version of the Docker image currently running. |\n\n## Automatic Clipboard Sync\n\nWhen the container is accessed through a web browser, automatic clipboard\nsynchronization enables seamless sharing of clipboard contents between the host\nsystem and the application running inside the container. This makes it possible\nto copy and paste text or data directly between the two environments without\nmanual transfer steps.\n\nThis functionality is not available when using VNC clients and is supported only\nin browsers based on the Chromium engine, such as Google Chrome and Microsoft\nEdge.\n\nClipboard synchronization operates transparently once permission has been\ngranted by the browser. Depending on browser implementation, a prompt may appear\nthe first time clipboard access is requested.\n\n\u003e [!IMPORTANT]\n\u003e Web browsers only allow access to the clipboard in secure contexts (HTTPS).\n\u003e This means the container must be configured with secure web access. See\n\u003e [Security](#security) for details.\n\n\u003e [!TIP]\n\u003e If automatic clipboard synchronization is not available, text can still be\n\u003e copied and pasted using the clipboard of the\n\u003e [control panel](#web-control-panel), which provides manual clipboard access\n\u003e between the host and the container.\n\n\u003e [!NOTE]\n\u003e This feature is not available to VNC clients.\n\n## Web Audio\n\nThe container supports streaming audio from the application, played through the\nuser's web browser. Audio is not supported for VNC clients.\n\nAudio is streamed with the following specification:\n\n  * Raw PCM format\n  * 2 channels\n  * 16-bit sample depth\n  * 44.1kHz sample rate\n\nEnable web audio by setting `WEB_AUDIO` to `1`. See the\n[Environment Variables](#environment-variables) section for details on\nconfiguring environment variables.\n\nControl of the audio stream (mute, unmute and volume) is done via the\n[control panel](#web-control-panel).\n\n\u003e [!NOTE]\n\u003e This feature is not available to VNC clients.\n\n## Web File Manager\n\nThe container includes a simple file manager for interacting with container\nfiles through a web browser, supporting operations like renaming, deleting,\nuploading, and downloading.\n\nEnable the file manager by setting `WEB_FILE_MANAGER` to `1`. See the\n[Environment Variables](#environment-variables) section for details on\nconfiguring environment variables.\n\nOpen the file manager by clicking the folder icon of the\n[control panel](#web-control-panel)\n\nBy default, the container's entire filesystem is not accessible. The\n`WEB_FILE_MANAGER_ALLOWED_PATHS` environment variable is a comma-separated list\nthat specifies which paths within the container are allowed to be accessed. When\nset to `AUTO` (the default), it automatically includes commonly used folders and\nany folders mapped to the container.\n\nThe `WEB_FILE_MANAGER_DENIED_PATHS` environment variable defines which paths are\nexplicitly denied access by the file manager. A denied path takes precedence\nover an allowed one.\n\n\u003e [!NOTE]\n\u003e This feature is not available to VNC clients.\n\n## Web Notifications\n\nThe container includes support for notifications sent through the web browser.\nAny desktop notification generated by JDownloader 2 is forwarded to the\nbrowser, which then displays it as a native notification on the user's system.\n\nEnable the web notification service by setting `WEB_NOTIFICATION` to `1`. See\nthe [Environment Variables](#environment-variables) section for details on\nconfiguring environment variables.\n\n\u003e [!IMPORTANT]\n\u003e Web browsers only allow notifications in secure contexts (HTTPS). This means\n\u003e the container must be configured with secure web access. See\n\u003e [Security](#security) for details.\n\n\u003e [!NOTE]\n\u003e This feature is not available to VNC clients.\n\n### Web Terminal\n\nThe container includes a web-based terminal, allowing users to easily obtain\nshell access to the running container through a web browser.\n\nEnable the web terminal by setting `WEB_TERMINAL` to `1`. See the\n[Environment Variables](#environment-variables) section for details on\nconfiguring environment variables.\n\n\u003e [!IMPORTANT]\n\u003e For security reasons, the shell runs as a non-privileged user. As a result,\n\u003e commands that require root privileges cannot be executed.\n\n\u003e [!IMPORTANT]\n\u003e To prevent sensible information from leaking over the network, it is strongly\n\u003e recommended to configure the container with secure web access. See\n\u003e [Security](#security) for details.\n\n\u003e [!NOTE]\n\u003e This feature is not available to VNC clients.\n\n## GPU Acceleration Support\n\nThis container supports hardware-accelerated rendering of the application's\ngraphical user interface. When enabled, the X server running inside the\ncontainer can use the host GPU, providing improved rendering performance and\nfull hardware acceleration for OpenGL via the GLX extension.\n\nThis feature requires open-source kernel drivers on the host system, such as\n`amdgpu` for AMD GPUs, `i915` for Intel GPUs, or `nouveau` for NVIDIA GPUs, to\nsupport the Direct Rendering Infrastructure (DRI3) and Generic Buffer Management\n(GBM). Proprietary drivers, such as NVIDIA's, are not supported.\n\nTo enable GPU acceleration, the host must have compatible open-source kernel\ndrivers installed, and the GPU device `/dev/dri` must be exposed to the\ncontainer. For example, this is done by adding the `--device /dev/dri`\nargument to the `docker run` command.\n\n## Shell Access\n\nTo access the shell of a running container, execute the following command:\n\n```shell\ndocker exec -ti CONTAINER sh\n```\n\nWhere `CONTAINER` is the ID or the name of the container used during its\ncreation.\n\n## MyJDownloader\n\n[MyJDownloader](https://my.jdownloader.org) is an online service providing\nremote access to your JDownloader with Web Interface, Android App, iPhone App,\nWindows Phone App and Browser Extensions. It allows to check download status,\nadd links and solve captchas from everywhere.\n\nTo activate, open the JDownloader UI and click the *My.JDownloader* tab.\n\n### Direct Connection\n\nWhen using MyJDownloader from a device on the same local network as the\nJDownloader Docker container instance, *Direct Connection* mode can be enabled\nto reduce the latency and increase the bandwidth. With this mode, instead of\ngoing through the cloud, the communication is done through a direct connection\nbetween the device and JDownloader.\n\nThe default container's network being in *bridge* mode, the *Direct Connection*\nmode is not automatically detected/activated and the following steps are required:\n\n  * Make sure the container's port `3129` is mapped to the host port `3129`.\n    This is done by adding the parameter `-p 3129:3129` to the `docker run`\n    command.\n  * Open the JDownloader UI.\n  * Go to *Settings*-\u003e*Advanced Settings*.\n  * Search for `MyJDownloaderSettings`.\n  * Set `Custom Device IPs` to the IP address of the host running the container,\n    using double quotes and brackets like this example: `[\"192.168.1.1\"]`.\n  * Change the `Direct Connection Mode` to `Allow lan/wan connections with\n    manual port forwarding`.\n  * Restart JDownloader (*File*-\u003e*Restart*).\n\n## Click'n'Load\n\nThe easiest way to use the [Click'n'Load] feature is by installing the\n[MyJDownloader browser extension]. With this method, the browser extension\nhandles POST requests to `http://127.0.0.1:9666` and forward the links to\nJDownloader via the *MyJDownloader* service.\n\n[Click'n'Load]: http://jdownloader.org/knowledge/wiki/glossary/cnl2\n[MyJDownloader browser extension]: https://my.jdownloader.org/apps/\n\n## Troubleshooting\n\n### JDownloader Fails to Start\n\nIf JDownloader displays an error indicating that it is unable to start,\nfollowing these instruction might help fixing the problem.\n\n1. Create the file `.fix_jd_install`, under the directory that has been mapped\n   to `/config`. The content of the file is not important. However, if the\n   latest JDownloader installer is required, setting the content to `download`\n   causes the installer to be downloaded.\n2. Restart the container.\n\nThe presence of the file causes the container to attempt fixing the installation\nduring its startup. The repair process follows the instructions provided at:\n\nhttps://support.jdownloader.org/en/knowledgebase/article/fix-jdownloader-installation\n\n## Support or Contact\n\nHaving troubles with the container or have questions? Please\n[create a new issue](https://github.com/jlesage/docker-jdownloader-2/issues).\n\nFor other Dockerized applications, visit https://jlesage.github.io/docker-apps.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlesage%2Fdocker-jdownloader-2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjlesage%2Fdocker-jdownloader-2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlesage%2Fdocker-jdownloader-2/lists"}