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

Windows

How to install fylr on Microsoft Windows

There are two ways to install fylr on Windows:

  • The fully automated installer made by Attention Solutions: https://attention.dk/docs/att/doku.php?id=winfylr:start - needs a paid subscription with Attention Solutions.

  • fylr directly from the developer Programmfabrik GmbH, with the 3rd party tools downloaded by yourself. The rest of this page guides you through this.

Download fylr.exe

It contains:

  • fylr.exe fylr native for Windows amd64.

  • fylr.yml a starting configuration already adjusted with Windows path syntax and for the following instructions.

  • fylr.example.yml most configuration parameters. Look here for reference.

  • fylr.default.yml compiled-in default values. Just as a copy for you to look them up.

  • LICENSE legal information on who may use fylr.

  • README.md pointing to this page.

Up to 6.34 the archive also contained an easydb-plugins folder. From 6.35 plugins come from the plugin manager.

Updating from 6.34 to 6.35

No new third-party tool and no newer version of the tools on this page is required: an installation set up with them for 6.34 keeps them. These steps are needed:

  1. Replace fylr.exe and take over the corrections of the new fylr.yml into yours:

    • db+: instead of db: — a bare db: drops the connection pool defaults,

    • delete a services: line under execserver+: that has nothing below it — it replaces the shipped service list with an empty one, so the execserver converts nothing and runs no plugin,

    • update_policy instead of update in the per-plugin entries under plugin.defaults; plugin.default, the setting for all new plugins, already uses update_policy,

    • no plugin.paths entries for easydb-plugins and no server-pdf entry under plugin.urls.

    Then run .\fylr.exe config check fylr.yml: it reports the update key as unknown and former execserver settings such as waitgroups as deprecated, and warns about a bare db: and an empty services:.

  2. Delete the easydb-plugins folder. The upgrade converts the enabled plugins to their marketplace releases and downloads them, so fylr needs outbound HTTPS to github.com, *.githubusercontent.com and programmfabrik.github.io; without it, install them as ZIP, see Disk to URL plugin migration. The PDF Server (server-pdf) is switched off where PDF Creator is enabled, and PDF Creator renders with the Chrome named in SERVER_PDF_CHROME, see chrome.

  3. Ghostscript must be found as gs. fylr renders EPS, AI and PS with Ghostscript itself: keep the gs.exe copy or name gswin64c.exe in fylr.yml, see Ghostscript. Inkscape stays, for SVG and WMF.

  4. Check that mutool has ICC color management, see mupdf tools. Updating MuPDF to 1.28.0, the version in the Docker image, is recommended: mutool reads every uploaded PDF, and the newer release contains security fixes.

  5. Writing HEIC (since 6.34.2) needs the x265 encoder in the libheif that ImageMagick embeds, see ImageMagick.

  6. Saxon runs with saxon.xml. Save the file next to the Saxon jar and add its -config: argument to the saxon command, see Saxon.

The same changes for Linux and macOS: Updating a self-installation to 6.35.

Windows path length

The shorter the path of your fylr installation directory, the less likely your installation will fail processing files due to exceeding the length limit. So prefer C:\fylr over C:\user\jane doe\Desktop\software-project\fylr-v6.17.0\unpacked. fylr newer than v6.3.1 will try to use only short internal file names, but every little bit helps. Same for Libre Office installation (more about that below).

Get the dependencies

Bare bone minimum: Elasticsearch or OpenSearch

The versions named below are the ones tested. Other versions should also be fine, unless a section names a minimum.

OpenSearch

OpenSearch is the default and recommended indexer.

Install OpenSearch as described in https://opensearch.org/docs/latest/install-and-configure/install-opensearch/windows/ (tested with version 3.6.0, downloaded and unzipped):

  • Disable security and let OpenSearch listen only on localhost, which protects it, in opensearch-3.6.0\config\opensearch.yml:

  • Raise one limit for fylr in opensearch-3.6.0\config\jvm.options:

  • Install the one plugin fylr needs:

  • Start OpenSearch:

Elasticsearch

Elasticsearch was the default until 2023. OpenSearch is recommended instead, especially for a new instance or when Elasticsearch causes problems.

If you use Elasticsearch, use version 7.17: versions 8.5 and newer have a problem indexing the letters Q and W, of all things. The steps below were tested with 8.6.1:

Elasticsearch then listens on the default address http://localhost:9200, which is also configured in fylr.yml.

Start fylr with minimal dependencies

To test or start with minimal effort, edit fylr.yml to use no 3rd party tools for the moment:

Then start fylr in the folder where fylr.exe is. Most asset processing tools are still missing, so there are no previews yet:

Output lines with WRN can usually be ignored.

