antlafarge/jdownloader repository overview

⁠JDownloader 2

Docker JDownloader 2 headless image with automatic updates.

There is no embedded graphical interface, you should manage your downloads through the official JDownloader web interface here : https://my.jdownloader.org⁠.

Dockerhub repository : https://hub.docker.com/r/antlafarge/jdownloader⁠.
Github repository : https://github.com/antlafarge/jdownloader⁠.
You can report issues in the github issues⁠.
You can send feedback and discuss the project in the github discussions⁠.

⁠Tags and architectures

• latest⁠ = debian⁠ + ubuntu⁠ + alpine⁠
• debian⁠ = debian-openjdk21⁠ + debian-openjdk17⁠
• ubuntu⁠ = ubuntu-openjdk21⁠ + ubuntu-openjdk17⁠ + ubuntu-openjdk8⁠
• alpine⁠ = alpine-openjdk21⁠ + alpine-openjd17⁠ + alpine-openjdk8⁠
• openjdk21⁠ = debian-openjdk21⁠ + ubuntu-openjdk21⁠ + alpine-openjdk21⁠
• openjdk17⁠ = debian-openjdk17⁠ + ubuntu-openjdk17⁠ + alpine-openjdk17⁠
• openjdk8⁠ = ubuntu-openjdk8⁠ + alpine-openjdk8⁠

⁠Docker Compose⁠

services:
  jdownloader:
    image: antlafarge/jdownloader:<TAG>
    container_name: <CONTAINER-NAME> # Optional
    restart: <RESTART> # Optional
    user: <UID>:<GID> # Optional
    volumes:
      - "<DOWNLOADS-PATH>:/jdownloader/downloads/"
      - "<CONFIG-PATH>:/jdownloader/cfg/" # Optional
      - "<LOGS-PATH>:/jdownloader/logs/" # Optional
    environment:
      JD_EMAIL: "<JD-EMAIL>" # Optional (better to use secrets)
      JD_PASSWORD: "<JD-PASSWORD>" # Optional (better to use secrets)
      JD_DEVICENAME: "<JD-DEVICENAME>" # Optional
      UMASK: "<UMASK>" # Optional
      JAVA_OPTIONS: "<JAVA-OPTIONS>" # Optional
      LOG_FILE: "<LOG-FILE>" # Optional
    secrets:
        - JD_EMAIL
        - JD_PASSWORD
        - JD_DEVICENAME # Optional
    ports:
      - <PORT>:3129 # Optional

secrets:
    JD_EMAIL:
        file: "<JD-EMAIL-FILE>" # Put your myJD email in this file
    JD_PASSWORD:
        file: "<JD-PASSWORD-FILE>" # Put your myJD password in this file
    JD_DEVICENAME: # Optional
        file: "<JD-DEVICENAME-FILE>" # Put your myJD device name in this file

services:
  jdownloader:
    image: antlafarge/jdownloader:latest
    container_name: jdownloader
    restart: on-failure:3
    user: 1000:100
    volumes:
      - "/hdd/JDownloader/downloads/:/jdownloader/downloads/"
      - "/hdd/JDownloader/cfg/:/jdownloader/cfg/"
    secrets:
        - JD_EMAIL
        - JD_PASSWORD
        - JD_DEVICENAME
    ports:
      - 3129:3129

secrets:
    JD_EMAIL:
        file: "/hdd/JDownloader/secrets/JD_EMAIL.txt"
    JD_PASSWORD:
        file: "/hdd/JDownloader/secrets/JD_PASSWORD.txt"
    JD_DEVICENAME:
        file: "/hdd/JDownloader/secrets/JD_DEVICENAME.txt"

⁠Parameters

⁠Docker run⁠

docker run -d \
        --name <CONTAINER-NAME> \
        --restart <RESTART> \
        --user <UID>:<GID> \
    -v "<DOWNLOADS-PATH>:/jdownloader/downloads/" \
        -v "<CONFIG-PATH>:/jdownloader/cfg/" \
        -v "<LOGS-PATH>:/jdownloader/logs/" \
    -v "<JD-EMAIL-FILE>:/run/secrets/JD_EMAIL" \
    -v "<JD-PASSWORD-FILE>:/run/secrets/JD_PASSWORD" \
        -e JD_EMAIL="<JD-EMAIL>" \
        -e JD_PASSWORD="<JD-PASSWORD>" \
        -e JD_DEVICENAME="<JD-DEVICENAME>" \
        -e JAVA_OPTIONS="<JAVA-OPTIONS>" \
        -e LOG_FILE="<LOG-FILE>" \
        -e UMASK="<UMASK>" \
        -p <PORT>:3129 \
    antlafarge/jdownloader:<TAG>

echo "[email protected]" > ./JD_EMAIL.txt
echo "MyPassword" > ./JD_PASSWORD.txt

