From 253d43a77603e7b20136b2b2cc4b2762de1219ec Mon Sep 17 00:00:00 2001 From: Jocelyn Le Sage Date: Fri, 30 Aug 2024 22:26:34 -0400 Subject: [PATCH] Updated README. --- README.md | 46 +++++++++++++++++++++++++--------------------- 1 file changed, 25 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 3e2f93f..5f59e17 100644 --- a/README.md +++ b/README.md @@ -64,9 +64,9 @@ of modern, widely supported codecs. ## Quick Start -**NOTE**: - The Docker command provided in this quick start is given as an example - and parameters should be adjusted to your need. +> [!IMPORTANT] +> The Docker command provided in this quick start is given as an example and +> parameters should be adjusted to your need. Launch the HandBrake docker container with the following command: ```shell @@ -256,11 +256,11 @@ docker rm handbrake 3. Create/start the container using the `docker run` command, by adjusting parameters as needed. -**NOTE**: - Since all application's data is saved under the `/config` container - folder, destroying and re-creating a container is not a problem: nothing is - lost and the application comes back with the same state (as long as the - mapping of the `/config` folder remains the same). +> [!NOTE] +> Since all application's data is saved under the `/config` container folder, +> destroying and re-creating a container is not a problem: nothing is lost and +> the application comes back with the same state (as long as the mapping of the +> `/config` folder remains the same). ## Docker Compose File @@ -451,13 +451,13 @@ PEM encoded, x509 certificates. |`/config/certs/web-privkey.pem` |HTTPs connection encryption.|Web server's private key.| |`/config/certs/web-fullchain.pem`|HTTPs connection encryption.|Web server's certificate, bundled with any root and intermediate certificates.| -**NOTE**: - To prevent any certificate validity warnings/errors from the browser - or VNC client, make sure to supply your own valid certificates. +> [!TIP] +> To prevent any certificate validity warnings/errors from the browser or VNC +> client, make sure to supply your own valid certificates. -**NOTE**: - Certificate files are monitored and relevant daemons are automatically - restarted when changes are detected. +> [!NOTE] +> Certificate files are monitored and relevant daemons are automatically +> restarted when changes are detected. ### VNC Password @@ -475,11 +475,11 @@ The level of security provided by the VNC password depends on two things: 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. -**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 beyond the limit are ignored. +> [!CAUTION] +> 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 +> beyond the limit are ignored. ### Web Authentication @@ -493,8 +493,9 @@ environment variable to `1`. See the [Environment Variables](#environment-variables) section for more details on how to set an environment variable. -**NOTE**: Secure connection must be also enabled to use web authentication. - See the [Security](#security) section for more details. +> [!IMPORTANT] +> Secure connection must also be enabled to use web authentication. +> See the [Security](#security) section for more details. #### Configuring Users Credentials @@ -610,6 +611,9 @@ server { location = /handbrake {return 301 $scheme://$http_host/handbrake/;} location /handbrake/ { proxy_pass http://docker-handbrake/; + # Uncomment the following line if your Nginx server runs on a port that + # differs from the one seen by external clients. + #port_in_redirect off; location /handbrake/websockify { proxy_pass http://docker-handbrake/websockify/; proxy_http_version 1.1;