Harmless Errors known to appear are e.g.

  • Error occurred in NewIntrospectionRequest and Accepting token failed, when a browser tries to use old credentials.

Access the web frontend

Browse http://localhost

Default login credentials are:

  • Username: root

  • Password: admin

More than bare bone minimum

For a full installation, install all of the following and add a command for each tool to fylr.yml, see Configure the tools in fylr.yml.

PostgreSQL

  • Disable the lines configuring sqlite by turning them into comments:

  • For a consistent state, also do the next step: cleanup.

cleanup

If you want to go back to a fresh state between two test runs:

  • Stop fylr.exe and the indexer (opensearch or elasticsearch). Optionally check that java / openjdk is stopped alongside elasticsearch.

  • Remove the directory data and elasticsearch's data/* .

  • Start elasticsearch as shown at the beginning.

  • If you use PostgreSQL, remove and recreate the database.

pdf tools

  • Download the newest release zip (tested with Release-26.02.0-0.zip) from https://github.com/oschwartz10612/poppler-windows (not xpdf-tools from https://www.xpdfreader.com).

  • fylr only uses pdfinfo.exe from poppler: PDF text extraction is done by tika, PDF page rendering by mupdf's mutool (both below).

  • Unpack the release and configure the path to pdfinfo.exe in fylr.yml, or add the containing directory to the PATH.

magick.exe (ImageMagick)

  • Download the newest portable archive (tested with ImageMagick-7.1.2-26-portable-Q16-HDRI-x64.7z) from https://imagemagick.org/script/download.php#windows

  • Put magick.exe from the download into C:\fylr\utils. It is the only ImageMagick binary fylr needs; compositing etc. run as subcommands of magick.exe. (convert.exe and composite.exe are not used by fylr and are no longer part of current ImageMagick anyway.)

