forked from jlesage/docker-jdownloader-2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
appdefs.yml
361 lines (350 loc) · 15.6 KB
/
appdefs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
---
#
# Definitions for JDownloader 2 docker container.
#
# This file is used as data source to generate README.md and unRAID template files
# from Jinja2 templates.
#
app:
id: 7
name: jdownloader-2
friendly_name: JDownloader 2
gui_type: x11
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!
url: http://jdownloader.org
unraid:
support_url: https://forums.unraid.net/topic/58552-support-jdownloader-2/
category: "Downloaders:"
documentation:
sections:
- title: MyJDownloader
level: 2
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.
- title: Direct Connection
level: 3
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*).
- title: Click'n'Load
level: 2
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/
changelog:
- version: 22.12.1
date: 2022-12-01
changes:
- 'Fixed issue where taking ownership of `/output` could fail during startup.'
- version: 22.11.2
date: 2022-11-30
changes:
- 'Allow more time to JDownloader to restart itself.'
- 'Fixed issue where permissions of `/tmp` were incorrect on some systems.'
- 'Updated baseimage to version `4.2.0`, which brings multiple internal enhancements.'
- version: 22.11.1
date: 2022-11-18
changes:
- 'Added the ability to set MyJDownloader credentials via environment variables.'
- 'Added the ability to run JDownloader in headless mode.'
- 'Versioning scheme of the Docker image changed to `YY.MM.SEQUENCE`.'
- 'Update of the baseimage to version 4.1.5 brings the following new features:'
- '2:Multi-arch image support.'
- '2:Support for dark mode.'
- '2:Support for remote window resize.'
- '2:Updated the web UI with a new, simplified and less intrusive look.'
- version: 1.7.2
date: 2022-08-18
changes:
- 'Use better way to test if output folder is writable.'
- 'Now using baseimage version 3.5.8, based on Alpine Linux 3.15, which brings the following changes:'
- '2:Updated installed packages to get latest security fixes.'
- version: 1.7.1
date: 2021-04-13
changes:
- 'Now using baseimage version 3.5.7, which brings the following change:'
- '2:Updated installed packages to get latest security fixes.'
- version: 1.7.0
date: 2021-03-12
changes:
- 'Removed usage of glibc: 7ZipJBindings now works under Alpine Linux and proper support as been added to JDownloader.'
- 'Updated baseimage to version 3.5.6, which brings the following changes:'
- '2:Updated installed packages to get latest security fixes.'
- '2:Make sure the tzdata is installed.'
- '2:Upgraded glibc to version 2.31 on Alpine Linux images with glibc integrated.'
- '2:Adjusted the log monitor target for recent versions of YAD.'
- 'Now using baseimage based on Alpine 3.12.'
- version: 1.6.0
date: 2020-04-25
changes:
- 'Added the ability to install extra packages to the container image.'
- version: 1.5.2
date: 2019-04-27
changes:
- 'Now using Java JRE from Amazon instead of Oracle.'
- 'Now using baseimage v3.5.2, which brings the following changes:'
- '2:Updated installed packages to get latest security fixes.'
- '2:Fixed issue where the container could have a zombie process.'
- '2:Fixed issue where the password would not be submitted when pressing the enter key in the password modal.'
- '2:Use relative path for favicon ressources to be more friendly with reverse proxy senarios.'
- version: 1.5.1
date: 2018-09-25
changes:
- 'Fixed issue where opening/processing captcha would crash JDownloader.'
- version: 1.5.0
date: 2018-09-21
changes:
- 'Now using baseimage v3.5.1, which brings the following changes (since last used version):'
- '2:Image based on Alpine Linux 3.8.'
- '2:Upgraded s6-overlay to version 1.21.4.0.'
- '2:Wait for a limited time when terminating a service.'
- '2:Set and create the XDG_RUNTIME_DIR directory.'
- '2:Updated installed packages to get latest security fixes.'
- 'Upgraded Java JRE to version 8u181.'
- 'Install `ffmpeg`, `ffprobe` and `rtmpdump` to allow JDownloader to use them.'
- 'Fixed an issue where JDownloader would not work on a filesystem without execution permission.'
- version: 1.4.3
date: 2018-03-02
changes:
- 'Now using baseimage v3.3.4, which brings the following changes (since last used version):'
- '2:Make sure the log monitor is started after the X server.'
- '2:Fixed an issue where the log monitor `yad` target would use XDG folders of the application.'
- '2:Fixed issue where log monitor states were not cleared during container startup.'
- version: 1.4.2
date: 2018-02-03
changes:
- 'Now using baseimage v3.3.2, which brings the following changes:'
- '2:Restored timezone support in Alpine Linux images with glibc.'
- '2:Fixed issue in `add-pkg` helper where a package could be incorrectly detected as installed.'
- version: 1.4.1
date: 2018-01-30
changes:
- 'Now using baseimage v3.3.1, which brings the following changes:'
- '2:Adjusted the way some ressources are accessed to better support reverse proxy to the container.'
- version: 1.4.0
date: 2018-01-22
changes:
- 'Now using baseimage v3.3.0, which brings the following changes (since last used version):'
- '2:For Alpine Linux images with glibc, automatically update dynamic linker''s cache after new libraries are installed.'
- '2:Fixed the LANG environment variable not being set properly.'
- '2:Added the ability to automatically install a CJK (Chinese/Japanese/Korean) font.'
- version: 1.3.5
date: 2018-01-11
changes:
- 'Fixed issue where libraries were not found.'
- version: 1.3.4
date: 2018-01-11
changes:
- 'Now using baseimage v3.2.2, which brings the following changes (since last used version):'
- '2:Upgraded S6 overlay to version 1.21.2.2.'
- '2:Upgraded glibc to version 2.26 (Alpine Linux glibc images).'
- '2:Adjusted the way ownership of /config is taken to better support cases where the folder is mapped to a network share.'
- 'Small adjustment to the way ownership of files are taken.'
- version: 1.3.3
date: 2017-12-12
changes:
- 'Now using baseimage v3.1.4, which brings the following changes:'
- '2:Set 2 worker processes for nginx.'
- version: 1.3.2
date: 2017-11-20
changes:
- 'Now using baseimage v3.1.3, which brings the following changes:'
- '2:Upgraded S6 overlay to version 1.21.2.1.'
- version: 1.3.1
date: 2017-11-07
changes:
- 'Now using baseimage v3.1.2, which brings the following changes (from last used version):'
- '2:Fixed an issue where a self-disabled service could be restarted.'
- '2:Upgraded S6 overlay to version 1.21.2.0.'
- '2:Use a more efficient way to monitor status files.'
- 'Fixed and issue where container would not start when log directory is missing.'
- version: 1.3.0
date: 2017-10-29
changes:
- 'Now using baseimage v3.1.0, which brings the following changes:'
- '2:Upgraded S6 overlay to version 1.21.1.1.'
- '2:Enhanced integration of service dependencies functionality.'
- '2:Added a simple log monitor.'
- '2:Fixed race condition where container''s exit code would not be the expected one.'
- '2:Fixed issue where application''s GUI fails to displayed when accessing it through the web interface via standard ports 80/443.'
- version: 1.2.0
date: 2017-10-10
changes:
- 'Now using baseimage v3.0.2, which brings the following changes:'
- '2:Better support for service dependencies.'
- '2:Added support for secure access to the application''s GUI.'
- version: 1.1.8
date: 2017-09-08
changes:
- 'Now using baseimage v2.0.8, which brings the following changes (from last used version):'
- '2:Fixed timezone support on alpine-glibc images.'
- '2:Fixed duplicated entries in /etc/passwd and /etc/group that were created after a restart of the container.'
- version: 1.1.7
date: 2017-09-01
changes:
- 'Fixed issue where the first-run indication had the wrong ownership.'
- 'Fixedissue where increase of the time before forcefully killing processes was not respected.'
- version: 1.1.6
date: 2017-08-14
changes:
- 'Now using baseimage v2.0.6, which brings the following changes:'
- '2:Upgraded S6 overlay to version 1.20.0.0.'
- version: 1.1.5
date: 2017-07-31
changes:
- 'Properly remove the first run indication.'
- version: 1.1.4
date: 2017-07-31
changes:
- 'Now using baseimage v2.0.5, which brings the following changes (from last used version):'
- '2:Clear the environment of the container during startup.'
- '2:Clear the /tmp folder during startup.'
- '2:Cleanly terminate the X server when container is restarted/stopped.'
- '2:Improved robustness of X server starting process.'
- '2:Removed unneeded files from the image.'
- version: 1.1.3
date: 2017-07-27
changes:
- 'Now using baseimage v2.0.3, which brings the following changes:'
- '2:Improved robustness of the X server starting process.'
- version: 1.1.2
date: 2017-07-23
changes:
- 'Now using baseimage v2.0.2, which brings the following changes:'
- '2:Proper VNC port is exposed.'
- version: 1.1.1
date: 2017-07-18
changes:
- 'Now using baseimage v2.0.1, which brings the following changes:'
- '2:Internal enhancements.'
- '2:Clean temporary files left by npm.'
- version: 1.1.0
date: 2017-07-17
changes:
- 'Now using baseimage v2.0.0, which brings the following changes:'
- '2:Various internal enhancements.'
- '2:Fixed the way a service waits for another one.'
- version: 1.0.1
date: 2017-07-07
changes:
- 'Fixed the auto archive extractor.'
- 'Allow more time to JDownloader to gracefully shutdown.'
- 'Improved handling/monitoring of JDownloader process.'
- version: 1.0.0
date: 2017-07-05
changes:
- 'Initial release.'
container:
rough_download_size: 150MB
unsupported_volume:
- /storage
# Environment variables.
environment_variables:
- name: MYJDOWNLOADER_EMAIL
description: >-
Email address of the MyJDownloader account to use. Note that this can
also be configured via the JDownloader GUI.
type: public
default:
unraid_template:
title: MyJDownloader Email
display: advanced
required: false
mask: false
- name: MYJDOWNLOADER_PASSWORD
description: >-
Password of the MyJDownloader account to use. Note that this can
also be configured via the JDownloader GUI.
type: public
default:
unraid_template:
title: MyJDownloader Password
display: advanced
required: false
mask: false
- name: MYJDOWNLOADER_DEVICE_NAME
description: >-
The name of this JDownloader instance. Note that this can
also be configured via the JDownloader GUI.
type: public
default:
unraid_template:
title: MyJDownloader Device Name
display: advanced
required: false
mask: false
- name: JDOWNLOADER_HEADLESS
description: >-
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.
type: public
default: 0
unraid_template:
title: Headless Mode
description: >-
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.
display: advanced
required: false
mask: false
# Volumes
volumes:
- container_path: /output
host_path_example: $HOME/Downloads
description: >-
This is where downloaded files are stored.
permissions: rw
include_in_quick_start: true
unraid_template:
title: Output Directory
description: >-
This is the default output folder for downloaded files.
display: advanced-hide
required: true
mask: false
# Network ports
ports:
- number: 3129
protocol: tcp
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).
mandatory: false
# Devices
devices: []