Connect to Docker Container From Host Again

Docker container for HandBrake

This is a Docker container for HandBrake.

The GUI of the application is accessed through a modernistic web browser (no installation or configuration needed on the client side) or via any VNC client.

A fully automated mode is also available: drib files into a watch folder and let HandBrake process them without whatever user interaction.

---

HandBrake is a tool for converting video from nearly any format to a pick of modernistic, widely supported codecs.

---

Table of Content

• Docker container for HandBrake
  • Table of Content
  • Quick Start
  • Usage
    • Environs Variables
    • Information Volumes
    • Ports
    • Irresolute Parameters of a Running Container
  • Docker Compose File
  • Docker Image Update
    • Synology
    • unRAID
  • User/Group IDs
  • Accessing the GUI
  • Security
    • SSVNC
    • Certificates
    • VNC Countersign
  • Opposite Proxy
    • Routing Based on Hostname
    • Routing Based on URL Path
  • Trounce Access
  • Access to Optical Bulldoze(s)
  • Automatic Video Conversion
    • Multiple Watch Folders
    • Video Discs
    • Hooks
    • Temporary Conversion Directory
  • Intel Quick Sync Video
    • unRAID
  • Nightly Builds
  • Debug Builds
    • unRAID
  • Support or Contact

Quick Start

NOTE: The Docker command provided in this quick get-go is given as an example and parameters should be adjusted to your need.

Launch the HandBrake docker container with the post-obit command:

              docker run -d \     --name=handbrake \     -p 5800:5800 \     -five /docker/appdata/handbrake:/config:rw \     -v $HOME:/storage:ro \     -5 $Domicile/HandBrake/picket:/scout:rw \     -v $HOME/HandBrake/output:/output:rw \     jlesage/handbrake                          

Where:

• /docker/appdata/handbrake: This is where the application stores its configuration, log and whatever files needing persistency.
• $HOME: This location contains files from your host that need to exist attainable past the application.
• $Abode/HandBrake/spotter: This is where videos to be automatically converted are located.
• $Domicile/HandBrake/output: This is where automatically converted video files are written.

Browse to http://your-host-ip:5800 to access the HandBrake GUI. Files from the host appear under the /storage folder in the container.

Usage

              docker run [-d] \     --name=handbrake \     [-e <VARIABLE_NAME>=<VALUE>]... \     [-v <HOST_DIR>:<CONTAINER_DIR>[:PERMISSIONS]]... \     [-p <HOST_PORT>:<CONTAINER_PORT>]... \     jlesage/handbrake                          

Parameter	Description
-d	Run the container in the background. If not set, the container runs in the foreground.
-e	Pass an environment variable to the container. See the Environment Variables department for more than details.
-v	Set a book mapping (allows to share a folder/file betwixt the host and the container). See the Data Volumes section for more details.
-p	Ready a network port mapping (exposes an internal container port to the host). Run into the Ports section for more details.

Surround Variables

To customize some properties of the container, the following environs variables can exist passed via the -e parameter (ane for each variable). Value of this parameter has the format <VARIABLE_NAME>=<VALUE>.

