From 7119ff3eaf039ab1a9a42c612d45c94d7169a42c Mon Sep 17 00:00:00 2001
From: rob_otman <11605437+Rob-Otman@users.noreply.github.com>
Date: Sun, 11 Jan 2026 10:49:24 -0700
Subject: [PATCH] docs: update README with enhanced deployment instructions and
 environment variable details

- Added detailed instructions for enabling NVIDIA GPU hardware acceleration in the deployment section.
- Updated environment variable documentation to clarify usage and options for hardware acceleration.
- Improved overall formatting and structure for better readability.

These changes enhance the clarity of the README, making it easier for users to configure and deploy the application effectively.
---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index 6bbe932..f9307a6 100644
--- a/README.md
+++ b/README.md
@@ -64,11 +64,20 @@ services:
     restart: unless-stopped
     ports:
       - "3000:3000"
+    # Uncomment the following lines for NVIDIA GPU hardware acceleration (NVENC/NVDEC)
+    # Requires: NVIDIA drivers with NVENC/NVDEC support + nvidia-docker runtime
+    # runtime: nvidia  # Required: Enable NVIDIA container runtime
+    # group_add:       # Optional: May be needed for GPU device access (not required in Unraid)
+    #   - 226          # The render group GID on the host (check with: getent group render | cut -d: -f3)
     environment:
       - JWT_SECRET=aLongAndSecretStringUsedToSignTheJSONWebToken1234 # will use randomUUID() if unset
       # - HTTP_ALLOWED=true # uncomment this if accessing it over a non-https connection
+      # - FFMPEG_PREFER_HARDWARE=true # Optional: Enable hardware acceleration for video encoding/decoding
+      # - NVIDIA_VISIBLE_DEVICES=all  # Optional: Defaults to 'all', use '0,1' for specific GPUs (get IDs with: nvidia-smi -L)
+      # - NVIDIA_DRIVER_CAPABILITIES=all  # Optional: Comma-separated list (e.g., 'compute,video,utility'), 'all' for everything
     volumes:
       - ./data:/app/data
+      # - /usr/bin/nvidia-smi:/usr/bin/nvidia-smi:ro # May be needed: Mount nvidia-smi for GPU detection (not required in Unraid)
 ```
 
 or