Skip to main content

Optional Dependencies

Some input formats require external libraries that are not bundled with the PreviewProxy binary. Install only the ones you need.

LibraryRequired forHow it is found
pdfiumPDF inputBeside the binary (./) or on the system library path
libheifHEIC / HEIF inputSystem library path (LD_LIBRARY_PATH / DYLD_LIBRARY_PATH)
ffmpegVideo thumbnail extractionPATH or FFMPEG_PATH environment variable

pdfium

PreviewProxy renders PDF files using the PDFium library. Pre-built binaries are available from the pdfium-binaries project - no build tools required.

Download

Go to the pdfium-binaries releases page and download the archive for your platform.

PlatformArchive name
Linux x86_64pdfium-linux-x64.tgz
Linux arm64pdfium-linux-arm64.tgz
macOS arm64pdfium-mac-arm64.tgz
macOS x86_64pdfium-mac-x64.tgz
Windows x86_64pdfium-win-x64.zip

Install

Linux / macOS - place beside the binary

Extract the shared library and put it in the same directory as the previewproxy binary:

# Example for Linux x86_64
tar -xzf pdfium-linux-x64.tgz
cp lib/libpdfium.so /usr/local/bin/

PreviewProxy looks for libpdfium.so (Linux) / libpdfium.dylib (macOS) in ./ first, then falls back to the system library path.

Linux - system-wide

sudo cp lib/libpdfium.so /usr/local/lib/
sudo ldconfig

macOS - system-wide

sudo cp lib/libpdfium.dylib /usr/local/lib/

Windows

Place pdfium.dll in the same directory as previewproxy-windows-x86_64.exe.


libheif

Required for HEIC / HEIF input.

Linux

# Debian / Ubuntu
sudo apt install libheif1

# Arch Linux
sudo pacman -S libheif

macOS

brew install libheif
info

Homebrew installs libraries to a non-standard path. If PreviewProxy cannot find libheif, add the Homebrew lib directory to DYLD_LIBRARY_PATH:

export DYLD_LIBRARY_PATH="$(brew --prefix libheif)/lib:$DYLD_LIBRARY_PATH"

Windows

Install via vcpkg:

vcpkg install libheif

Or download a pre-built DLL from the libheif GitHub releases and place heif.dll in the same directory as the previewproxy binary.


ffmpeg

Required for video thumbnail extraction.

Linux

# Debian / Ubuntu
sudo apt install ffmpeg

# Arch Linux
sudo pacman -S ffmpeg

macOS

brew install ffmpeg

Windows

Download a pre-built build from gyan.dev or install via a package manager:

# winget
winget install ffmpeg

# Chocolatey
choco install ffmpeg

# Scoop
scoop install ffmpeg

Add the bin\ directory to your PATH, or point PreviewProxy directly at the executable:

$env:FFMPEG_PATH = "C:\ffmpeg\bin\ffmpeg.exe"
previewproxy

Custom path (all platforms)

Set FFMPEG_PATH to use a non-PATH location:

FFMPEG_PATH=/opt/ffmpeg/bin/ffmpeg previewproxy

See the Environment Variables reference for the full list of video-related options.