Variable	Clarification	Default
USER_ID	ID of the user the application runs equally. Come across User/Grouping IDs to amend sympathize when this should be ready.	1000
GROUP_ID	ID of the group the application runs every bit. See User/Grouping IDs to meliorate understand when this should exist gear up.	1000
SUP_GROUP_IDS	Comma-separated listing of supplementary grouping IDs of the application.	(unset)
UMASK	Mask that controls how file permissions are set up for newly created files. The value of the mask is in octal notation. By default, this variable is not prepare and the default umask of 022 is used, pregnant that newly created files are readable by everyone, but only writable by the possessor. See the following online umask figurer: http://wintelguy.com/umask-calc.pl	(unset)
TZ	TimeZone of the container. Timezone can also be set up by mapping /etc/localtime between the host and the container.	Etc/UTC
KEEP_APP_RUNNING	When set to i, the application volition be automatically restarted if it crashes or if a user quits information technology.	0
APP_NICENESS	Priority at which the application should run. A niceness value of -20 is the highest priority and 19 is the lowest priority. Past default, niceness is not set, pregnant that the default niceness of 0 is used. NOTE: A negative niceness (priority increase) requires additional permissions. In this case, the container should be run with the docker option --cap-add together=SYS_NICE.	(unset)
CLEAN_TMP_DIR	When gear up to 1, all files in the /tmp directory are deleted during the container startup.	i
DISPLAY_WIDTH	Width (in pixels) of the awarding's window.	1280
DISPLAY_HEIGHT	Superlative (in pixels) of the application'southward window.	768
SECURE_CONNECTION	When set to 1, an encrypted connection is used to access the application's GUI (either via a web browser or VNC customer). Meet the Security department for more than details.	0
VNC_PASSWORD	Password needed to connect to the awarding'southward GUI. See the VNC Password section for more details.	(unset)
X11VNC_EXTRA_OPTS	Actress options to pass to the x11vnc server running in the Docker container. Alarm: For advanced users. Do not use unless you know what you are doing.	(unset)
ENABLE_CJK_FONT	When prepare to 1, open-source reckoner font WenQuanYi Zen Hei is installed. This font contains a big range of Chinese/Japanese/Korean characters.	0
AUTOMATED_CONVERSION_PRESET	HandBrake preset used by the automatic video converter. Identification of a preset must follow the format <CATEGORY>/<PRESET NAME>. Encounter the Automatic Video Conversion section for more details.	Full general/Very Fast 1080p30
AUTOMATED_CONVERSION_FORMAT	Video container format used by the automated video converter for output files. This is typically the video filename extension. Meet the Automatic Video Conversion section for more details.	mp4
AUTOMATED_CONVERSION_KEEP_SOURCE	When gear up to 0, a video that has been successfully converted is removed from the watch folder.	one
AUTOMATED_CONVERSION_VIDEO_FILE_EXTENSIONS	Space-separated list of file extensions to be considered equally video files. By default, this listing is empty, significant that the automatic video converter will let HandBrake automatically detects if a file, no affair its extension, is a video or not (annotation that extensions defined by the AUTOMATED_CONVERSION_NON_VIDEO_FILE_EXTENSIONS surround variable are e'er considered as non-video files). Ordinarily, this variable doesn't need to exist set. Usage of this variable is useful when merely specific video files need to converted.	(unset)
AUTOMATED_CONVERSION_NON_VIDEO_FILE_ACTION	When set to ignore, a non-video file found in the watch folder is ignored. If ready to copy, a not-video file is copied as-is to the output folder.	ignore
AUTOMATED_CONVERSION_NON_VIDEO_FILE_EXTENSIONS	Space-separated list of file extensions to be considered as not being videos. Well-nigh non-video files are properly rejected by HandBrake. However, some files, like images, are convertible by HandBrake even if they are not video files.	jpg jpeg bmp png gif txt nfo
AUTOMATED_CONVERSION_OUTPUT_DIR	Root directory where converted videos should be written.	/output
AUTOMATED_CONVERSION_OUTPUT_SUBDIR	Subdirectory of the output folder into which converted videos should exist written. By default, this variable is not set, meaning that videos are saved directly into /output/. If Home/Movies is set, converted videos will exist written to /output/Home/Movies. Apply the special value SAME_AS_SRC to use the same subfolder equally the source. For example, if the video source file is /watch/Movies/mymovie.mkv, the converted video will be written to /output/Movies/.	(unset)
AUTOMATED_CONVERSION_OVERWRITE_OUTPUT	Setting this to 1 allows the terminal destination file to exist overwritten if information technology already exists.	0
AUTOMATED_CONVERSION_SOURCE_STABLE_TIME	Fourth dimension (in seconds) during which properties (e.g. size, time, etc) of a video file in the watch folder need to remain the aforementioned. This is to avoid processing a file that is being copied.	5
AUTOMATED_CONVERSION_SOURCE_MIN_DURATION	Minimum championship duration (in seconds). Shorter titles will be ignored. This applies only to video disc sources (ISO file, VIDEO_TS folder or BDMV binder).	10
AUTOMATED_CONVERSION_CHECK_INTERVAL	Interval (in seconds) at which the automatic video converter checks for new files.	5
AUTOMATED_CONVERSION_MAX_WATCH_FOLDERS	Maximum number of watch folders handled past the automatic video converter.	5
HANDBRAKE_DEBUG	Setting this to 1 enables HandBrake debug logging for both the GUI and the automated video converter. For the latter, the increased verbosity is reflected in /config/log/hb/conversion.log (container path). For the GUI, log messages are sent to /config/log/hb/handbrake.debug.log (container path). NOTE: When enabled, a lot of data is generated and the log file will abound apace. Make certain to enable this temporarily and only when needed.	(unset)
AUTOMATED_CONVERSION_NO_GUI_PROGRESS	When set to i, progress of videos converted by the automatic video converter is non shown in the HandBrake GUI.	0
AUTOMATED_CONVERSION_HANDBRAKE_CUSTOM_ARGS	Custom arguments to pass to HandBrake when performing a conversion.	(unset)
AUTOMATED_CONVERSION_INSTALL_PKGS	Space-separated listing of Tall Linux packages to install. This is useful when the automatic video converter'due south hooks require 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.	(unset)

Data Volumes

The following tabular array describes data volumes used by the container. The mappings are set up via the -5 parameter. Each mapping is specified with the post-obit format: <HOST_DIR>:<CONTAINER_DIR>[:PERMISSIONS].

Container path	Permissions	Clarification
/config	rw	This is where the application stores its configuration, log and any files needing persistency.
/storage	ro	This location contains files from your host that need to be accessible past the application.
/watch	rw	This is where videos to be automatically converted are located.
/output	rw	This is where automatically converted video files are written.

Ports

Here is the list of ports used by the container. They tin be mapped to the host via the -p parameter (one per port mapping). Each mapping is defined in the following format: <HOST_PORT>:<CONTAINER_PORT>. The port number inside the container cannot exist changed, only you are gratuitous to apply any port on the host side.

Port	Mapping to host	Description
5800	Mandatory	Port used to admission the awarding'south GUI via the spider web interface.
5900	Optional	Port used to admission the application's GUI via the VNC protocol. Optional if no VNC client is used.

Irresolute Parameters of a Running Container

Equally can exist seen, environs variables, volume and port mappings are all specified while creating the container.

The following steps describe the method used to add, remove or update parameter(s) of an existing container. The full general idea is to destroy and re-create the container:

1. Stop the container (if it is running):

2. Remove the container:

3. Create/beginning the container using the docker run command, by adjusting parameters as needed.

NOTE: Since all awarding'southward data is saved nether the /config container folder, destroying and re-creating a container is not a problem: nix is lost and the awarding comes back with the same state (as long as the mapping of the /config folder remains the same).

Docker Etch File

Here is an instance of a docker-compose.yml file that can be used with Docker Etch.

Make sure to adjust according to your needs. Notation that only mandatory network ports are part of the case.

              version:                              '3'                            services:              handbrake:              image:              jlesage/handbrake              ports:       -                              "5800:5800"                            volumes:       -                              "/docker/appdata/handbrake:/config:rw"                            -                              "$Abode:/storage:ro"                            -                              "$HOME/HandBrake/watch:/sentinel:rw"                            -                              "$HOME/HandBrake/output:/output:rw"                          

Docker Epitome Update

Because features are added, issues are stock-still, or simply because a new version of the containerized application is integrated, the Docker image is regularly updated. Different methods can be used to update the Docker image.

The system used to run the container may have a built-in way to update containers. If so, this could be your primary manner to update Docker images.

An other way is to take the epitome be automatically updated with Watchtower. Watchtower is a container-based solution for automating Docker image updates. This is a "set up and forget" blazon of solution: once a new paradigm is available, Watchtower will seamlessly perform the necessary steps to update the container.

Finally, the Docker image can be manually updated with these steps:

1. Fetch the latest image:

              docker pull jlesage/handbrake                          

2. End the container:

3. Remove the container:

4. Create and showtime the container using the docker run control, with the the same parameters that were used when it was deployed initially.

Synology

For owners of a Synology NAS, the post-obit steps tin can be used to update a container paradigm.

1. Open the Docker awarding.
2. Click on Registry in the left pane.
3. In the search bar, type the name of the container (jlesage/handbrake).
4. Select the image, click Download and then cull the latest tag.
5. Wait for the download to complete. A notification will appear once washed.
6. Click on Container in the left pane.
7. Select your HandBrake container.
8. Stop it past clicking Activeness->Stop.
9. Clear the container by clicking Action->Reset (or Activeness->Articulate if yous don't have the latest Docker application). This removes the container while keeping its configuration.
10. Starting time the container again by clicking Action->Start. Notation: The container may temporarily disappear from the listing while information technology is re-created.

unRAID

For unRAID, a container image can exist updated past following these steps:

1. Select the Docker tab.
2. Click the Check for Updates push button at the bottom of the folio.
3. Click the update ready link of the container to be updated.

User/Grouping IDs

When using data volumes (-v flags), permissions problems can occur betwixt the host and the container. For example, the user within the container may not exist on the host. This could prevent the host from properly accessing files and folders on the shared volume.

To avoid any trouble, y'all can specify the user the awarding should run as.

This is done by passing the user ID and group ID to the container via the USER_ID and GROUP_ID environs variables.

To discover the right IDs to employ, consequence the following control on the host, with the user owning the data volume on the host:

Which gives an output like this one:

              uid=yard(myuser) gid=m(myuser) groups=1000(myuser),four(adm),24(cdrom),27(sudo),46(plugdev),113(lpadmin)                          

The value of uid (user ID) and gid (group ID) are the ones that you should exist given the container.

Accessing the GUI

Assuming that container's ports are mapped to the same host'southward ports, the graphical interface of the application can exist accessed via:

• A web browser:

              http://<HOST IP ADDR>:5800                          

• Any VNC client:

Security

By default, access to the application's GUI is done over an unencrypted connection (HTTP or VNC).

Secure connection tin can be enabled via the SECURE_CONNECTION environment variable. Run into the Environment Variables section for more details on how to ready an environment variable.

When enabled, application's GUI is performed over an HTTPs connexion when accessed with a browser. All HTTP accesses are automatically redirected to HTTPs.

When using a VNC client, the VNC connection is performed over SSL. Annotation that few VNC clients support this method. SSVNC is one of them.

SSVNC

SSVNC is a VNC viewer that adds encryption security to VNC connections.

While the Linux version of SSVNC works well, the Windows version has some bug. At the time of writing, the latest version one.0.30 is non functional, as a connection fails with the following error:

              ReadExact: Socket error while reading                          

Yet, for your convenience, an unofficial and working version is provided here:

https://github.com/jlesage/docker-baseimage-gui/raw/master/tools/ssvnc_windows_only-1.0.30-r1.zip

The only difference with the official package is that the arranged version of stunnel has been upgraded to version 5.49, which fixes the connectedness issues.

Certificates

Here are the certificate files needed by the container. Past default, when they are missing, cocky-signed certificates are generated and used. All files accept PEM encoded, x509 certificates.

Container Path	Purpose	Content
/config/certs/vnc-server.pem	VNC connectedness encryption.	VNC server's private key and certificate, bundled with any root and intermediate certificates.
/config/certs/web-privkey.pem	HTTPs connection encryption.	Web server'south private key.
/config/certs/spider web-fullchain.pem	HTTPs connexion encryption.	Web server's certificate, bundled with any root and intermediate certificates.

NOTE: To forestall any document validity warnings/errors from the browser or VNC client, make sure to supply your ain valid certificates.

Note: Certificate files are monitored and relevant daemons are automatically restarted when changes are detected.

VNC Countersign

To restrict access to your awarding, a password can be specified. This tin exist washed via two methods:

• Past using the VNC_PASSWORD environment variable.
• By creating a .vncpass_clear file at the root of the /config volume. This file should contain the password in clear-text. During the container startup, content of the file is obfuscated and moved to .vncpass.

The level of security provided by the VNC password depends on two things:

• The type of advice aqueduct (encrypted/unencrypted).
• How secure the access to the host is.

When using a VNC countersign, it is highly desirable to enable the secure connection to prevent sending the countersign in clear over an unencrypted channel.

Attending: Password is limited to viii characters. This limitation comes from the Remote Framebuffer Protocol RFC (see department seven.2.ii). Whatever characters beyond the limit are ignored.

Contrary Proxy

The following sections contain NGINX configurations that need to be added in order to reverse proxy to this container.

A opposite proxy server can route HTTP requests based on the hostname or the URL path.

Routing Based on Hostname

In this scenario, each hostname is routed to a different application/container.

For example, permit's say the reverse proxy server is running on the same car as this container. The server would proxy all HTTP requests sent to handbrake.domain.tld to the container at 127.0.0.1:5800.

Here are the relevant configuration elements that would be added to the NGINX configuration:

              map $http_upgrade $connection_upgrade { 	default upgrade; 	''      close; }  upstream docker-handbrake { 	# If the reverse proxy server is not running on the aforementioned automobile as the 	# Docker container, use the IP of the Docker host hither. 	# Make sure to adjust the port according to how port 5800 of the 	# container has been mapped on the host. 	server 127.0.0.1:5800; }  server { 	[...]  	server_name handbrake.domain.tld;  	location / { 	        proxy_pass http://docker-handbrake; 	}  	location /websockify { 		proxy_pass http://docker-handbrake; 		proxy_http_version 1.1; 		proxy_set_header Upgrade $http_upgrade; 		proxy_set_header Connection $connection_upgrade; 		proxy_read_timeout 86400; 	} }                          

Routing Based on URL Path

In this scenario, the hostname is the same, but dissimilar URL paths are used to route to different applications/containers.

For example, let's say the reverse proxy server is running on the aforementioned machine equally this container. The server would proxy all HTTP requests for server.domain.tld/handbrake to the container at 127.0.0.1:5800.

Here are the relevant configuration elements that would be added to the NGINX configuration:

              map $http_upgrade $connection_upgrade { 	default upgrade; 	''      close; }  upstream docker-handbrake { 	# If the contrary proxy server is not running on the same motorcar as the 	# Docker container, utilize the IP of the Docker host hither. 	# Make sure to adjust the port co-ordinate to how port 5800 of the 	# container has been mapped on the host. 	server 127.0.0.i:5800; }  server { 	[...]  	location = /handbrake {render 301 $scheme://$http_host/handbrake/;} 	location /handbrake/ { 		proxy_pass http://docker-handbrake/; 		location /handbrake/websockify { 			proxy_pass http://docker-handbrake/websockify/; 			proxy_http_version 1.ane; 			proxy_set_header Upgrade $http_upgrade; 			proxy_set_header Connection $connection_upgrade; 			proxy_read_timeout 86400; 		} 	} }                          

Shell Access

To get shell access to the running container, execute the post-obit control:

              docker exec -ti CONTAINER sh                          

Where CONTAINER is the ID or the proper noun of the container used during its cosmos (e.k. crashplan-pro).

Access to Optical Drive(south)

By default, a Docker container doesn't have access to host's devices. However, access to one or more than device can be granted with the --device DEV parameter.

Optical drives commonly have /dev/srX every bit device. For instance, the offset bulldoze is /dev/sr0, the 2d /dev/sr1, so on. To allow HandBrake to access the start drive, this parameter is needed:

To easily find devices of optical drives, start the container and look at its log for messages similar to these ones:

              ... [cont-init.d] 95-check-optical-drive.sh: executing... [cont-init.d] 95-check-optical-bulldoze.sh: looking for usable optical drives... [cont-init.d] 95-check-optical-drive.sh: plant optical drive /dev/sr0, only it is non usable considering is non exposed to the container. [cont-init.d] 95-cheque-optical-drive.sh: no usable optical drive found. [cont-init.d] 95-check-optical-drive.sh: exited 0. ...                          

Since HandBrake can decrypt DVD video discs, their conversion can exist performed direct from the optical device. From the graphical interface, click the Open Source push button and browse through the file organization to find your optical drive device (east.g. /dev/sr0).

Automatic Video Conversion

This container has an automated video converter congenital-in. This is useful to batch-convert videos without user interaction.

Basically, files copied to the /watch container binder are automatically converted past HandBrake to a pre-divers video format according to a pre-defined preset. Both the format and the preset are specified via surroundings variables:

Variable	Default
AUTOMATED_CONVERSION_PRESET	"Full general/Very Fast 1080p30"
AUTOMATED_CONVERSION_FORMAT	"mp4"

See the Environment Variables section for details virtually setting environment variables.

Annotation: A preset is identified by its category and its name.

NOTE: All default presets, along with personalized/custom ones, tin be seen with the HandBrake GUI.

Notation: Converted videos are stored, by default, to the /output folder of the container.

NOTE: The status and progression of conversions performed past the automated video converter can be seen from both the GUI and the container'southward log. Container's log tin can exist obtained past executing the command docker logs handbrake, where handbrake is the name of the container. Also, total details near the conversion are stored in /config/log/hb/conversion.log (container path).

Multiple Watch Folders

If needed, up to iv additionnal sentry folders tin can be used:

• /watch2
• /watch3
• /watch4
• /watch5

This is useful in scenarios where videos need to be converted by dissimilar presets. For example, one could use a watch folder for movies and some other watch folder for TV shows, both having dissimilar encoding quality requirements.

Past default, boosted watch folders inherits the same settings has the main 1 (/sentry). A setting for a particular watch folder tin be overrided past adding its alphabetize to the corresponding environment variable proper name.

For example, to set the HandBrake preset used to catechumen videos in /watch2, the environment variable AUTOMATED_CONVERSION_PRESET_2 is used. AUTOMATED_CONVERSION_PRESET_3 is used for /watch3, so on.

All settings related to the automatic video converter can exist overrided for each additional scout folder:

• AUTOMATED_CONVERSION_PRESET
• AUTOMATED_CONVERSION_FORMAT
• AUTOMATED_CONVERSION_SOURCE_STABLE_TIME
• AUTOMATED_CONVERSION_SOURCE_MIN_DURATION
• AUTOMATED_CONVERSION_OUTPUT_DIR
• AUTOMATED_CONVERSION_OUTPUT_SUBDIR
• AUTOMATED_CONVERSION_OVERWRITE_OUTPUT
• AUTOMATED_CONVERSION_KEEP_SOURCE
• AUTOMATED_CONVERSION_VIDEO_FILE_EXTENSIONS
• AUTOMATED_CONVERSION_NON_VIDEO_FILE_ACTION
• AUTOMATED_CONVERSION_NON_VIDEO_FILE_EXTENSIONS

Video Discs

The automatic video converter supports video discs, in the following format:

• ISO image file.
• DVD video disc binder containing the VIDEO_TS folder.
• Blu-ray video disc folder containing the BDMV folder.

Notation that folder names are case sensitive. For example, video_ts, Video_Ts or Bdmv won't be treated as discs, but as normal directories.

When the source is a disc folder, the name of the converted video file will friction match to i of its folder. For example, /sentry/MyMovie/VIDEO_TS volition produce a video file with proper noun MyMovie.mp4.

Video discs tin have multiple titles (the chief movie, previews, extras, etc). In a such case, each title is converted to its own file. These files have the suffix .title-XX, where Twenty is the title number. For example, if the file MyMovie.iso has 2 titles, the post-obit files would be generated:

• MyMovie.title-1.mp4
• MyMovie.title-2.mp4

It is possible to ignore titles shorted than a specific amount of time. Past default, only titles longer than 10 seconds are processed. This duration tin be adjusted via the AUTOMATED_CONVERSION_SOURCE_MIN_DURATION environs variable. See the Environment Variables department for details nigh setting environment variables.

Hooks

Custom actions can be performed using hooks. Hooks are beat scripts executed by the automatic video converter.

Note: Hooks are always invoked via /bin/sh, ignoring any shebang the script may take.

Hooks are optional and by default, no i is defined. A hook is defined and executed when the script is found at a specific location.

The following table describe available hooks:

Container location	Description	Parameter(s)
/config/hooks/pre_conversion.sh	Hook executed before the beginning of a video conversion.	The first argument is the path of the converted video. The second argument is the path to the source file. Finally, the third argument is the proper name of the Handbrake preset that will exist used to convert the video.
/config/hooks/post_conversion.sh	Hook executed when the conversion of a video file is terminated.	The commencement parameter is the status of the conversion. A value of 0 indicates that the conversion terminated successfuly. Any other value represent a failure. The second argument is the path to the converted video (the output). The tertiary statement is the path to the source file. Finally, the fourth statement is the name of the Handbrake preset used to convert the video.
/config/post_watch_folder_processing.sh	Hook executed subsequently all videos in the watch folder have been processed.	The path of the watch folder.

During the start beginning of the container, instance hooks are installed in /config/hooks/. Example scripts have the suffix .example. For example, you tin can employ /config/hooks/post_conversion.sh.example as a starting point.

NOTE: Keep in mind that this container has the minimal set of packages required to run HandBrake. This may limit actions that tin be performed in hooks.

Temporary Conversion Directory

A video existence converted is written in a subconscious, temporary directory under the root of the output directory (/output by default). Once a conversion successfully terminates, the video file is moved to its concluding location.

This feature can be useful for scenarios where the output folder is monitored past another application: with proper configuration, one tin can brand sure this application only "sees" the concluding, converted video file and not the transient versions.

If the monitoring awarding ignores subconscious directories, then nothing special is required and the application should always see the final file.

However, if the monitoring application handles hidden directories, the automatic video converter should be configured with the AUTOMATED_CONVERSION_OUTPUT_SUBDIR environment variable sets to a subdirectory. The application can so be configured to monitor this subdirectory. For example, if AUTOMATED_CONVERSION_OUTPUT_SUBDIR is set to Television receiver Shows and /output is mapped to $Abode/appvolumes/HandBrake on the host, $Home/appvolumes/HandBrake/TV Shows should be monitored past the application.

Intel Quick Sync Video

Intel Quick Sync Video is Intel's brand for its dedicated video encoding and decoding hardware core. Information technology is a engineering that is capable of offloading video decoding and encoding job to the integrated GPU, thus saving the CPU usage to do other tasks. As a specialized hardware cadre on the processor die, Quick Sync offers a much more than power efficient video processing which is much superior to video encoding on a CPU.

For HandBrake to exist able to apply hardware-accelerated encoding, the following are required:

• Accept a compatible Intel processor. To determine if your CPU has the Quick Sync Video hardware, consult this list from the Intel Ark website. The model name of your processor is printed to the container's log during its startup. Look for a message like this:

                    [cont-init.d] 95-check-qsv.sh: Processor: Intel(R) Core(TM) i7-2600 CPU @ 3.40GHz                                  

• The Intel i915 graphic commuter must be loaded on the host.
• The /dev/dri device must be exposed to the container. This is done by adding the --device /dev/dri parameter to the docker run command.

When Intel Quick Sync Video is properly enabled, HandBrake offers the post-obit video encoder:

If this encoder is non part of the list, something is wrong and looking at the container's log can give more details virtually the issue.

NOTE: In virtually cases, HandBrake tin successfully access the /dev/dri device without irresolute anything on the host side. This is possible because the user under which the container is running is automatically added to the group owning the /dev/dri device. However, this method doesn't work if the device is owned by the group root. The problem can be stock-still using one of the post-obit methods:

• Running the container as root (USER_ID=0).
• Adding, on the host, read/write permissions for all to the /dev/dri device:

                    sudo chmod a+wr /dev/dri/*                                  

• Irresolute, on the host, the group owning the /dev/dri device. For example, to change the group to video:

                    sudo chown root:video /dev/dri/*                                  

unRAID

The Intel i915 commuter is already included in unRAID. To automatically load the driver during the startup of the host, the post-obit lines must exist added to /boot/config/go:

              # Load the i915 driver. modprobe i915                          

Nightly Builds

HandBrake nightly builds are based on the latest development code, which ways they may or may not exist stable.

The latest evolution version is bachelor past using the dev-latest Docker epitome tag. For other specific development versions, look at available tags on Docker Hub.

When creating the container, the tag needs to be appended to the proper noun of the Docker image, like this:

              docker run [OPTIONS..] jlesage/handbrake:dev-latest                          

Debug Builds

Debug builds can exist used to better investigate bug that can occur with HandBrake. These builds have HandBrake compiled in debug mode and all symbols are kept.

The main apply case of debug builds is debugging a crash. To practice this, a core dump needs to be generated when HandBrake crashes. To make sure this core dump is properly generated, two things are required:

1. Cadre dumps must exist enabled. This is done past setting the maximum size of cores via the --ulimit core=-i parameter of the docker run command. A value of -1 mean "unlimited".

2. Location of the cores must be set. This can be done by executing the following command on the host:

                     repeat 'CORE_PATTERN' | sudo tee /proc/sys/kernel/core_pattern                                  

   Where CORE_PATTERN is the template that defines the naming of core dump files. For example, to set the files in the configuration volume of the container (for easy retrieval from the host), utilize the pattern /config/cadre.%e.%t.

   NOTE: Because a core file contains the complete memory layout of an awarding, it is created with restrictive permissions. If another user other than the one used to run HandBrake needs to admission the core file, permissions must exist changed by executing chmod a+r Core, where Core is the path to the cadre file.

   Notation: Since the cadre dump files pattern is shared between the host and the container, you may want to revert to the original blueprint one time done.

   NOTE: The current value of the pattern can be obtained by executing cat /proc/sys/kernel/core_pattern.

Debug builds are available by using Docker paradigm tags with the debug suffix. Make certain to look at available tags on Docker Hub.

When creating the container, the tag needs to be appended to the proper name of the Docker paradigm, like this:

              docker run [OPTIONS..] jlesage/handbrake:v1.fourteen.3-debug                          

unRAID

On systems running unRAID, the --ulimit core=-ane parameter can be added to the Actress Parameters field of the container settings.

Support or Contact

Having troubles with the container or accept questions? Delight create a new consequence.

For other corking Dockerized applications, run across https://jlesage.github.io/docker-apps.

slackperen1998.blogspot.com

Source: https://github.com/jlesage/docker-handbrake

Share this post