Skip to content

Latest commit

 

History

History
77 lines (40 loc) · 5.29 KB

preview-configuration.md

File metadata and controls

77 lines (40 loc) · 5.29 KB
description
Whenever a file is uploaded to fylr, preview versions are generated. This article describes the options for the configuration of preview versions.

Preview Configuration

Use Default Settings

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

FILE TYPE VERSION DESCRIPTION

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.

{% hint style="warning" %} Please note: when changing version settings, these changes are only applied for newly uploaded files, already existing preview versions are not updated automatically. You have to go to /inspect/files and start a re-sync. {% endhint %}

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

Set the maximum file size allowed for all uploads (for example: 500MB, 2GB). This value determines the upper limit on the size of each individual file that can be uploaded to the system. Make sure to consider user needs and system capabilities when configuring this setting.

Extensions

For each file class (Audio, Image, Office & Video) the allowed file types can be (de-)activated. Only for activated extensions the upload is allowed and preview versions are generated. The allowed maximum file size for uploads can be set here again and overwrite the value defined above.

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.

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.

RECIPEDESCRIPTION
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)
font (officeconverter)Creates preview images for font files.
pdf (officeconverter)Creates a pdf file from a document.
preview (officeconverter)
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.

FILE TYPEOPTIONDESCRIPTION

Version Settings

Furthermore you have the following settings for versions:

OPTIONDESCRIPTION
StandardIf 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 ManagementIf enabled, the version can be used in the permissions for pools etc. Otherwise the version is always accessible to all users.
WatermarkIf enabled, watermarked versions can be generated automatically and used for rights management. This needs additional configuration for the version and rights management.
Display NameName of the version that is used in fylr. Shown in the download manager for example.
GroupChoose a group that is used when exporting URLs to a CSV or XML file.