Use a current ImageMagick, and fylr v6.34.0 or newer. Version traps around ImageMagick:

  • Current ImageMagick no longer accepts the deprecated magick convert command form. fylr up to v6.33 called ImageMagick that way, so previews fail with NoDecodeDelegateForThisImageFormat `convert'. fylr v6.34.0 and newer calls magick in the modern form, which works with old and new ImageMagick 7.

  • ImageMagick Windows builds from before mid-2024 embed a libheif older than 1.18, which cannot decode HEIC photos taken by newer iPhones (iOS 18 and later): previews fail with Too many auxiliary image references. To check what your magick.exe embeds, run the following — the version in parentheses is the libheif version and must be 1.18 or newer:

  • Writing HEIC (a custom rendition, crop-tool file variant or produce request with format=heic, available since fylr 6.34.2) additionally needs a libheif with an HEVC encoder (x265). The official fylr docker image ships the libheif-plugin-x265 package. On Windows the embedded libheif of the ImageMagick build must be able to encode HEVC: if reading HEIC works but producing a HEIC fails, the embedded libheif lacks the encoder.

Hint from the download page:

If you have any problems, you likely need vcomp140.dll. To install it, download Visual C++ Redistributable Package(https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads).

Exiftool.exe

Download the newest 64-bit Windows Executable (tested with exiftool-13.59_64.zip) from https://exiftool.org.

Put the contents of the zip — exiftool(-k).exe and (in newer packages) the exiftool_files folder next to it — into C:\fylr\utils, and rename exiftool(-k).exe to exiftool.exe, as the ExifTool install notes recommend.

Ffmpeg.exe and ffprobe.exe

Download a current release build (tested with ffmpeg-n8.1-latest-win64-gpl-8.1.zip) from https://github.com/BtbN/FFmpeg-Builds/releases. Avoid the LGPL version: it lacks features such as x264 and x265.

Put ffmpeg.exe and ffprobe.exe into C:\fylr\utils.

Two video encodes run at a time, each on every CPU; threads and maxSlots on the ffmpeg service change that, see Videos take long to encode.

Node

Download the current LTS version (tested with node-v24.18.0-win-x64.7z) from https://nodejs.org/en/download and put just node.exe into C:\fylr\utils.

Python

Download the "Windows embeddable package (64-bit)" from https://www.python.org/downloads/windows/ (explained here) and unpack the whole package as the folder "python3" inside C:\fylr\utils.

Java

To extract information from assets, fylr needs a "java" command. Install Java and make sure the command java starts it: it has to be in the system environment variable PATH, which the Java installation usually takes care of.

Saxon

This replaces xsltproc since fylr v6.19.

Download SaxonJ-HE 12.5 from https://www.saxonica.com/download/java.xml and unpack it, here to C:\fylr\utils\saxon\saxon-he-12.5.jar. From fylr 6.35.0, Saxon runs with the configuration file saxon.xml: save it with the content shown in XSLT with Saxon, here as C:\fylr\utils\saxon\saxon.xml. Configure both in fylr.yml:

Ghostscript

From 6.35 fylr renders EPS, AI and PS with Ghostscript itself and calls it as gs.

Download Ghostscript 10.05.0 for Windows (64 bit) (tested version) from https://ghostscript.com/releases/gsdnld.html and install it, here to C:\Program Files\gs\gs10.05.0. The installer adds the bin directory to the system %PATH%.

Copy gswin64c.exe to gs.exe, so that fylr and other programs find it in the %PATH%:

Instead of the copy, the program can be named in fylr.yml:

A command declared there whose program is missing keeps fylr from starting, so add it once Ghostscript is installed.

Up to fylr 6.34, .eps previews went through ps2pdf and Inkscape, which also needed C:\Program Files\gs\gs10.05.0\lib in the system path.

Libreoffice

Install LibreOffice (https://de.libreoffice.org/donate/dl/win-x86_64/24.8.4/de/LibreOffice_24.8.4_Win_x86-64.msi) and configure it in fylr.yml:

The portable version works as well (tested with LibreOfficePortable_7.4.5_MultilingualStandard.paf.exe from https://www.libreoffice.org/download/portable-versions/, installed to C:\LibreOfficePortable); configure the path to its soffice.exe in fylr.yml.

Fair warning: If you make your installation path too long, LibreOffice will not work. Too long, for example: C:\Users\Jane Doe\Desktop\pf\fylr_v6.2.4_windows_amd64\utils\LibreOfficePortable\.

Inkscape

Install Inkscape 1.4 with its default installer. From 6.35 fylr uses it for SVG and WMF, and Ghostscript for the PostScript family; up to 6.34, version 1.4 was needed for .eps previews via ps2pdf and Inkscape.

Add Inkscape's bin directory to the Windows system %PATH%:

  1. In the Windows Start Menu, type env, then select Edit the system environment variables.

  2. Click the Environment Variables... button.

  3. In the lower section titled System variables, select the line starting with Path.

  4. Click Edit....

  5. In the new window, click New and paste C:\Program Files\Inkscape\bin.

  6. Click OK.

  7. Close and open a new window for fylr.exe, so that the window, and with it fylr, knows the new %PATH%.

To test the integration, upload an SVG file into fylr and check that a preview is generated.

tika

Download the newest tika-app jar file (tested with tika-app-3.3.1.jar) from https://tika.apache.org/download.html and configure it in fylr.yml:

tesseract

From https://github.com/UB-Mannheim/tesseract/wiki download and start the installer (tested with tesseract-ocr-w64-setup-5.5.0.20241111.exe, 64 bit):

  • In the installer dialogs, choose all languages and script data.

  • Install to C:\fylr\utils\tesseract.

  • Configure it in fylr.yml:

mupdf tools

Download the Windows build (tested with mupdf-1.25.2-windows.zip) from https://mupdf.com/releases, unpack it into C:\fylr\utils\mupdf\ and configure it in fylr.yml:

mutool must be built with ICC color management, or CMYK PDFs render with oversaturated colors. A build without it prints warning: ICC support is not available when it renders a PDF:

dot

from https://www.graphviz.org/download/

calibre

from https://calibre-ebook.com/download_windows

libvips

Optional but recommended. fylr requires libvips 8.16 or newer.

On https://www.libvips.org, follow Download and Windows binaries and download the newest vips-dev-x64-all-X.Y.Z.zip (tested with vips-dev-x64-all-8.18.3.zip). Use the all variant — it includes the loaders (e.g. HEIF) that fylr benefits from.

Unpack it, here to C:\fylr\utils\vips-dev-8.18, and configure it in fylr.yml:

chrome

Optional. Needed only to render PDFs — the PDF Creator plugin (pdf-creator), installed from the plugin manager. The Linux distribution brings its own Chromium; under Windows you supply the browser.

  • Install the browser Chrome

  • configure the location of chrome in fylr.yml:

Up to fylr 6.34 the Windows fylr.yml installed the PDF Server (server-pdf) for this, and it did the rendering. PDF Creator renders the PDF itself from version 1.1.0, so 6.35 no longer installs server-pdf — and switches it off where both are enabled, because the two declare the same custom events. See PDF Creator and the PDF Server.

Configure the tools in fylr.yml

All tools together in fylr.yml:

  • before, the tools in fylr.yml look like this (minimal, no 3rd party tools):

  • after adding the tools (use the paths valid on your installation):

Check that each indentation level is two spaces. (No tab characters, just space characters).


Start fylr as a service

After testing, you may want to switch to

Last updated