DOCUMENTATION
  • Welcome
  • Releases
    • 2025
      • Release v6.20.2 (2025-05-07)
      • Release v6.20.1 (2025-05-06)
      • Release v6.20.0 (2025-04-30)
      • Release v6.19.2 (2025-04-11)
      • Release v6.19.1 (2025-03-31)
      • Release v6.19.0 (2025-03-27)
      • Release v6.18.2 (2025-03-11)
      • Release v6.18.1 (2025-03-07)
      • Release v6.18.0 (2025-02-26)
      • Release v6.17.3 (2025-02-14)
      • Release v6.17.2 (2025-02-07)
      • Release v6.17.1 (2025-02-06)
      • Release v6.17.0 (2025-01-30)
    • 2024
      • Release v6.16.0 (2024-12-12)
      • Release v6.15.0 (2024-11-27)
      • Release v6.14.2 (2024-11-05)
      • Release v6.14.1 (2024-11-01)
      • Release v6.14.0 (2024-10-31)
      • Release v6.13.3 (2024-10-16)
      • Release v6.13.2 (2024-10-10)
      • Release v6.13.1 (2024-10-02)
      • Release v6.13.0 (2024-09-25)
      • Release v6.12.2 (2024-09-18)
      • Release v6.12.1 (2024-08-01)
      • Release v6.12.0 (2024-07-25)
      • Release v6.11.5 (2024-07-09)
      • Release v6.11.4 (2024-07-05)
      • Release v6.11.3 (2024-07-03)
      • Release v6.11.2 (2024-06-21)
      • Release v6.11.1 (2024-06-14)
      • Release v6.11.0 (2024-06-05)
      • Release v6.10.2 (2024-05-15)
      • Release v6.10.1 (2024-05-08)
      • Release v6.10.0 (2024-04-30)
      • Release v6.9.3 (2024-03-19)
      • Release v6.9.2 (2024-03-15)
      • Release v6.9.1 (2024-03-06)
      • Release v6.9.0 (2024-02-28)
      • Release v6.8.5 (2024-02-02)
      • Release v6.8.4 (2024-02-01)
      • Release v6.8.3 (2024-01-12)
      • Release v6.8.2 (2024-01-05)
    • 2023
      • Release v6.8.1 (2023-12-22)
      • Release v6.8.0 (2023-12-14)
      • Release v6.7.4 (2023-11-15)
      • Release v6.7.3 (2023-11-14)
      • Release v6.7.2 (2023-11-03)
      • Release v6.7.1 (2023-10-17)
      • Release v6.7.0 (2023-10-13)
      • Release v6.6.4 (2023-09-29)
      • Release v6.6.3 (2023-09-28)
      • Release 6.6.2 (2023-09-14)
      • Release v6.6.1 (2023-08-10)
      • Release v6.6.0 (2023-08-03)
      • Release v6.5.1 (2023-06-23)
      • Release v6.5.0 (2023-06-22)
      • Release v6.4.0 (2023-05-31)
      • Release v6.3.1 (2023-04-28)
      • Release v6.3.0 (2023-04-05)
      • Release v6.2.5 (2023-03-16)
      • Release v6.2.4 (2023-02-01)
      • Release v6.2.3 (2023-01-12)
      • Release v6.2.2 (2023-01-12)
      • Release v6.2.1 (2023-01-05)
    • 2022
      • fylr first Production Ready Release 🎉 (2022-12-22)
  • License
  • Help
    • FAQs
    • Tutorials
      • For Users
      • For Administrators
        • Exporting & Importing Hierarchical Lists
        • Regenerating preview images
        • Search Text in images or office files
      • For System Administrators
        • How to setup and use IIIF
        • External access: Sharing collections with anonymous users
    • Glossary
  • FOR USERS
    • Getting Started
    • Asset / Records Management
      • Creating Records
      • Editing Records
        • Input Fields
        • Group Editor
      • Deleting Records
    • Quick Access
      • Collections (& Presentations)
      • Saved Searches (& Lists)
    • Lists
    • Plugins
      • Plugin Overview
  • FOR ADMINISTRATORS
    • Permissions
      • User
      • Groups
      • Object Types
      • Pools
      • Tags & Workflows
      • Presets
    • Tools
      • CSV Importer
        • General Information
        • Options
        • Examples
          • All Data Types
          • Lists
          • Hierarchies
          • Files
      • JSON Importer
        • Step-by-Step Tutorial
          • Write Import Manifest
          • Create Basetype Payloads
          • Create Object Payloads
          • Collection Payloads
          • Optional: Update links between Objects
          • Start Import
      • Permissions Download & Upload
    • Base Configuration
      • General
      • Access
      • User Management
      • Languages
      • Email
      • Export & Deep Links
      • Workflow Webhooks
      • Publications
      • File Worker
        • Preview Configuration
        • Location Defaults
        • Custom .icc Color Profiles
      • Objectstore
      • Services
      • License Management
      • Development
      • Plugins
    • Plugin Manager
    • Location Manager
    • Messages
    • Events
    • Backup Manager
    • Additional Features
      • IIIF
      • Connector
      • Wordpress
      • Zooniverse
      • Protocols
        • OAI/PMH
  • FOR SYSTEM ADMINISTRATORS
    • Installation
      • Linux
        • multiple fylrs in one Linux
        • proxy and fylr
      • Windows
      • Kubernetes
    • Configuration
      • fylr.example.yml
      • fylr.default.yml
      • performance tuning
      • pre-load frontend config
      • Load Custom Plugins
      • HTTP and HTTPS
      • DNS Domains
    • Backups & Restore
    • Migration Tool
      • Create payloads (fylr backup)
      • Insert payloads (fylr restore)
      • Best Practice
      • Using the fylr inspect page
    • Integration
      • Authentication
      • Hotfolder
    • Symptom & Solution
      • Log messages that can be ignored
      • too many clients are connected
      • too many nested clauses
      • context canceled
      • ContainerConfig error
      • Purge objects
    • PostgreSQL versions
  • Tutorials
    • Project Workflow
    • Hotfolder & File System Connect
      • Preparations Before Usage
      • Setting Up An Upload Collection
      • Importing Files
    • PDF Creator
    • Extracting File Metadata Later On
    • Overlay Resource
    • Authentication
      • LDAP
      • SAML
    • Data Model Sync
    • Purge a fylr instance
    • typo3 plugin
    • Use fylr in Google docs via CI HUB
  • FOR DEVELOPERS
    • API
      • OAuth2
      • Endpoints
        • /api/collection
        • /api/config
        • /api/db_info
        • /api/db
        • /api/eas
        • /api/event
        • /api/export
        • /api/group
        • /api/l10n
        • /api/mask
        • /api/message
        • /api/oaipmh
        • /api/objects
        • /api/objecttype
        • /api/plugin
        • /api/pool
        • /api/publish
        • /api/right
        • /api/schema
        • /api/search
        • /api/settings
        • /api/suggest
        • /api/system
        • /api/tags
        • /api/transitions
        • /api/user
        • /api/webdav
        • /api/xmlmapping
        • /api/task
    • System Data Types
      • pool
      • file
      • user
      • group
      • pool
      • collection
      • message
      • publish
      • event
    • User Data Types
      • text, text_oneline
      • string
      • text_l10n, text_l10n_oneline
      • boolean
      • number
      • integer.2
      • double
      • date, datetime
      • daterange
      • geojson
    • Custom Data
    • Emails
    • Export
    • Exec server
    • File versions
    • WebDAV
    • Plugin
    • Collection Pin Code
    • easydb 5
    • Localization
    • Access private Repositories
