forked from jlesage/docker-filebot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathappdefs.xml
521 lines (508 loc) · 26.1 KB
/
appdefs.xml
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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
<!--
Definitions for FileBot docker container.
This file is used as data source to generate README.md and unRAID template files
from Jinja2 templates.
-->
<defs>
<app>
<id>13</id>
<gui_type>x11</gui_type>
<friendly_name>FileBot</friendly_name>
<name>{{ defs.app.friendly_name|lower|replace(' ', '-') }}</name>
<project>
<description>
FileBot is the ultimate tool for organizing and renaming your movies, tv shows
or anime, and music well as downloading subtitles and artwork. It's smart and
just works.
</description>
<url>http://www.filebot.net/</url>
</project>
<unraid>
<support_url>https://forums.unraid.net/topic/68916-support-filebot/</support_url>
<category>MediaApp:Other</category>
</unraid>
<container>
<rough_download_size>215MB</rough_download_size>
<storage_permissions>rw</storage_permissions>
</container>
<!-- Extra stuff to be added to the documentation. -->
<documentation>
<section>
<title level="2">License</title>
<content>
{{ defs.app.friendly_name }} supports a cross-platform custom license model,
which means that a license can be purchased and then be used on all the buyer's
machines.
While {{ defs.app.friendly_name }} can be used/evaluated without a license,
certain features, like renaming files, won't work without one.
A license can be purchased at https://www.filebot.net/purchase.html.
</content>
</section>
<section>
<title level="3">Installing a License</title>
<content>
Once purchased, the license file received via email can be saved on the host,
into the configuration directory of the container (i.e. in the directory mapped
to `/config`).
Then, start or restart the container to have it automatically installed.
**NOTE**: The license file is expected to have a `.psm` extension.
</content>
</section>
<section>
<title level="3">Donation Supported Version</title>
<content>
In the past, {{ defs.app.friendly_name }} was donation supported, meaning that
the author was expecting users to donate an arbitrary amount of money if they
like and use the software.
The last version of {{ defs.app.friendly_name }} supporting this model is
`4.7.9`. This version is implemented in container image version `1.0.2`.
To revert to this version, create the container by using
`jlesage/filebot:v1.0.2` as the image name.
**NOTE**: While no license is required to use this version, it is no longer
supported and maintained by the author of {{ defs.app.friendly_name }}.
</content>
</section>
<section>
<title level="2">Automated Media Center (AMC)</title>
<content>
This container supports the {{ defs.app.friendly_name }}'s
[Automated Media Center](https://www.filebot.net/forums/viewtopic.php?t=215)
(AMC) script. This script automatically and smartly organizes movies, TV shows,
anime and music.
Basically, files copied to the `/watch` container folder are automatically
renamed and organized to the `/output` container folder.
Configuration of the AMC script is done via `AMC_*` environment variables. See
the [Environment Variables](#environment-variables) section for the list and
descriptions of environment variables that can be set.
To see what the AMC script is doing, look at the container's log.
**NOTE**: By default, the script runs in dry mode, meaning that no change is
performed. This allows you to verify that results produced by the script are
correct. Then, the `AMC_ACTION` environment variable can be updated to perform
changes to the file system.
**NOTE**: For the script to properly function, container folders `/watch` and
`/output` must be properly mapped to the host. See the
[Data Volumes](#data-volumes) section.
</content>
</section>
</documentation>
<!-- Changelog of the application. -->
<history>
<release>
<version>1.9.1</version>
<date>2020-04-25</date>
<change>Upgraded FileBot to version 4.9.1.</change>
<change>Fixed issue that would prevent renaming files.</change>
</release>
<release>
<version>1.9.0</version>
<date>2020-03-18</date>
<change>Upgraded FileBot to version 4.9.0.</change>
<change>Switched to baseimage based on Alpine 11.</change>
</release>
<release>
<version>1.8.0</version>
<date>2019-12-30</date>
<change>Custom arguments can now be passed to FileBot UI via the `FILEBOT_CUSTOM_OPTIONS` environment variable.</change>
<change>Now using baseimage v3.5.3, which brings the following changes:</change>
<change level="2">Updated installed packages to get latest security fixes.</change>
<change level="2">Make sure the tzdata is installed.</change>
</release>
<release>
<version>1.7.0</version>
<date>2019-12-08</date>
<change>Added the ability to install custom Alpine Linux packages. This allows user-defined scripts invoked by the AMC script to use tools that are normally not part of the container image.</change>
</release>
<release>
<version>1.6.0</version>
<date>2019-11-19</date>
<change>Added the ability to configure the input and output folders used by the AMC script.</change>
</release>
<release>
<version>1.5.3</version>
<date>2019-11-05</date>
<change>Fixed issue where the configured umask was not used by the AMC script.</change>
</release>
<release>
<version>1.5.2</version>
<date>2019-11-05</date>
<change>Fixed issue where the AMC script would not run under the proper user.</change>
</release>
<release>
<version>1.5.1</version>
<date>2019-11-04</date>
<change>Implemented workaround for the AMC script's artwork and nfo fetching not working without xattr support.</change>
</release>
<release>
<version>1.5.0</version>
<date>2019-10-29</date>
<change>The ability to fetch artwork and generate NFO file using the AMC script is now configurable.</change>
</release>
<release>
<version>1.4.0</version>
<date>2019-10-28</date>
<change>The match mode used by the AMC script is now configurable.</change>
</release>
<release>
<version>1.3.1</version>
<date>2019-10-24</date>
<change>The AMC script is now invoked with the `-non-strict` option.</change>
</release>
<release>
<version>1.3.0</version>
<date>2019-10-13</date>
<change>Added support for the FileBot's Automated Media Center (AMC) script.</change>
</release>
<release>
<version>1.2.4</version>
<date>2019-04-26</date>
<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.2.3</version>
<date>2019-04-03</date>
<change>Upgraded FileBot to final version 4.8.5 (r6224).</change>
</release>
<release>
<version>1.2.2</version>
<date>2019-03-26</date>
<change>Adjusted archive extraction to work with the latest FileBot build.</change>
</release>
<release>
<version>1.2.1</version>
<date>2019-03-25</date>
<change>Use 7zip for archive extraction.</change>
</release>
<release>
<version>1.2.0</version>
<date>2019-02-24</date>
<change>Upgraded FileBot to version 4.8.5.</change>
<change>Use baseimage based on Alpine Linux 3.9.</change>
</release>
<release>
<version>1.1.5</version>
<date>2019-01-07</date>
<change>The default folder when loading files is now `/storage`.</change>
</release>
<release>
<version>1.1.4</version>
<date>2018-09-18</date>
<change>Now using baseimage v3.5.1, which brings the following changes:</change>
<change level="2">Updated installed packages to get latest security fixes.</change>
</release>
<release>
<version>1.1.3</version>
<date>2018-08-29</date>
<change>Upgraded FileBot to version 4.8.4 (r5846).</change>
</release>
<release>
<version>1.1.2</version>
<date>2018-08-27</date>
<change>Upgraded FileBot to version 4.8.2 (r5789).</change>
</release>
<release>
<version>1.1.1</version>
<date>2018-07-30</date>
<change>Fixed issue where the pop-up window about FileBot requiring a license would be shown more than once.</change>
</release>
<release>
<version>1.1.0</version>
<date>2018-07-30</date>
<change>Upgraded FileBot to version 4.8.2.</change>
<change>Now using baseimage v3.4.0, which is based on Alpine Linux 3.8.</change>
</release>
<release>
<version>1.0.2</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.0.1</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.0.0</version>
<date>2018-01-31</date>
<change>Initial release.</change>
</release>
</history>
</app>
<container>
<!-- Environment variables -->
<environment_variables>
<environment_variable>
<name>OPENSUBTITLES_USERNAME</name>
<description>Username of your [OpenSubtitles](https://www.opensubtitles.org) account. Required to download subtitles.</description>
<default></default>
<unraid_template>
<title>OpenSubtitles Username</title>
<description>Username of your OpenSubtitles (https://www.opensubtitles.org) account. Required to download subtitles.</description>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>OPENSUBTITLES_PASSWORD</name>
<description>Password of your [OpenSubtitles](https://www.opensubtitles.org) account. Required to download subtitles.</description>
<default></default>
<unraid_template>
<title>OpenSubtitles Password</title>
<description>Password of your OpenSubtitles (https://www.opensubtitles.org) account. Required to download subtitles.</description>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>FILEBOT_CUSTOM_OPTIONS</name>
<description>Custom arguments to pass to FileBot. This apply to the UI only.</description>
<default></default>
<unraid_template>
<title>Custom Options</title>
<description>Custom arguments to pass to FileBot. This apply to the UI only.</description>
<display>advanced</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_INTERVAL</name>
<description>Time (in seconds) between each invocation of the Automated Media Center (AMC) script.</description>
<default>1800</default>
<unraid_template>
<title>Automated Media Center: Interval</title>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_INPUT_STABLE_TIME</name>
<description>Time (in seconds) during which properties (e.g. size, time, etc) of files in the watch folder need to remain the same before invoking the Automated Media Center (AMC) script. This is to avoid processing the watch folder while files are being copied.</description>
<default>10</default>
<unraid_template>
<title>Automated Media Center: Input Stable Time</title>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_ACTION</name>
<description>Action performed by the Automated Media Center (AMC) script on files. Valid values are `test`, `copy`, `move`, `symlink`, `hardlink`, `keeplink`, `duplicate` or `clone`. Use the `test` operation to perform a dry-run and verify that everything gets matched up correctly.</description>
<default>test</default>
<unraid_template>
<title>Automated Media Center: Action</title>
<description>Action performed by the Automated Media Center (AMC) script on files. Valid values are [b][i]test[/i][/b], [b][i]copy[/i][/b], [b][i]move[/i][/b], [b][i]symlink[/i][/b], [b][i]hardlink[/i][/b], [b][i]keeplink[/i][/b], [b][i]duplicate[/i][/b] or [b][i]clone[/i][/b]. Use the [b][i]test[/i][/b] operation to perform a dry-run and verify that everything gets matched up correctly.</description>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_CONFLICT</name>
<description>Conflict resolution strategy used by the Automated Media Center (AMC) script: `skip` never overrides existing files, while `auto` overrides existing file only if new media is better.</description>
<default>auto</default>
<unraid_template>
<title>Automated Media Center: Conflict Resolution</title>
<description>Conflict resolution strategy used by the Automated Media Center (AMC) script. When set to [b][i]skip[/i][/b], existing files are never overriden. [b][i]auto[/i][/b] overrides existing file only if new media is better.</description>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_MATCH_MODE</name>
<description>Match mode used by the Automated Media Center (AMC) script: `opportunistic` mode works for all files regardless how badly they are named, while `strict` mode works for reasonably well-named files and ignore files that cannot be matched accurately. See [Match Mode](https://www.filebot.net/forums/viewtopic.php?t=4695) for complete documentation.</description>
<default>opportunistic</default>
<unraid_template>
<title>Automated Media Center: Match Mode</title>
<description>Match mode used by the Automated Media Center (AMC) script. The [b][i]opportunistic[/i][/b] mode works for all files regardless how badly they are named, while [b][i]strict[/i][/b] mode works for reasonably well-named files and ignore files that cannot be matched accurately. See [i]https://www.filebot.net/forums/viewtopic.php?t=4695[/i] for complete documentation.</description>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_ARTWORK</name>
<description>When set to `y`, artwork is fetched and NFO file is generated by the Automated Media Center (AMC) script.</description>
<default>n</default>
<unraid_template>
<title>Automated Media Center: Artwork</title>
<description>When set to [b][i]y[/i][/b], artwork is fetched and NFO file is generated by the Automated Media Center (AMC) script.</description>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_MUSIC_FORMAT</name>
<description>Define how music files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See [Format Expressions](https://www.filebot.net/naming.html) for complete documentation.</description>
<default>{plex}</default>
<unraid_template>
<title>Automated Media Center: Music Format</title>
<description>Define how music files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See [i]https://www.filebot.net/naming.html[/i] for complete documentation.</description>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_MOVIE_FORMAT</name>
<description>Define how movie files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See [Format Expressions](https://www.filebot.net/naming.html) for complete documentation.</description>
<default>{plex}</default>
<unraid_template>
<title>Automated Media Center: Movie Format</title>
<description>Define how movie files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See [i]https://www.filebot.net/naming.html[/i] for complete documentation.</description>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_SERIES_FORMAT</name>
<description>Define how TV series files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See [Format Expressions](https://www.filebot.net/naming.html) for complete documentation.</description>
<default>{plex}</default>
<unraid_template>
<title>Automated Media Center: TV Series Format</title>
<description>Define how TV series files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See [i]https://www.filebot.net/naming.html[/i] for complete documentation.</description>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_ANIME_FORMAT</name>
<description>Define how anime files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See [Format Expressions](https://www.filebot.net/naming.html) for complete documentation.</description>
<default>{plex}</default>
<unraid_template>
<title>Automated Media Center: Anime Format</title>
<description>Define how anime files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See [i]https://www.filebot.net/naming.html[/i] for complete documentation.</description>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_PROCESS_MUSIC</name>
<description>When set to `y`, music files are processed by the Automated Media Center (AMC) script. A value of `n` does not process them.</description>
<default>y</default>
<unraid_template>
<title>Automated Media Center: Process Music</title>
<description>When set to [b][i]y[/i][/b], music files are processed by the Automated Media Center (AMC) script. A value of [b][i]n[/i][/b] does not process them.</description>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_SUBTITLE_LANG</name>
<description>Comma-separated list of subtitle languages to download. Example: `en,de,fr`.</description>
<default></default>
<unraid_template>
<title>Automated Media Center: Subtitle Languages</title>
<description>Comma-separated list of subtitle languages to download. Example: [b][i]en,de,fr[i][b].</description>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_CUSTOM_OPTIONS</name>
<description>Custom arguments to pass to the Automated Media Center (AMC) script.</description>
<default></default>
<unraid_template>
<title>Automated Media Center: Custom Options</title>
<description>Custom arguments to pass to the Automated Media Center (AMC) script.</description>
<display>advanced</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_INPUT_DIR</name>
<description>Directory inside the container used as the input folder of the Automated Media Center (AMC) script.</description>
<default>/watch</default>
<unraid_template>
<title>Automated Media Center: Input Directory</title>
<description>Directory inside the container used as the input folder of the Automated Media Center (AMC) script.</description>
<display>advanced</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_OUTPUT_DIR</name>
<description>Directory inside the container used as the output folder of the Automated Media Center (AMC) script.</description>
<default>/output</default>
<unraid_template>
<title>Automated Media Center: Output Directory</title>
<description>Directory inside the container used as the output folder of the Automated Media Center (AMC) script.</description>
<display>advanced</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</environment_variable>
<environment_variable>
<name>AMC_INSTALL_PKGS</name>
<description>Space-separated list of Alpine Linux packages to install. This is useful when the Automated Media Center (AMC) script is configured to invoke a user-defined script that requires tools not available in the container image. See https://pkgs.alpinelinux.org/packages?name=&branch=v3.9&arch=x86_64 for the list of available Alpine Linux packages.</description>
<default/>
<unraid_template>
<title>Automated Media Center: Install Packages</title>
<description>Space-separated list of Alpine Linux packages to install. This is useful when the Automated Media Center (AMC) script is configured to invoke a user-defined script that requires tools not available in the container image. 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>/watch</container_path>
<host_path_example>$HOME/FileBot/watch</host_path_example>
<description>This is the input folder of the Automated Media Center (AMC) script. Any media copied to this folder will be processed by the script. Note that there is no need to map this folder if the script is not used.</description>
<permissions>rw</permissions>
<include_in_quick_start>false</include_in_quick_start>
<unraid_template>
<title>Automated Media Center: Watch Directory</title>
<description>This is the input folder of the Automated Media Center (AMC) script. Any media copied to this folder will be processed by the script.[br]Container path: /watch</description>
<default/>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</volume>
<volume>
<container_path>/output</container_path>
<host_path_example>$HOME/media</host_path_example>
<description>This is the output folder of the Automated Media Center (AMC) script. This is where medias are located once they are renamed and organized. Note that there is no need to map this folder if the script is not used.</description>
<permissions>rw</permissions>
<include_in_quick_start>false</include_in_quick_start>
<unraid_template>
<title>Automated Media Center: Output Directory</title>
<description>This is the output folder of the Automated Media Center (AMC) script. This is where medias are located once they are renamed and organized.[br]Container path: /output</description>
<display>always</display>
<required>false</required>
<mask>false</mask>
</unraid_template>
</volume>
</volumes>
<!-- Network ports -->
<ports/>
<!-- Devices -->
<devices/>
<!-- Extra parameters -->
<extra_params/>
</container>
</defs>