docker run -d \
        --name jdownloader \
        --restart on-failure:3 \
        --user 1000:100 \
    -v "/hdd/JDownloader/downloads/:/jdownloader/downloads/" \
        -v "/hdd/JDownloader/cfg/:/jdownloader/cfg/" \
    -v "./JD_EMAIL.txt:/run/secrets/JD_EMAIL" \
    -v "./JD_PASSWORD.txt:/run/secrets/JD_PASSWORD" \
        -e JD_DEVICENAME="JD-DOCKER" \
        -p 3129:3129 \
    antlafarge/jdownloader:latest

⁠Guides

⁠Setup

• Go to my.jdownloader.org⁠ and create an account.
• If you want to run the container as an unprivileged user, use the user parameter and check the access permissions of the directories you mount as volumes
  • Create the downloads directory : mkdir /path/to/jdownloader/downloads/
  • Setup the user and group owners : sudo chown -R 1000:100 /path/to/jdownloader/downloads/
    • You can get your User ID (UID) by using : id -u
    • You can get your User Group ID (GID) by using : id -g
      • I recommend to use 100 as GID (users group), because every users should be in this group, and it will be easier to manage multi-users privileges.
  • Setup the downloads directory access permissions : sudo chmod -R 770 /path/to/jdownloader/downloads/
  • Setup the config directory access permissions : sudo chmod -R 770 /path/to/jdownloader/cfg/
  • Setup the secrets directory access permissions : sudo chmod -R 770 /path/to/jdownloader/secrets/
    • Create the secret file for your JD e-mail : echo '[email protected]' > /path/to/jdownloader/secrets/JD_EMAIL.txt
    • Create the secret file for your JD password : echo 'MyGreatPassword' > /path/to/jdownloader/secrets/JD_PASSWORD.txt
    • Create the secret file for your JD device name : echo 'JD-DOCKER' > /path/to/jdownloader/secrets/JD_DEVICENAME.txt
• Run the container by choosing the docker run⁠ or docker compose⁠ method and customize the parameters by using your myJDownloader⁠ credentials.
  • You can check the container logs : docker logs --follow --tail 100 jdownloader (CTRL + C to quit)
• Wait some minutes for JDownloader to update and be available in your myJDownloader web interface⁠.

⁠Update JDownloader

JDownloader will update itself automatically when it is idle (every 12 hours), so you have nothing to do.
To disable the automatic upates, go to your JD instance on my.jdownloader.org⁠, and go to Settings / Event Scripter and switch from Enabled to Disabled.

⁠Update the image

The dockerhub image is rebuilt monthly to get last OS and packages security updates.

• Docker compose⁠ method :
  • Update the image : docker compose pull jdownloader
  • Recreate the container : docker compose up -d --force-recreate jdownloader
  • Remove the old images : docker image prune -f
• Docker run⁠ method :
  • Update the image : docker pull antlafarge/jdownloader:latest
  • Remove the current container : docker rm -f jdownloader
  • Start the container : docker run ...
  • Remove the old images : docker image prune -f

⁠Special characters in password

• If you used the docker secrets, put the raw password in the secret file without escaping any character.
• If you want to use environment variables.
  • Docker-compose.yml⁠ file :
    • Escape double quotes (") with backslashes (\)
      • JD_PASSWORD="My\"Great`Password"
  • Docker run⁠ command :
    • If you have exclamation marks (!) in your password and you use a bash shell, this special character corresponds to commands history substitution. You might need to disable it :
      • Type the command set +H in your bash shell.
    • Escape double quotes (") or backticks (`) with backslashes (\)
      • JD_PASSWORD="My\"Great\`Password"
• If you want to put your password manually in the settings file :
  • Modify your docker-compose.yml⁠ file or docker run⁠ command parameters :
    • Set an empty <JD_PASSWORD> (for disabling password replacement on container start) :
      • JD_PASSWORD=""
    • Set a <CONFIG-PATH> volume to have an access to the JDownloader settings files.
  • Start the container.
  • Go to your config directory and open the settings file named org.jdownloader.api.myjdownloader.MyJDownloaderSettings.json.
  • Search for the password field and place your password in the empty double quotes. "password":"MyGreatPassword",
    • Escape double quotes (") with backslashes (\).
      • "password":"My\"Great`Password",
  • Save the file and restart the container. docker restart jdownloader

⁠Troubleshooting

⁠Files permissions issue

Check the user you use to run the container (with user parameter) can read and write the directories you created and you mounted as volumes⁠.
Read carefully the Setup guide⁠ and follow the steps.
Or run the container as root (remove user parameter).

⁠Docker privileges

If many internal commands fail, your container may lack some privileges and you can try the --privileged⁠ flag.

⁠Nothing worked / another issue

You can report issues in the github issues⁠.
You can send feedback and discuss the project in the github discussions⁠.