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.
This commit is contained in:
rob_otman 2026-01-11 10:49:24 -07:00
parent 947be70540
commit 7119ff3eaf

View file

@ -64,11 +64,20 @@ services:
restart: unless-stopped restart: unless-stopped
ports: ports:
- "3000:3000" - "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: environment:
- JWT_SECRET=aLongAndSecretStringUsedToSignTheJSONWebToken1234 # will use randomUUID() if unset - JWT_SECRET=aLongAndSecretStringUsedToSignTheJSONWebToken1234 # will use randomUUID() if unset
# - HTTP_ALLOWED=true # uncomment this if accessing it over a non-https connection # - 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: volumes:
- ./data:/app/data - ./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 or