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

Services

In this section you can enable/disable various background services, like workflow emails, automatically recurring exports or the janitor who cleans up old data.

E-Mail Notifications

This service sends emails such as welcome emails, collection share emails or emails triggered by workflows (if configured under "Tags & Workflows"). If not enabled, no emails will be send.

Please make sure that you set up emailing.

Exporter

This service executes automated exports (if a schedule is defined for an export). If not enabled, scheduled exports will not be executed automatically.

Custom-Data-Type Updater

This services automatically updates data stored in custom data type fields. For example: GND, Geonames or Getty. If not enabled, the data that was copied into FYLR when linking to an external thesaurus will not be updated.

For more configuration of each plugin, please see "Plugins".

WebDAV

Activate Hotfolder

Enable the checkbox to activate the Hotfolder in collections.

Waiting time in seconds before a new file is imported

To avoid importing files that have not yet been completely copied, the system checks after the specified waiting time whether the size of the file has changed. If not, the file is imported. The default is 15 seconds.

Activate File System Connect

Enable the checkbox to activate the File System Connect in collections.

Janitor

This service regularly cleans up data.

Active

Enable/Disable the Janitor.

Deletes all tokens (Access, Refresh, ...) for which:

  • No expired_at is set (e.g. authorization codes)

  • expired_at is in the past

expired_at is saved when the token is saved for the first time and is calculated based on the lifetime of the tokens; this is defined in the base configuration under "User Management" -> "OAuth Service" -> "Expiration Times" for the various token types.

And enables all the following:

Settings for Files

Specify after how many days unused files should be deleted from the storage. Unused files are files that has been uploaded to FYLR but have never been linked to a record. Enter "0" to remove unused files with every janitor run (every 10 minutes).

Settings for Objects

Control how the Janitor cleans up deleted records and the files linked from historic versions of records.

Final deletion after n days

Records that have been deleted are first only marked as deleted and can still be restored. Specify after how many days such a deleted record is permanently removed from the database and can no longer be restored. Enter "0" to purge deleted records with every janitor run (every 10 minutes).

Over time, older versions in a record's change history keep their linked files. These settings free up storage by removing files from old versions:

  • Remove from historic versions after n days — files are removed from a historic version once it is older than this many days.

  • Number of most recent historic versions to keep — files in this many of the most recent versions are always kept, even if they are older than the age above.

Allow overwriting in pools and object types

When this checkbox is enabled, the Janitor can be configured directly at the pool or object type. This is dependent on the pool management setting at the object type in the data model configuration.

Enabling the Overwrite option requires further activation and configuration in Rights Management for the janitor to run.

Settings For Users

Archive Inactive Users After n Days

Specify after how many days user accounts that have not logged in should be archived. Enter "0" to archive inactive users with every janitor run (every 10 minutes).

Attention: archived users will not be able to log in. Archived users can be re-activated but their collections will be deleted when archiving the user account.

Types of Users To Be Archived

Specify the types of users that should be automatically archived after the above specified number or days.

Delete Archived Users After n Days

Specify after how many days archived user accounts should be deleted. Enter "0" to delete archived users with every janitor run (every 10 minutes).

Attention: deleted users will be removed from the system and can't be re-activated. This also includes the users collections. See also "User Management".

Settings For Events

Specify after how many days the individual events should be deleted. Enter "0" to delete the events with every janitor run (every 10 minutes).

Delete IP Address From Events After n Days

Specify after how many days the IP addresses of users should be deleted from the events. Enter "0" to delete the IP address with every janitor run (every 10 minutes).

OpenAPI

fylr describes its API as a machine-readable OpenAPI specification, served at /api/v1/system/openapi/spec.json. It is used to render the API documentation and to feed API tooling and client generators.

Enable this service to make the specification endpoint reachable without authentication, so it can be fetched anonymously. If not enabled, the endpoint requires a logged-in user.

Last updated