appdefs.xml

<!--
Definitions for JDownloader 2 docker container.

This file is used as data source to generate README.md and unRAID template files
from Jinja2 templates.
-->
<defs>
  <app>
    <id>7</id>
    <gui_type>x11</gui_type>
    <friendly_name>JDownloader 2</friendly_name>
    <name>{{ defs.app.friendly_name|lower|replace(' ', '-') }}</name>
    <project>
      <description>
JDownloader 2 is a free, open-source download management tool with a huge
community of developers that makes downloading as easy and fast as it should be.
Users can start, stop or pause downloads, set bandwith limitations, auto-extract
archives and much more. It's an easy-to-extend framework that can save hours of
your valuable time every day!
      </description>
      <url>http://jdownloader.org/</url>
    </project>
    <unraid>
      <support_url>https://forums.unraid.net/topic/58552-support-jdownloader-2/</support_url>
      <category>Downloaders:</category>
    </unraid>
    <container>
      <rough_download_size>100MB</rough_download_size>
      <unsupported_volume>/storage</unsupported_volume>
    </container>
    <!-- Extra stuff to be added to the documentation. -->
    <documentation>
      <section>
        <title level="2">MyJDownloader</title>
        <content>
[MyJDownloader](https://my.jdownloader.org) is an online service providing
remote access to your JDownloader with Web Interface, Android App, iPhone App,
Windows Phone App and Browser Extensions.  It allows to check download status,
add links and solve captchas from everywhere.

To activate, open the JDownloader UI and click the *My.JDownloader* tab.
        </content>
      </section>
      <section>
        <title level="3">Direct Connection</title>
        <content>
When using MyJDownloader from a device on the same local network as the
JDownloader Docker container instance, *Direct Connection* mode can be enabled
to reduce the latency and increase the bandwidth.  With this mode, instead of
going through the cloud, the communication is done through a direct connection
between the device and JDownloader.

The default container's network being in *bridge* mode, the *Direct Connection*
mode is not automatically detected/activated and the following steps are required:

  * Make sure the container's port `3129` is mapped to the host port `3129`.
    This is done by adding the parameter `-p 3129:3129` to the `docker run`
    command.
  * Open the JDownloader UI.
  * Go to *Settings*->*Advanced Settings*.
  * Search for `MyJDownloaderSettings`.
  * Set `Custom Device IPs` to the IP address of the host running the container,
    between double quotes (e.g. `"192.168.1.1"`).
  * Change the `Direct Connection Mode` to `Allow lan/wan connections with
    manual port forwarding`.
  * Restart JDownloader (*File*->*Restart*).
        </content>
      </section>
      <section>
        <title level="2">Click'n'Load</title>
        <content>
The easiest way to use the [Click'n'Load] feature is by installing the
[MyJDownloader browser extension].  With this method, the browser extension
handles POST requests to `http://127.0.0.1:9666` and forward the links to
JDownloader via the *MyJDownloader* service.

[Click'n'Load]: http://jdownloader.org/knowledge/wiki/glossary/cnl2
[MyJDownloader browser extension]: https://my.jdownloader.org/apps/
        </content>
      </section>
    </documentation>
    <!-- Changelog of the application. -->
    <history>
      <release>
        <version>1.6.0</version>
        <date>2020-04-25</date>
        <change>Added the ability to install extra packages to the container image.</change>
      </release>
      <release>
        <version>1.5.2</version>
        <date>2019-04-27</date>
        <change>Now using Java JRE from Amazon instead of Oracle.</change>
        <change>Now using baseimage v3.5.2, which brings the following changes:</change>
        <change level="2">Updated installed packages to get latest security fixes.</change>
        <change level="2">Fixed issue where the container could have a zombie process.</change>
        <change level="2">Fixed issue where the password would not be submitted when pressing the enter key in the password modal.</change>
        <change level="2">Use relative path for favicon ressources to be more friendly with reverse proxy senarios.</change>
      </release>
      <release>
        <version>1.5.1</version>
        <date>2018-09-25</date>
        <change>Fixed issue where opening/processing captcha would crash JDownloader.</change>
      </release>
      <release>
        <version>1.5.0</version>
        <date>2018-09-21</date>
        <change>Now using baseimage v3.5.1, which brings the following changes (since last used version):</change>
        <change level="2">Image based on Alpine Linux 3.8.</change>
        <change level="2">Upgraded s6-overlay to version 1.21.4.0.</change>
        <change level="2">Wait for a limited time when terminating a service.</change>
        <change level="2">Set and create the XDG_RUNTIME_DIR directory.</change>
        <change level="2">Updated installed packages to get latest security fixes.</change>
        <change>Upgraded Java JRE to version 8u181.</change>
        <change>Install `ffmpeg`, `ffprobe` and `rtmpdump` to allow JDownloader to use them.</change>
        <change>Fixed an issue where JDownloader would not work on a filesystem without execution permission.</change>
      </release>
      <release>
        <version>1.4.3</version>
        <date>2018-03-02</date>
        <change>Now using baseimage v3.3.4, which brings the following changes (since last used version):</change>
        <change level="2">Make sure the log monitor is started after the X server.</change>
        <change level="2">Fixed an issue where the log monitor `yad` target would use XDG folders of the application.</change>
        <change level="2">Fixed issue where log monitor states were not cleared during container startup.</change>
      </release>
      <release>
        <version>1.4.2</version>
        <date>2018-02-03</date>
        <change>Now using baseimage v3.3.2, which brings the following changes:</change>
        <change level="2">Restored timezone support in Alpine Linux images with glibc.</change>
        <change level="2">Fixed issue in `add-pkg` helper where a package could be incorrectly detected as installed.</change>
      </release>
      <release>
        <version>1.4.1</version>
        <date>2018-01-30</date>
        <change>Now using baseimage v3.3.1, which brings the following changes:</change>
        <change level="2">Adjusted the way some ressources are accessed to better support reverse proxy to the container.</change>
      </release>
      <release>
        <version>1.4.0</version>
        <date>2018-01-22</date>
        <change>Now using baseimage v3.3.0, which brings the following changes (since last used version):</change>
        <change level="2">For Alpine Linux images with glibc, automatically update dynamic linker's cache after new libraries are installed.</change>
        <change level="2">Fixed the LANG environment variable not being set properly.</change>
        <change level="2">Added the ability to automatically install a CJK (Chinese/Japanese/Korean) font.</change>
      </release>
      <release>
        <version>1.3.5</version>
        <date>2018-01-11</date>
        <change>Fixed issue where libraries were not found.</change>
      </release>
      <release>
        <version>1.3.4</version>
        <date>2018-01-11</date>
        <change>Now using baseimage v3.2.2, which brings the following changes (since last used version):</change>
        <change level="2">Upgraded S6 overlay to version 1.21.2.2.</change>
        <change level="2">Upgraded glibc to version 2.26 (Alpine Linux glibc images).</change>
        <change level="2">Adjusted the way ownership of /config is taken to better support cases where the folder is mapped to a network share.</change>
        <change>Small adjustment to the way ownership of files are taken.</change>
      </release>
      <release>
        <version>1.3.3</version>
        <date>2017-12-12</date>
        <change>Now using baseimage v3.1.4, which brings the following changes:</change>
        <change level="2">Set 2 worker processes for nginx.</change>
      </release>
      <release>
        <version>1.3.2</version>
        <date>2017-11-20</date>
        <change>Now using baseimage v3.1.3, which brings the following changes:</change>
        <change level="2">Upgraded S6 overlay to version 1.21.2.1.</change>
      </release>
      <release>
        <version>1.3.1</version>
        <date>2017-11-07</date>
        <change>Now using baseimage v3.1.2, which brings the following changes (from last used version):</change>
        <change level="2">Fixed an issue where a self-disabled service could be restarted.</change>
        <change level="2">Upgraded S6 overlay to version 1.21.2.0.</change>
        <change level="2">Use a more efficient way to monitor status files.</change>
        <change>Fixed and issue where container would not start when log directory is missing.</change>
      </release>
      <release>
        <version>1.3.0</version>
        <date>2017-10-29</date>
        <change>Now using baseimage v3.1.0, which brings the following changes:</change>
        <change level="2">Upgraded S6 overlay to version 1.21.1.1.</change>
        <change level="2">Enhanced integration of service dependencies functionality.</change>
        <change level="2">Added a simple log monitor.</change>
        <change level="2">Fixed race condition where container's exit code would not be the expected one.</change>
        <change level="2">Fixed issue where application's GUI fails to displayed when accessing it through the web interface via standard ports 80/443.</change>
      </release>
      <release>
        <version>1.2.0</version>
        <date>2017-10-10</date>
        <change>Now using baseimage v3.0.2, which brings the following changes:</change>
        <change level="2">Better support for service dependencies.</change>
        <change level="2">Added support for secure access to the application's GUI.</change>
      </release>
      <release>
        <version>1.1.8</version>
        <date>2017-09-08</date>
        <change>Now using baseimage v2.0.8, which brings the following changes (from last used version):</change>
        <change level="2">Fixed timezone support on alpine-glibc images.</change>
        <change level="2">Fixed duplicated entries in /etc/passwd and /etc/group that were created after a restart of the container.</change>
      </release>
      <release>
        <version>1.1.7</version>
        <date>2017-09-01</date>
        <change>Fixed issue where the first-run indication had the wrong ownership.</change>
        <change>Fixedissue where increase of the time before forcefully killing processes was not respected.</change>
      </release>
      <release>
        <version>1.1.6</version>
        <date>2017-08-14</date>
        <change>Now using baseimage v2.0.6, which brings the following changes:</change>
        <change level="2">Upgraded S6 overlay to version 1.20.0.0.</change>
      </release>
      <release>
        <version>1.1.5</version>
        <date>2017-07-31</date>
        <change>Properly remove the first run indication.</change>
      </release>
      <release>
        <version>1.1.4</version>
        <date>2017-07-31</date>
        <change>Now using baseimage v2.0.5, which brings the following changes (from last used version):</change>
        <change level="2">Clear the environment of the container during startup.</change>
        <change level="2">Clear the /tmp folder during startup.</change>
        <change level="2">Cleanly terminate the X server when container is restarted/stopped.</change>
        <change level="2">Improved robustness of X server starting process.</change>
        <change level="2">Removed unneeded files from the image.</change>
      </release>
      <release>
        <version>1.1.3</version>
        <date>2017-07-27</date>
        <change>Now using baseimage v2.0.3, which brings the following changes:</change>
        <change level="2">Improved robustness of the X server starting process.</change>
      </release>
      <release>
        <version>1.1.2</version>
        <date>2017-07-23</date>
        <change>Now using baseimage v2.0.2, which brings the following changes:</change>
        <change level="2">Proper VNC port is exposed.</change>
      </release>
      <release>
        <version>1.1.1</version>
        <date>2017-07-18</date>
        <change>Now using baseimage v2.0.1, which brings the following changes:</change>
        <change level="2">Internal enhancements.</change>
        <change level="2">Clean temporary files left by npm.</change>
      </release>
      <release>
        <version>1.1.0</version>
        <date>2017-07-17</date>
        <change>Now using baseimage v2.0.0, which brings the following changes:</change>
        <change level="2">Various internal enhancements.</change>
        <change level="2">Fixed the way a service waits for another one.</change>
      </release>
      <release>
        <version>1.0.1</version>
        <date>2017-07-07</date>
        <change>Fixed the auto archive extractor.</change>
        <change>Allow more time to JDownloader to gracefully shutdown.</change>
        <change>Improved handling/monitoring of JDownloader process.</change>
      </release>
      <release>
        <version>1.0.0</version>
        <date>2017-07-05</date>
        <change>Initial release.</change>
      </release>
    </history>
  </app>
  <container>
    <!-- Environment variables -->
    <environment_variables>
      <environment_variable>
        <name>INSTALL_EXTRA_PKGS</name>
        <description>Space-separated list of Alpine Linux packages to install.  See https://pkgs.alpinelinux.org/packages?name=&amp;branch=v3.9&amp;arch=x86_64 for the list of available Alpine Linux packages.</description>
        <default/>
        <unraid_template>
          <title>Install Packages</title>
        <description>Space-separated list of Alpine Linux packages to install.  See [i]https://pkgs.alpinelinux.org[/i] for the list of available Alpine Linux packages.</description>
          <display>advanced</display>
          <required>false</required>
          <mask>false</mask>
        </unraid_template>
      </environment_variable>
    </environment_variables>
    <!-- Volumes -->
    <volumes>
    <volume>
      <container_path>/output</container_path>
      <host_path_example>$HOME/Downloads</host_path_example>
      <description>This is where downloaded files are stored.</description>
      <permissions>rw</permissions>
      <include_in_quick_start>true</include_in_quick_start>
      <unraid_template>
        <title>Output Directory</title>
        <description>This is the default output folder for downloaded files.[br]Container path: /output</description>
        <display>always-hide</display>
        <required>true</required>
        <mask>false</mask>
      </unraid_template>
    </volume>
    </volumes>
    <!-- Network ports -->
    <ports>
      <port>
        <number>3129</number>
        <protocol>tcp</protocol>
        <description>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).</description>
        <mandatory>false</mandatory>
      </port>
    </ports>
    <!-- Devices -->
    <devices/>
    <!-- Extra parameters -->
    <extra_params/>
  </container>
</defs>