Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jaymoulin/docker-jdownloader

JDownloader 2 Docker Image (Multiarch) - 50M+ Downloads
https://github.com/jaymoulin/docker-jdownloader

arm armv7 docker docker-image download download-manager downloader downloadmanager jdownloader multiarch raspberry raspberry-pi raspberrypi

Last synced: 4 days ago
JSON representation

JDownloader 2 Docker Image (Multiarch) - 50M+ Downloads

Awesome Lists containing this project

README 

        
> [!CAUTION]

> As-of 2021, this product does not have a free support team anymore. If you want this product to be maintained, please support my work.

 

> [!NOTE]

> (This product is available under a free and permissive license, but needs financial support to sustain its continued improvements. In addition to maintenance and stability there are many  desirable features yet to be added.)



![logo](logo.png "logo")



JDownloader 2 - Docker Image

==========================



[![latest release](https://img.shields.io/github/release/jaymoulin/docker-jdownloader.svg "latest release")](http://github.com/jaymoulin/docker-jdownloader/releases)

[![Docker Pulls](https://img.shields.io/docker/pulls/jaymoulin/jdownloader.svg)](https://hub.docker.com/r/jaymoulin/jdownloader/)

[![Docker stars](https://img.shields.io/docker/stars/jaymoulin/jdownloader.svg)](https://hub.docker.com/r/jaymoulin/jdownloader/)

[![PayPal donation](https://github.com/jaymoulin/jaymoulin.github.io/raw/master/ppl.png "PayPal donation")](https://www.paypal.me/jaymoulin)

[![Buy me a coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png "Buy me a coffee")](https://www.buymeacoffee.com/jaymoulin)

[![Buy me a coffee](https://ko-fi.com/img/githubbutton_sm.svg "Buy me a coffee")](https://www.ko-fi.com/jaymoulin)



# Headline



This image allows you to have JDownloader 2 easily installed and controlled via [MyJDownloader](https://my.jdownloader.org/), thanks to Docker. 

No cluncky and rusty VNC sessions here! No graphical interface - No problem!



Installation

---



Here are some examples to get started with the creation of this container. Please note that this package is also hosted on Github Container Registry, just add `ghcr.io/` before the image name (`docker pull ghcr.io/jaymoulin/jdownloader` instead of `jaymoulin/jdownloader`)



### Docker

```

docker run -d --init --restart=always -v :/opt/JDownloader/Downloads -v :/opt/JDownloader/app/cfg --name jdownloader -u $(id -u) -p 3129:3129 -e [email protected] -e MYJD_PASSWORD=bar -e MYJD_DEVICE_NAME=goofy jaymoulin/jdownloader

```

### Docker Compose

```yml

services:

   jdownloader:

    image: jaymoulin/jdownloader

    container_name: jdownloader

    restart: always

    user: 1001:100

    volumes:

        - :/opt/JDownloader/app/cfg

        - :/opt/JDownloader/Downloads

        - :/opt/JDownloader/app/logs #optional

        - :/opt/JDownloader/app/extensions #optional

        - /etc/localtime:/etc/localtime:ro #optional

    environment: 

            FILE_MYJD_USER: myjd-user #optional (see [Identify](https://github.com/jaymoulin/docker-jdownloader#identify))

            FILE_MYJD_PASSWORD: myjd-password #optional (see [Identify](https://github.com/jaymoulin/docker-jdownloader#identify))

            MYJD_USER: [email protected] #optional (see [Identify](https://github.com/jaymoulin/docker-jdownloader#identify))

            MYJD_PASSWORD: bar #optional (see [Identify](https://github.com/jaymoulin/docker-jdownloader#identify))

            MYJD_DEVICE_NAME: goofy #optional

            XDG_DOWNLOAD_DIR: /opt/JDownloader/Downloads #optional

    ports:

        - 3129:3129 

    secrets:

        - myjd-user #optional (see [Identify](https://github.com/jaymoulin/docker-jdownloader#identify))

        - myjd-password #optional (see [Identify](https://github.com/jaymoulin/docker-jdownloader#identify))



secrets:

  myjd-user: #optional (see [Identify](https://github.com/jaymoulin/docker-jdownloader#identify))

    file: ~/jdownloader/secrets/myjd_user.txt

  myjd-password: #optional (see [Identify](https://github.com/jaymoulin/docker-jdownloader#identify))

    file: ~/jdownloader/secrets/myjd_password.txt

```



### Kubernetes



```yml

apiVersion: apps/v1

kind: Deployment

metadata:

  name: jdownloader

  labels:

    app: jdownloader

spec:

  replicas: 1

  selector:

    matchLabels:

      app: jdownloader

  template:

    metadata:

      labels:

        app: jdownloader

    spec:

      containers:

        - name: jdownloader

          image: jaymoulin/jdownloader

          env:

            - name: MYJD_USER

              value: "[email protected]"

            - name: MYJD_PASSWORD

              valueFrom:

                secretKeyRef:

                  name: my_jd_secret

                  key: password

          volumeMounts:

            - mountPath: /opt/JDownloader/app

              name: exec

            - mountPath: /opt/JDownloader/app/cfg

              name: cfg

            - mountPath: /opt/JDownloader/Downloads

              name: downloads

            - mountPath: /opt/JDownloader/app/extensions

              name: extensions

      volumes:

        - name: exec

          emptyDir: {}

        - name: cfg

          hostPath:

            path: /path/to/jd/cfg

            type: Directory

        - name: downloads

          hostPath:

            path: /path/to/downloads

            type: Directory

        - name: extensions

          hostPath:

            path: /path/to/extensions

            type: Directory

```



> [!CAUTION]

> *Note for RPI Zero*

> You may need to specify that you want the arm32v6 image (e.g. `docker run -d --platform=linux/arm/v6 jaymoulin/jdownloader`) because rpi zero identifies itself as armhf which is incorrect (https://github.com/moby/moby/issues/41017) (https://github.com/moby/moby/issues/34875).



Configuration

---

You can set many parameters when you configure this container, but you must specify your MyJDownloader login/password to connect to your container.



### Configuration values 

| Parameter | Function |

| :----: | --- |

| `-v /opt/JDownloader/app/cfg`| Config file folder, saves your configuration on the host |

| `-v /opt/JDownloader/app/logs` | Container logs folder, specify it only if you wan to keep logs on the host |

| `-v /opt/JDownloader/app/extensions` | Extensions folder, specify it only if you wan to install extensions and keep it on the host |

| `-v /opt/JDownloader/Downloads` | Downloads folder (where you put your `download` mountpoint) | 

| `-u :` | Add user identifiers to run the container with user priviledges. To obtain such values, run on your host `id yourusername`, additional information can be found in [Docker documentation](https://docs.docker.com/engine/reference/commandline/exec/#options)

| `-p 3129:3129` | This Network port is required for Direct Connection mode, more information in [this section](https://github.com/jaymoulin/docker-jdownloader#direct-connection) |



### Environment Variables

| Parameter | Function |

| :----: | --- |

| `FILE_MYJD_USER=myjd-user` | The docker secret of your MyJDownloader user |

| `FILE_MYJD_PASSWORD=myjd-password` | The docker secret of your MyJDownloader password |

| `[email protected]` | Your MyJDownloader user |

| `MYJD_PASSWORD=foo` | Your MyJDownloader password |

| `MYJD_DEVICE_NAME=goofy`| The device name that will appear on MyJdownloader portal |

| `XDG_DOWNLOAD_DIR=/opt/JDownloader/Downloads` | If you use this variable, set it as per the downloads folder volume! |

| `UMASK="0002"` | Defines specific rights for your downloaded files (default: undefined) - Must respect octal form (begins with 0 followed by three numbers between 0 and 7 included) (cf. https://en.wikipedia.org/wiki/Umask) |



#### Identify

There are 3 possibilities to give login password for MyJDownloader:

- Declare FILE_MYJD_USER and FILE_MY_JD_PASSWORD which is used with the principle of docker secret : https://docs.docker.com/engine/swarm/secrets/#use-secrets-in-compose. This is the most docker way.

- Declare MYJD_USER and MYJD_PASSWORD values which only create environment variable

- If haven't set FILE_MYJD_USER, FILE_MY_JD_PASSWORD, MYJD_USER and MYJD_PASSWORD values, you can still configure an account by running (Recommended method because it is the most secure but not fully automatic in the docker-compose.)



```

docker exec jdownloader configure [email protected] password

```



Other options can be changed on your MyJDownloader account : https://my.jdownloader.org/index.html#dashboard.



Appendixes

---



### Direct Connection Mode



Direct Connection mode (or Direct Connections) improves the use of this container via MyJDownloader GUI and is strongly recommended at least in your LAN.



By enabling this mode, the communication happens directly between the client and the JDownloader server via port 3129 (by default), instead of being routed trough MyJDownloader servers. This enables the GUI to respond much faster with information reliably updating over time.

In this mode, MyJDownloader server still handles service related tasks, like the session authentication and notifications.



To enable Direct Connection mode from internet, you need to open and forward port 3129 adjusting your router configuration. Please find more information in this [JDownloader's article](https://support.jdownloader.org/Knowledgebase/Article/View/33/0/myjdownloader-advanced-settings)



#### DNS Rebind Warning

If you are running a router like Fritz!Box, Asus, OpenWRT, DDWRT, pfSense or any other 3rd party *advanced* routers you may have DNS Rebind Protection enabled: Direct Connections will not work, you will have to explicitly whitelist `mydns.jdownloader.org`. The procedure is different for every router, here are some tips:



* Asus Merlin: Follow [this procedure](https://github.com/RMerl/asuswrt-merlin.ng/wiki/Custom-domains-with-dnsmasq) to enable custom scripts and edit the dnsmasq file, then add the line `rebind-domain-ok=/mydns.jdownloader.org/`

* FreshTomato: In 'Advanced->DHCP/DNS/Dnsmasq Custom configuration' add `rebind-domain-ok=mydns.jdownloader.org`

* Fritz!Box: [KB Article](https://support.jdownloader.org/Knowledgebase/Article/View/51) from JDownloader

* OpenWRT: browse to Network>DHCP and DNS>General Settings and add `mydns.jdownloader.org` to Domain Whitelist

* pfSense: more information [here](https://github.com/jaymoulin/docker-jdownloader/issues/61#issuecomment-607474205)



### Direct Connection using a Bridged Network



To get Direct Connection when using a bridged newtwork, please follow these steps:



* Expose 3129 port when creating the container (`-p 3129:3129` parameter)

* When JDownloader is running, navigate to Settings > Advanced Settings > Search for "myjdownloader" > Find *MyJDownloaderSettings: Custom Device IPs* and enter your host LAN IP using this formatting `["192.168.1.10"]`. If you need to specify more IPs use `["192.168.1.10","10.10.10.10"]`

* Set *MyJDownloaderSettings: Manual Local Port* to `3129`

* Set *MyJDownloaderSettings: Direct Connect Mode* to `Allow lan/wan connections with manual port forwarding`

* Restart JDownloader, connections will now be direct



### Debugging



You can put a file called `jdownloader-block.txt` file in your Download folder to pause the container start.

This will allow to connect to the container with a shell to debug. (`docker exec -it jdownloader sh`)