diff --git a/DOCKERHUB.md b/DOCKERHUB.md index d540da7..0789edf 100644 --- a/DOCKERHUB.md +++ b/DOCKERHUB.md @@ -3,7 +3,7 @@ This is a Docker container for [HandBrake](https://handbrake.fr/). -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. +The GUI of the application is accessed through a modern web browser (no installation or configuration needed on the 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. diff --git a/README.md b/README.md index 3bf458a..941c07e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ This is a Docker container for [HandBrake](https://handbrake.fr/). -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. +The GUI of the application is accessed through a modern web browser (no installation or configuration needed on the 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. @@ -90,7 +90,7 @@ docker run [-d] \ ``` | Parameter | Description | |-----------|-------------| -| -d | Run the container in background. If not set, the container runs in foreground. | +| -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](#environment-variables) section for more details. | | -v | Set a volume mapping (allows to share a folder/file between the host and the container). See the [Data Volumes](#data-volumes) section for more details. | | -p | Set a network port mapping (exposes an internal container port to the host). See the [Ports](#ports) section for more details. | @@ -108,15 +108,15 @@ of this parameter has the format `=`. |`SUP_GROUP_IDS`| Comma-separated list of supplementary group IDs of the application. | (unset) | |`UMASK`| Mask that controls how file permissions are set for newly created files. The value of the mask is in octal notation. By default, this variable is not set and the default umask of `022` is used, meaning that newly created files are readable by everyone, but only writable by the owner. See the following online umask calculator: http://wintelguy.com/umask-calc.pl | (unset) | |`TZ`| [TimeZone] of the container. Timezone can also be set by mapping `/etc/localtime` between the host and the container. | `Etc/UTC` | -|`KEEP_APP_RUNNING`| When set to `1`, the application will be automatically restarted if it crashes or if user quits it. | `0` | +|`KEEP_APP_RUNNING`| When set to `1`, the application will be automatically restarted if it crashes or if a user quits it. | `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. By default, niceness is not set, meaning 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=SYS_NICE`. | (unset) | -|`CLEAN_TMP_DIR`| When set to `1`, all files in the `/tmp` directory are delete during the container startup. | `1` | +|`CLEAN_TMP_DIR`| When set to `1`, all files in the `/tmp` directory are deleted during the container startup. | `1` | |`DISPLAY_WIDTH`| Width (in pixels) of the application's window. | `1280` | |`DISPLAY_HEIGHT`| Height (in pixels) of the application's window. | `768` | -|`SECURE_CONNECTION`| When set to `1`, an encrypted connection is used to access the application's GUI (either via web browser or VNC client). See the [Security](#security) section for more details. | `0` | +|`SECURE_CONNECTION`| When set to `1`, an encrypted connection is used to access the application's GUI (either via a web browser or VNC client). See the [Security](#security) section for more details. | `0` | |`VNC_PASSWORD`| Password needed to connect to the application's GUI. See the [VNC Password](#vnc-password) section for more details. | (unset) | |`X11VNC_EXTRA_OPTS`| Extra options to pass to the x11vnc server running in the Docker container. **WARNING**: For advanced users. Do not use unless you know what you are doing. | (unset) | -|`ENABLE_CJK_FONT`| When set to `1`, open source computer font `WenQuanYi Zen Hei` is installed. This font contains a large range of Chinese/Japanese/Korean characters. | `0` | +|`ENABLE_CJK_FONT`| When set to `1`, open-source computer font `WenQuanYi Zen Hei` is installed. This font contains a large 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 `/`. See the [Automatic Video Conversion](#automatic-video-conversion) section for more details. | `General/Very Fast 1080p30` | |`AUTOMATED_CONVERSION_FORMAT`| Video container format used by the automatic video converter for output files. This is typically the video filename extension. See the [Automatic Video Conversion](#automatic-video-conversion) section for more details. | `mp4` | |`AUTOMATED_CONVERSION_KEEP_SOURCE`| When set to `0`, a video that has been successfully converted is removed from the watch folder. | `1` | @@ -227,7 +227,7 @@ docker rm handbrake ### Synology -For owners of a Synology NAS, the following steps can be use to update a +For owners of a Synology NAS, the following steps can be used to update a container image. 1. Open the *Docker* application. @@ -319,12 +319,12 @@ as a connection fails with the following error: ``` ReadExact: Socket error while reading ``` -However, for your convienence, an unoffical and working version is provided +However, 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 offical package is that the bundled version of +The only difference with the official package is that the bundled version of `stunnel` has been upgraded to version `5.49`, which fixes the connection problems. @@ -352,12 +352,12 @@ To restrict access to your application, a password can be specified. This can be done via two methods: * By using the `VNC_PASSWORD` environment variable. * By creating a `.vncpass_clear` file at the root of the `/config` volume. - This file should contains the password in clear-text. During the container + 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 communication channel (encrypted/unencrypted). - * How secure access to the host is. + * How secure the access to the host is. When using a VNC password, it is highly desirable to enable the secure connection to prevent sending the password in clear over an unencrypted channel. @@ -365,11 +365,11 @@ connection to prevent sending the password in clear over an unencrypted channel. **ATTENTION**: Password is limited to 8 characters. This limitation comes from the Remote Framebuffer Protocol [RFC](https://tools.ietf.org/html/rfc6143) (see section [7.2.2](https://tools.ietf.org/html/rfc6143#section-7.2.2)). Any -characters beyhond the limit are ignored. +characters beyond the limit are ignored. ## Reverse Proxy -The following sections contains NGINX configuration that need to be added in +The following sections contain NGINX configurations that need to be added in order to reverse proxy to this container. A reverse proxy server can route HTTP requests based on the hostname or the URL