AppFeed/templates/dee31797sRepository/UnRaid/template/handbrake.xml
2021-02-23 15:49:21 -05:00

209 lines
15 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<Container version="2">
<Name>HandBrake</Name>
<Repository>djaydev/handbrake</Repository>
<Registry>https://hub.docker.com/r/djaydev/handbrake/</Registry>
<Network>bridge</Network>
<Privileged>false</Privileged>
<Support>https://forums.unraid.net/topic/77603-virt-manager-intel-gpu-tools-and-more-dockers/</Support>
<Overview>
Handbrake with Nvidia NVENC access. Requires compatible GPU and Nvidia Unraid plugin installed. No QuickSync support.
[br][br]
HandBrake is a tool for converting video from nearly any format to a selection of modern, widely supported codecs.
[br][br]
The GUI of the application is accessed through a modern web browser (no installation or configuration needed on client side) or via any VNC client.
A fully automated mode is also available: drop files into a watch folder and let HandBrake process them without any user interaction.
[br][br][span][/span]
For a complete documentation of this container, see
[a href="https://github.com/jlesage/docker-handbrake/blob/master/README.md"]
https://github.com/jlesage/docker-handbrake/blob/master/README.md[/a].
[br][br]
[span style='color: red;'][b]NOTE:[/b][/span] For the container to have
access to your optical drive(s), you need to allow access to the proper
device (usually [b][i]/dev/sr0[/i][/b]) by adding the parameter
[b][i]--device DEV[/i][/b] in the [i]Extra Parameters[/i] field (shown when
[i]Advanced View[/i] is enabled). For example, if your optical drive is at
[b][i]/dev/sr0[/i][/b], you need to add [b][i]--device /dev/sr0[/i][/b].
</Overview>
<WebUI>http://[IP]:[PORT:5800]</WebUI>
<TemplateURL>https://raw.githubusercontent.com/djaydev/docker-virt-manager/master/UnRaid/template/handbrake.xml</TemplateURL>
<Icon>https://raw.githubusercontent.com/jlesage/docker-templates/master/jlesage/images/handbrake-icon.png</Icon>
<ExtraParams>--runtime=nvidia</ExtraParams>
<Project>https://handbrake.fr/</Project>
<Date>1556942400</Date>
<Networking>
<Mode>bridge</Mode>
<Publish>
<Port>
<HostPort>7803</HostPort>
<ContainerPort>5800</ContainerPort>
<Protocol>tcp</Protocol>
</Port>
<Port>
<HostPort>7903</HostPort>
<ContainerPort>5900</ContainerPort>
<Protocol>tcp</Protocol>
</Port>
</Publish>
</Networking>
<Data>
<Volume>
<HostDir>/mnt/user/appdata/handbrake</HostDir>
<ContainerDir>/config</ContainerDir>
<Mode>rw</Mode>
</Volume>
<Volume>
<HostDir>/mnt/user</HostDir>
<ContainerDir>/storage</ContainerDir>
<Mode>ro</Mode>
</Volume>
<Volume>
<HostDir></HostDir>
<ContainerDir>/watch</ContainerDir>
<Mode>rw</Mode>
</Volume>
<Volume>
<HostDir></HostDir>
<ContainerDir>/output</ContainerDir>
<Mode>rw</Mode>
</Volume>
</Data>
<Environment>
<Variable>
<Value>all</Value>
<Name>NVIDIA_DRIVER_CAPABILITIES</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>GPU-XXXX-XXXX-XXXX-XXXX-XXXX</Value>
<Name>NVIDIA_VISIBLE_DEVICES</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>99</Value>
<Name>USER_ID</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>100</Value>
<Name>GROUP_ID</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>000</Value>
<Name>UMASK</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>APP_NICENESS</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>1280</Value>
<Name>DISPLAY_WIDTH</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>768</Value>
<Name>DISPLAY_HEIGHT</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>0</Value>
<Name>SECURE_CONNECTION</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>X11VNC_EXTRA_OPTS</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>Very Fast 1080p30</Value>
<Name>AUTOMATED_CONVERSION_PRESET</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>mp4</Value>
<Name>AUTOMATED_CONVERSION_FORMAT</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>1</Value>
<Name>AUTOMATED_CONVERSION_KEEP_SOURCE</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>/output</Value>
<Name>AUTOMATED_CONVERSION_OUTPUT_DIR</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>AUTOMATED_CONVERSION_OUTPUT_SUBDIR</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>5</Value>
<Name>AUTOMATED_CONVERSION_SOURCE_STABLE_TIME</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>10</Value>
<Name>AUTOMATED_CONVERSION_SOURCE_MIN_DURATION</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>5</Value>
<Name>AUTOMATED_CONVERSION_CHECK_INTERVAL</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>5</Value>
<Name>AUTOMATED_CONVERSION_MAX_WATCH_FOLDERS</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>0</Value>
<Name>AUTOMATED_CONVERSION_NO_GUI_PROGRESS</Name>
<Mode></Mode>
</Variable>
</Environment>
<Config Name="Config Directory" Target="/config" Default="/mnt/user/appdata/handbrake" Mode="rw" Description="This is where the application stores its configuration, log and any files needing persistency.&amp;lt;br&amp;gt;Container path: /config" Type="Path" Display="advanced-hide" Required="true" Mask="false"></Config>
<Config Name="Storage" Target="/storage" Default="/mnt/user" Mode="ro" Description="This location contains files from your host that need to be accessible by the application.&amp;lt;br&amp;gt;Container path: /storage" Type="Path" Display="always-hide" Required="true" Mask="false"></Config>
<Config Name="Watch Directory" Target="/watch" Default="" Mode="rw" Description="This is the watch folder of the automatic video converter. Any video copied into this folder will be automatically converted by HandBrake.&amp;lt;br&amp;gt;Container path: /watch" Type="Path" Display="always" Required="false" Mask="false"></Config>
<Config Name="Output Directory" Target="/output" Default="" Mode="rw" Description="This is the default output folder for converted videos. Also used by the automatic video converter.&amp;lt;br&amp;gt;Container path: /output" Type="Path" Display="always" Required="true" Mask="false"></Config>
<Config Name="User ID" Target="USER_ID" Default="99" Mode="" Description="ID of the user the application runs as." Type="Variable" Display="advanced-hide" Required="true" Mask="false"></Config>
<Config Name="Group ID" Target="GROUP_ID" Default="100" Mode="" Description="ID of the group the application runs as." Type="Variable" Display="advanced-hide" Required="true" Mask="false"></Config>
<Config Name="Umask" Target="UMASK" Default="000" Mode="" Description="Mask that controls how file permissions are set for newly created files. The value of the mask is in octal notation." Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Config Name="Niceness (priority)" Target="APP_NICENESS" Default="" Mode="" Description="Priority at which the application should run. A niceness value of -20 is the highest priority and 19 is the lowest priority.&amp;lt;br&amp;gt;&amp;lt;b&amp;gt;NOTE:&amp;lt;/b&amp;gt; Setting a negative value requires additional permissions. Thus, &amp;lt;i&amp;gt;&amp;lt;b&amp;gt;--cap-add=SYS_NICE&amp;lt;/b&amp;gt;&amp;lt;/i&amp;gt; must be added in &amp;lt;i&amp;gt;Extra Parameters&amp;lt;/i&amp;gt; (shown when &amp;lt;i&amp;gt;Advanced View&amp;lt;/i&amp;gt; is enabled)." Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Config Name="Display Width" Target="DISPLAY_WIDTH" Default="1280" Mode="" Description="Width (in pixels) of the application's window." Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Config Name="Display Height" Target="DISPLAY_HEIGHT" Default="768" Mode="" Description="Height (in pixels) of the application's window." Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Config Name="Secure Connection" Target="SECURE_CONNECTION" Default="0" Mode="" Description="Whether or not an encrypted connection should be used to access the application's GUI. Set to &amp;lt;i&amp;gt;&amp;lt;b&amp;gt;1&amp;lt;/b&amp;gt;&amp;lt;/i&amp;gt; to encrypt the connection.&amp;lt;br&amp;gt;&amp;lt;span style='color: red;'&amp;gt;&amp;lt;b&amp;gt;Note:&amp;lt;/b&amp;gt;&amp;lt;/span&amp;gt; When enabling the secure connection, security parameters needs to be generated. This &amp;lt;b&amp;gt;one-time&amp;lt;/b&amp;gt; operation is done during container startup. Depending on your system, this could take a few minutes. GUI of the application won't be available until the operation completes." Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Config Name="Extra x11vnc Options" Target="X11VNC_EXTRA_OPTS" Default="" Mode="" Description="Extra options to pass to the x11vnc server running in the Docker container.&amp;lt;br&amp;gt;&amp;lt;span style='color: red;'&amp;gt;&amp;lt;b&amp;gt;Warning:&amp;lt;/b&amp;gt;&amp;lt;/span&amp;gt; For advanced users. Do not use unless you know what you are doing." Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Config Name="Host Key 6" Target="NVIDIA_DRIVER_CAPABILITIES" Default="" Mode="" Description="Container Variable: NVIDIA_DRIVER_CAPABILITIES" Type="Variable" Display="always" Required="false" Mask="false">all</Config>
<Config Name="Host Key 7" Target="NVIDIA_VISIBLE_DEVICES" Default="" Mode="" Description="GPU UUID retrieved from Nvidia plugin settings" Type="Variable" Display="always" Required="false" Mask="false">GPU-XXXX-XXXX-XXXX-XXXX-XXXX</Config>
<Config Name="Automatic Video Converter: Preset" Target="AUTOMATED_CONVERSION_PRESET" Default="Very Fast 1080p30" Mode="" Description="Preset used by the automatic video converter. Name of all available presets can be seen via the HandBrake GUI." Type="Variable" Display="always" Required="false" Mask="false"></Config>
<Config Name="Automatic Video Converter: Format" Target="AUTOMATED_CONVERSION_FORMAT" Default="mp4" Mode="" Description="Video container format used by the automatic video converter for output files. This is typically the video filename extension." Type="Variable" Display="always" Required="false" Mask="false"></Config>
<Config Name="Automatic Video Converter: Keep Source Files" Target="AUTOMATED_CONVERSION_KEEP_SOURCE" Default="1" Mode="" Description="Set to 0 to remove successfully converted videos from the watch folder, 1 to keep them." Type="Variable" Display="always" Required="false" Mask="false"></Config>
<Config Name="Automatic Video Converter: Output directory" Target="AUTOMATED_CONVERSION_OUTPUT_DIR" Default="/output" Mode="" Description="Root directory where converted videos should be written." Type="Variable" Display="always" Required="false" Mask="false"></Config>
<Config Name="Automatic Video Converter: Output Subdirectory" Target="AUTOMATED_CONVERSION_OUTPUT_SUBDIR" Default="" Mode="" Description="Subdirectory of the output folder into which converted videos should be written.&amp;lt;ul&amp;gt;&amp;lt;li&amp;gt;Leave value empty to save converted videos directly into &amp;lt;b&amp;gt;&amp;lt;i&amp;gt;/output/&amp;lt;/i&amp;gt;&amp;lt;/b&amp;gt;.&amp;lt;/li&amp;gt;&amp;lt;li&amp;gt;Use the special value &amp;lt;b&amp;gt;&amp;lt;i&amp;gt;SAME_AS_SRC&amp;lt;/i&amp;gt;&amp;lt;/b&amp;gt; to use the same subfolder as the source. For example, if the video source file is &amp;lt;b&amp;gt;&amp;lt;i&amp;gt;/watch/Movies/mymovie.mkv&amp;lt;/i&amp;gt;&amp;lt;/b&amp;gt;, the converted video will be written to &amp;lt;b&amp;gt;&amp;lt;i&amp;gt;/output/Movies/&amp;lt;/i&amp;gt;&amp;lt;/b&amp;gt;.&amp;lt;/li&amp;gt;&amp;lt;li&amp;gt;Use any subfolder name. For example, setting the value &amp;lt;b&amp;gt;&amp;lt;i&amp;gt;Home/Movies&amp;lt;/i&amp;gt;&amp;lt;/b&amp;gt; will make converted videos written to &amp;lt;b&amp;gt;&amp;lt;i&amp;gt;/output/Home/Movies&amp;lt;/i&amp;gt;&amp;lt;/b&amp;gt;/&amp;lt;/li&amp;gt;&amp;lt;/ul&amp;gt;" Type="Variable" Display="always" Required="false" Mask="false"></Config>
<Config Name="Automatic Video Converter: Source File Stable Time" Target="AUTOMATED_CONVERSION_SOURCE_STABLE_TIME" Default="5" Mode="" Description="Time (in seconds) during which properties (e.g. size, time, etc) of a video file in the watch folder need to remain the same. This is to avoid processing a file that is being copied." Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Config Name="Automatic Video Converter: Minimum Title Duration" Target="AUTOMATED_CONVERSION_SOURCE_MIN_DURATION" Default="10" Mode="" Description="Minimum title duration (in seconds). Shorter titles will be ignored. This applies only to video disc sources (ISO file, &amp;lt;i&amp;gt;VIDEO_TS&amp;lt;/i&amp;gt; folder or &amp;lt;i&amp;gt;BDMV&amp;lt;/i&amp;gt; folder)." Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Config Name="Automatic Video Converter: Check Interval" Target="AUTOMATED_CONVERSION_CHECK_INTERVAL" Default="5" Mode="" Description="Interval (in seconds) at which the automatic video converter checks for new files." Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Config Name="Automatic Video Converter: Number of Watch Folders" Target="AUTOMATED_CONVERSION_MAX_WATCH_FOLDERS" Default="5" Mode="" Description="Maximum number of watch folders handled by the automatic video converter." Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Config Name="Automatic Video Converter: Disable Progress in GUI" Target="AUTOMATED_CONVERSION_NO_GUI_PROGRESS" Default="0" Mode="" Description="Set to 1 to disable display of the video conversion progress in HandBrake GUI." Type="Variable" Display="advanced" Required="false" Mask="false"></Config>
<Config Name="WEB Port for GUI" Target="5800" Default="7803" Mode="tcp" Description="Port used to access the application's GUI via the web interface." Type="Port" Display="advanced-hide" Required="true" Mask="false"></Config>
<Config Name="VNC Port for GUI" Target="5900" Default="7903" Mode="tcp" Description="Port used to access the application's GUI via the VNC protocol. Optional if no VNC client is used." Type="Port" Display="advanced-hide" Required="false" Mask="false"></Config>
<DonateLink>https://www.paypal.me/djaydev/0usd</DonateLink>
<DonateImg>https://www.paypal.com/en_US/i/btn/btn_donate_SM.gif</DonateImg>
<Description>Handbrake with Nvidia NVENC access. Requires compatible GPU and Nvidia Unraid plugin installed. No QuickSync support.
HandBrake is a tool for converting video from nearly any format to a selection of modern, widely supported codecs.
The GUI of the application is accessed through a modern web browser (no installation or configuration needed on client side) or via any VNC client.
A fully automated mode is also available: drop files into a watch folder and let HandBrake process them without any user interaction.</Description>
<templatePath>/tmp/GitHub/AppFeed/templates/dee31797sRepository/UnRaid/template/handbrake.xml</templatePath>
</Container>