Skip to content

Latest commit

 

History

History
199 lines (167 loc) · 10.8 KB

README.md

File metadata and controls

199 lines (167 loc) · 10.8 KB
Raw

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

JDownloader 2 - Docker Image

latest release Docker Pulls Docker stars PayPal donation Buy me a coffee Buy me a coffee

Headline

This image allows you to have JDownloader 2 easily installed and controlled via MyJDownloader, 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 </path/to/downloads>:/opt/JDownloader/Downloads -v </path/to/appdata/config>:/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

services:
   jdownloader:
    image: jaymoulin/jdownloader
    container_name: jdownloader
    restart: always
    user: 1001:100
    volumes:
        - </path/to/appdata/config>:/opt/JDownloader/app/cfg
        - </path/to/downloads>:/opt/JDownloader/Downloads
        - </path/to/appdata/logs>:/opt/JDownloader/app/logs #optional
        - </path/to/appdata/extensions>:/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

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 (moby/moby#41017) (moby/moby#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 <UID>:<GID> 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
-p 3129:3129 This Network port is required for Direct Connection mode, more information in this section

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

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 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 from JDownloader
  • OpenWRT: browse to Network>DHCP and DNS>General Settings and add mydns.jdownloader.org to Domain Whitelist
  • pfSense: more information here

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)