Powered by GitBook
On this page
  • Example 1: resource filesystem
  • Extract original file
  • Prepare replacement
  • Overlay
  • Check that overlay is being done
  • Example 2: web filesystem
  • Extract original file
  • Prepare the replacement
  • Overlay
  • Test by showing the overlayed file
  • More info
  • Command syntax
  • Show all resources that can be overlayed
  1. Tutorials

Overlay Resource

How to overwrite files that are compiled into fylr

PreviousExtracting File Metadata Later OnNextAuthentication

Last updated 2 months ago

Example 1: resource filesystem

Assume that you want to increase the timeout for re-sizing video assets form one hour to two hours.

This is done in the compiled-in file baseconfig/fas/cookbooks/video.yml.

Extract original file

For a , the command would be:

docker exec fylr /fylr/bin/fylr resources --fs=fylr.resources --copy=- baseconfig/fas/cookbooks/video.yml>video.yml

This command will extract the compiled-in file video.yml even if that is already overlayed via fylr.yml. Because the command does not even specify the configuration file (would be done with -c /fylr/config/fylr.yml), it will not be read and thus a resources: setting there will not be seen.

Prepare replacement

Find timeoutSec: 3600 in the extracted file video.yml and and change it to 7200.

Create the directory structure: (in /srv/fylr, taken from the )

