For the complete documentation index, see llms.txt. This page is also available as Markdown.

Preview Configuration

Whenever a file is uploaded to fylr, preview versions are generated. This article describes the options for the configuration of preview versions.

Use Default Settings

If this checkbox is enabled, the default versions are used. These are:

CLASS
VERSION
DESCRIPTION

Image

small

250 px thumbnail (JPEG; PNG for formats with transparency)

Image

preview

1000 px preview (standard)

Image

preview_watermark

1000 px preview carrying the pool watermark

Image

huge

2000 px preview

Image

full

the full-size image, re-encoded

Image

zoom

very large preview (up to 32000 px) for deep-zoom viewers

Audio

small / preview

250 px / 1000 px preview image of the waveform

Audio

aac

the audio re-encoded as AAC

Video

small / preview / huge

250 px / 720 px / 1080 px thumbnail image

Video

360p / 720p / 1080p

the video transcoded to that resolution

Office

small / preview

250 px / 1000 px preview image of the first page

Office

pdf

the document converted to PDF

Office

pages

one preview image per page

Each class also has a preview_watermark version (the preview with the pool watermark). Which versions count as standard, and which are for rights management or carry a watermark, is explained under Version Settings below.

If you want to use other versions, you have to disable the checkbox and then you'll be able to define your own set of preview versions. You can always go back to the default versions by enabling the checkbox. Your settings for the custom versions will not be overwritten, so you can also go back to your custom versions at any time.

Allow Upload of Unknown File Types

Enable this checkbox, if you want to allow the upload of files with extensions not explicitly listed below. Otherwise these unknown or not supported file types are declined during the upload process.

Max. upload file size

The largest size a single uploaded file may have. It applies to every file class that does not set its own limit under Extensions.

Enter the size as a number with a unit suffix — b, k, m or g (bytes, KB, MB, GB), for example 500m or 2g. Leave it at 0 (the default) for no limit — any file size is then accepted.

A file larger than the limit that applies to its class is rejected during upload with a "file too large" error naming the maximum, and nothing is stored.

Extensions

For each file class (Audio, Image, Office and Video) you can (de-)activate the allowed file types: only activated extensions may be uploaded, and versions are generated only for them.

Each class also has its own Max. upload file size, in the same b/k/m/g format. A non-zero value here applies to that class only and overrides the global limit above. 0 (the default) makes the class fall back to the global limit — so for a class 0 means "use the global setting", whereas the global 0 means "no limit at all".

Versions

All configured versions are shown in a table with their most important details. Hover over a version and click the little pencil button to edit the version settings (see below) or select a version and click the minus button on the bottom of the table to delete the version. You can add new versions by clicking on the plus button.

The RENDITIONS table for the Image file class
The renditions of the Image class: each row is one version with its allowed extensions, display name, rendition name and output format.

Override original

If enabled, the original file won't be saved in fylr. Instead it will be replaced by the biggest version.

Version name

Internal name of the version.

Recipes

Recipes define the options available for generating the preview versions. Each file class brings their own recipes.

RECIPE
DESCRIPTION

preview (audioconverter)

Creates preview images from audio files.

convert (audioconverter)

Converts audio files into a different audio format.

vectortosvg (imageconverter)

Converts vector files to SVG files.

browserthumbs (imageconverter)

Converts image files.

preview_pool_watermark (imageconverter)

Creates preview images with watermarks.

browserthumbs (officeconverter)

Creates preview images for InDesign (indd) files from their embedded previews.

font (officeconverter)

Creates preview images for font files.

pdf (officeconverter)

Creates a pdf file from a document.

preview (officeconverter)

Creates preview images from office documents (spreadsheets, presentations, text documents).

pdfpages (pdfconverter)

Creates preview images for all pages in a pdf file.

resize (videoconverter)

Converts video files.

thumbnail (videoconverter)

Creates preview images from videos.

Extensions

Each recipe brings its own extension options. Enable all extensions you want the preview version to be generated for.

Recipe Configuration

Each recipe brings its own recipe options.

OPTION
DESCRIPTION

format

Output format of the version — for example jpg or png for images, or aac for audio.

size

Target size in pixels, interpreted according to resize_mode. 0 keeps the original size (the image is only re-encoded).

size_minimum

Only generate this version if the source is at least this many pixels. This prevents upscaling and lets the larger versions (huge, full, zoom) be skipped for smaller originals.

resize_mode

  • max: Maximum length allowed for either the width or the height. The image is resized so its longest side equals size.

  • min: Minimum length required for either the width or the height. The image is resized so its shortest side equals size.

  • width: Sets the exact width of the image. The height is automatically adjusted to preserve the aspect ratio.

  • height: Sets the exact height of the image. The width is automatically adjusted to preserve the aspect ratio.

jpegquality

JPEG quality from 1 to 100. The default versions use 80.

strip

Remove embedded metadata (EXIF, color profile, …) from the generated image.

clip

Honor an embedded clipping path and preserve transparency when converting.

height / height_minimum

For video: the target height in pixels (for example 360, 720, 1080). height_minimum skips the version for smaller source videos.

Version Settings

Furthermore you have the following settings for versions:

OPTION
DESCRIPTION

Standard

If enabled, this version is used as the standard for an object type. The version is then shown in the search result for example. Please note, that "standard" needs to be enabled in the data model for the file field.

Rights Management

If enabled, the version can be used in the permissions for pools etc. Otherwise the version is always accessible to all users.

Watermark

If enabled, watermarked versions can be generated automatically and used for rights management. This needs additional configuration for the version and rights management.

Display Name

Name of the version that is used in fylr. Shown in the download manager for example.

Group

Choose a group that is used when exporting URLs to a CSV or XML file.

Last updated