Skip to content

docs: clientImageResize minFileSizeKB documentation #548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mattdaniell wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: clientImageResize minFileSizeKB documentation #548

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33dff75
docs: add clientImageResize minFileSizeKB option
Mar 31, 2026
f4b1034
docs: include minFileSizeKB in resize example notes
Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions content/docs/configuration/librechat_yaml/object_structure/config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,7 @@ see: [Web Search Object Structure](/docs/configuration/librechat_yaml/object_str
<OptionTable
options={[
['enabled', 'Boolean', 'Enables or disables client-side image resizing functionality. Default: false.', 'enabled: true'],
['minFileSizeKB', 'Number', 'Minimum file size threshold in KB for resizing. Files smaller than this value are not resized. Default: 200.', 'minFileSizeKB: 200'],
['maxWidth', 'Number', 'Maximum width in pixels for resized images. Images wider than this will be resized. Default: 1920.', 'maxWidth: 1024'],
['maxHeight', 'Number', 'Maximum height in pixels for resized images. Images taller than this will be resized. Default: 1080.', 'maxHeight: 768'],
['quality', 'Number', 'JPEG compression quality (0.1 to 1.0). Higher values mean better quality but larger file sizes. Default: 0.8.', 'quality: 0.9'],
Expand All @@ -252,6 +253,7 @@ When enabled, images that exceed the specified `maxWidth` or `maxHeight` dimensi
fileConfig:
clientImageResize:
enabled: true
minFileSizeKB: 1024
maxWidth: 1920
maxHeight: 1080
quality: 0.8
Expand All @@ -262,6 +264,7 @@ fileConfig:

- Only applies to image files (JPEG, PNG, WebP, etc.)
- Resizing occurs automatically when images exceed the specified dimensions
- Files smaller than `minFileSizeKB` are skipped to avoid unnecessary processing
- Original aspect ratio is preserved during resizing
- The feature works with all supported image upload endpoints
- Quality setting only applies to JPEG and WebP formats
Expand Down