mkdir -p /srv/fylr/config/fylr/resources/baseconfig/fas/cookbooks

Move the file to the correct position:

mv video.yml /srv/fylr/config/fylr/resources/baseconfig/fas/cookbooks/

Overlay

  1. Configure fylr to overlay, in fylr.yml:

fylr+:
  resources: "/fylr/config/resources"
  1. Restart fylr to run it with the new configuration.

Check that overlay is being done

docker compose exec fylr /fylr/bin/fylr resources -c /fylr/config/fylr.yml --fs=fylr.resources

+--------------------------------------------------+----------+----------------------+
|                       PATH                       |   SIZE   |        SOURCE        |
+--------------------------------------------------+----------+----------------------+
...
| baseconfig/fas/cookbooks/video.yml               |   4.4 kB |              overlay |
| baseconfig/fas/cookbooks/audio.yml               |   3.0 kB |                embed |
...

In the SOURCE column, overlay is now shown, instead of embed.

Please not that in this case, the configuration file has to be specified with -c /fylr/config/fylr.yml, because this is the path in the fylr container. Otherwise fylr will start with defaults and thus ignore your resources: setting in fylr.yml. And -c has to be specified after the resources command.

To extract the overlayed file:

docker exec fylr /fylr/bin/fylr resources -c /fylr/config/fylr.yml --fs=fylr.resources --copy=- baseconfig/fas/cookbooks/video.yml

(... with this example command, the file contents is shown as output, due to --copy=-, and not saved anywhere)

Example 2: web filesystem

Let us assume that the file robots.txt needs to be changed:

Extract original file

docker compose exec fylr /fylr/bin/fylr resources --fs=fylr.services.webapp.path --copy=- robots.txt>robots.txt

Prepare the replacement

Change the extracted robots.txt.

Create the directory structure of the overlay:

mkdir -p /srv/fylr/config/fylr/web

Move the file to the correct position:

mv robots.txt /srv/fylr/config/fylr/web/

Overlay

  1. Configure fylr to overlay, in fylr.yml:

fylr+:
  services+:
    webapp+:
      path: "/fylr/config/web"
  1. Restart fylr to run it with the new configuration.

Test by showing the overlayed file

docker exec fylr /fylr/bin/fylr resources -c /fylr/config/fylr.yml --fs=fylr.services.webapp.path --copy=- robots.txt

More info

Command syntax

How to show the command syntax and options of your fylr version.

docker compose exec fylr /fylr/bin/fylr resources --help

Show all resources that can be overlayed

docker compose exec fylr /fylr/bin/fylr resources --fs=fylr.resources

+--------------------------------------------------+----------+--------+
|                       PATH                       |   SIZE   | SOURCE |
+--------------------------------------------------+----------+--------+
| .                                                |      DIR |  embed |
| baseconfig                                       |      DIR |  embed |
| baseconfig/fas                                   |      DIR |  embed |
| baseconfig/fas/cookbooks                         |      DIR |  embed |
| baseconfig/fas/cookbooks/audio.yml               |   3.0 kB |  embed |
... ~ 400 more ...
| pages.csv                                        |  90.3 kB |  embed |
+--------------------------------------------------+----------+--------+

docker compose exec fylr /fylr/bin/fylr resources --fs=fylr.services.webapp.path

+------------------------------------------------------+----------+--------+
|                         PATH                         |   SIZE   | SOURCE |
+------------------------------------------------------+----------+--------+
| .                                                    |      DIR |  embed |
| cui                                                  |      DIR |  embed |
| cui/cui.js                                           |   2.3 MB |  embed |
| favicon.ico                                          |   1.3 kB |  embed |
| index.html                                           |  23.7 kB |  embed |
| maintenance.html                                     |   1.8 kB |  embed |
| robots.txt                                           |     26 B |  embed |
| web                                                  |      DIR |  embed |
| web/build_info.json                                  |    202 B |  embed |
| web/css                                              |      DIR |  embed |
| web/css/ez5_debug.css                                |  42.2 kB |  embed |
| web/css/ez5_fylr.css                                 |   1.8 MB |  embed |
| web/css/ez5_mockup.css                               | 408.7 kB |  embed |
| web/css/ez5_ng.css                                   | 454.0 kB |  embed |
| web/css/ez5_print.css                                |  23.7 kB |  embed |
| web/css/font-awesome                                 |      DIR |  embed |
| web/css/font-awesome/css                             |      DIR |  embed |
| web/css/font-awesome/css/font-awesome.min.css        |  31.0 kB |  embed |
| web/css/font-awesome/fonts                           |      DIR |  embed |
| web/css/font-awesome/fonts/FontAwesome.otf           | 134.8 kB |  embed |
| web/css/font-awesome/fonts/fontawesome-webfont.eot   | 165.7 kB |  embed |
| web/css/font-awesome/fonts/fontawesome-webfont.svg   | 444.4 kB |  embed |
| web/css/font-awesome/fonts/fontawesome-webfont.ttf   | 165.5 kB |  embed |
| web/css/font-awesome/fonts/fontawesome-webfont.woff  |  98.0 kB |  embed |
| web/css/font-awesome/fonts/fontawesome-webfont.woff2 |  77.2 kB |  embed |
| web/error.html                                       |     83 B |  embed |
| web/iframe_tester.html                               |   1.0 kB |  embed |
| web/img                                              |      DIR |  embed |
| web/img/easydb-logo-150x30.png                       |   2.2 kB |  embed |
| web/img/ez5-placeholder.png                          |    296 B |  embed |
| web/js                                               |      DIR |  embed |
| web/js/easydb5.js                                    |   2.8 MB |  embed |
| web/js/easydb5_login.js                              |  78.1 kB |  embed |
| web/js/easydb5_start.js                              |  19.4 kB |  embed |
| web/js/thirdparty_all.js                             |  56.9 kB |  embed |
| web/l10n                                             |      DIR |  embed |
| web/l10n/cs-CZ.json                                  | 344.4 kB |  embed |
| web/l10n/cultures.json                               |    446 B |  embed |
| web/l10n/da-DK.json                                  | 350.4 kB |  embed |
| web/l10n/de-DE.json                                  | 364.9 kB |  embed |
| web/l10n/en-US.json                                  | 344.5 kB |  embed |
| web/l10n/es-ES.json                                  | 346.4 kB |  embed |
| web/l10n/fi-FI.json                                  | 354.4 kB |  embed |
| web/l10n/fr-FR.json                                  | 375.5 kB |  embed |
| web/l10n/it-IT.json                                  | 365.9 kB |  embed |
| web/l10n/pl-PL.json                                  | 347.9 kB |  embed |
| web/l10n/ru-RU.json                                  | 375.0 kB |  embed |
| web/l10n/sv-SE.json                                  | 351.5 kB |  embed |
| web/l10n/uz-UZ.json                                  | 348.0 kB |  embed |
| web/login.html                                       |    873 B |  embed |
| web/sso_authentication_required.html                 |    649 B |  embed |
| web/success.html                                     |     85 B |  embed |
| web/webdvd.inject.html                               |   1.3 kB |  embed |
+------------------------------------------------------+----------+--------+

For a , the command would be:

For a , the command to show this, would be:

For a , the command to show this, would be:

To list all resources, let fylr give you a list of each overlay-able filesystem. Currently (fylr v6.9.3), there are two such filesystems. For a , the commands to list both, would be:

recommended Linux installation
recommended Linux installation
recommended Linux installation
recommended Linux installation
recommended Linux installation
recommended Linux installation