Available variables

List of variables

Please note that most of the following variables are set by default, so you do not need to configure them.

In yml-files created by Programmfabrik we use an indentation of 2 spaces per ⇨.

Variable	Type	Required	Description	Default
`include_before`	File-List	No	List of files that are loaded before the file in which it is defined

`include_after`	File-List	No	List of files that are loaded after the file in which it is defined

`base`
⇨`plugins`	File-List	No	List of base plugins	(empty)

`debug`
⇨`exporter_fail`
⇨`exporter_sleep`
⇨`exporter_warnings`
⇨`search_sleep`
⇨`ignore_postgresql_check`	Boolean	No	Don’t stop if PgSQL version less than 11. This might not help in the future as new PgSQL features are being used.	false

`default_client`			Settings used by client, see extra page

`default_pics`
⇨`background`	File	No	for the background
⇨`logo`	File	No	for the Easydb logo
⇨`user_avatar`	File	No	for user images

`eas`
⇨`external_url`	String	No	URL for the EAS connection from outside of Easydb. Only set this, if the EAS is running on a different Server. By default, this is the same as `server.external_url`. In Docker Containers, always `server.external_url` is used.
⇨`instance`	String	Yes	Name of the EAS-Instance
⇨`produce_settings`	File	Yes	EAS-Produce-Settings (JSON)
⇨`supervisor_enabled`	Boolean	Yes	Whether the supervisor is running	`true`
⇨`thumbnail_size`	Integer	Yes	Thumbnail size	`128`
⇨`url`	String	Yes	URL for the EAS connection
⇨`vhost`	String	No	V-Host
⇨`rights_management`
⇨⇨`<class>`			Configuration for EAS class (image, video, audio, office, directory, unknown)
⇨⇨⇨`versions`
⇨⇨⇨⇨`export`	Boolean	Yes	Whether the version is available for export
⇨⇨⇨⇨`group`	String	No	Display name for the version grouping
⇨⇨⇨⇨`rightsmanagement`	Boolean	No	Whether the version is right-managed	`false`
⇨⇨⇨⇨`size_limit`	Integer	No	Version size (determines the maximum size that can be produced if one has the right)
⇨⇨⇨⇨`size_print`	String	No	display text for the Version
⇨⇨⇨⇨`standard`	Boolean	No	Whether the version is included in standard	`false`
⇨⇨⇨⇨`version`	String	Yes	Name of the Version
⇨⇨⇨⇨`watermark`	Boolean	No	Whether the version has a watermark	`false`
⇨⇨⇨⇨`zoomable`	Boolean	No	Whether the version is available for the zoomer	`false`

`elasticsearch`
⇨`begin_with_wildcards_allowed`	Boolean	No	Whether Suggest wildcards are allowed at the beginning	`false`
⇨`connect_timeout_ms`	Integer	Yes	connection timeout (ms)	`30000` (30 seconds)
⇨`default_template`	File	No	Elasticsearch index template file. Can be used to override per-index settings, such as number of shards.	`es_default_template.json` ¹
⇨`fielddata_memory`	String-List	No	Index fields that use `"memory"` as Fielddata type
⇨`settings`	File	Yes	Index-Settings (JSON)
⇨`synonym_list`	File	No	synonym mapping file either in Solr or WordNet format (see https://www.elastic.co/guide/en/elasticsearch/reference/5.6/analysis-synonym-tokenfilter.html). The file is used on index creation time, so if this value is changed, the index has to be recreated.
⇨`transfer_timeout_ms`	Integer	Yes	transmission timeout (ms)	`300000` (5 minutes)
⇨`url`	String	Yes	URL
⇨`max_limit`	Integer	Yes	maximum for `search.limit` for elasticsearch requests	`1000`

`fastcgi-read-timeout`	Integer	No	Timeout for API requests in seconds. It does not affect upload and download requests, which already have higher timeouts. Only available when using Docker containers.	`300` (5 minutes)

`fylr-read-timeout`	Integer	No	Timeout for requests to the `fylr` server (e.g. for PDF creation). Only available when using Docker containers.	`300` (5 minutes)
`fylr-container-wait-timeout`	Integer	No	Time in seconds of `webfrontend` container to wait for `fylr` container to start. Set to 0 to speed up startup if fylr is not available on purpose.	30

`hostnames`
⇨`eas`	String	Yes	name of the eas container	easydb-eas
⇨`fylr`	String	Yes	name of the fylr container	easydb-fylr
⇨`server`	String	Yes	name of the server container	easydb-server
⇨`elasticsearch`	String	Yes	name of the elasticsearch container	easydb-elasticsearch

`imexporter-database`
⇨`dsn`	String	Yes	DSN for the Database connection
⇨`schema`	String	Yes	Database Scheme

`plugins`
⇨`url_prefix_internal`	String	No	URL prefix for internal connections	value of `"url_prefix"`
⇨`url_prefix_external`	String	No	URL prefix for external connections	value of `"url_prefix"`
⇨`url_prefix`	String	No	URL prefix for internal or external connections	(no prefix)

`schema`
⇨`base_dir`	Catalogue	Yes	Base-Schema-Folder
⇨`dsn`	String	Yes	DSN for the Database connection
⇨`user_dir`	Catalogue	Yes	User-Schema-Folder

`server`
⇨`allow_all_origins`	Boolean	No	Always send CORS headers allowing Origin, ignores base configuration. Use this setting only in non-production environments as it circumvents a browser security feature.	false
⇨`api`
⇨⇨`settings`
⇨⇨⇨`buildsuggest`	Boolean	No	Allow requests on `POST /api/v1/settings/buildsuggest` and via frontend	`false`
⇨⇨⇨`purgeall`	Boolean	No	Allow requests on `POST /api/v1/settings/purgeall` and via frontend. Example configuration.	`false`
⇨⇨⇨`purgedata`	Boolean	No	Allow requests on `POST /api/v1/settings/purgedata` and via frontend. Example configuration.	`false`
⇨⇨⇨`reindex`	Boolean	No	Allow requests on `POST /api/v1/settings/reindex` and via frontend. Example configuration.	`false`
⇨⇨⇨`restart`	Boolean	No	Allow requests on `POST /api/v1/settings/restart` and via frontend	`false`
⇨⇨⇨`updatecustomdata`	Boolean	No	Allow requests on `POST /api/v1/settings/updatecustomdata` and frontend	`false`
⇨⇨`pool`
⇨⇨⇨`allow_nonroot_list`	Boolean	No	Allow requests on `GET /api/v1/pool` (without ID) as non-root user (since version 5.81)	`false`
⇨⇨`user`
⇨⇨⇨`include_password`	Boolean	No	Allow requests on `GET /api/v1/user` with url parameter `include_password=true`	`false`
⇨`custom_datatype_updater`
⇨⇨`enabled`	Boolean	Yes	Whether the custom datatype updater is running	true
⇨`directory`
⇨⇨`imexporter`	Catalogue	Yes	Imexporter Directory
⇨⇨`l10n_dir`	Catalogue	Yes	Catalogues for the L10n configuration
⇨⇨`logfile`	File	Yes	Log-File	`/tmp/easydb-server.log`
⇨⇨`output`	Catalogue	Yes	output directory
⇨⇨`pflib`	Catalogue	Yes	Directory where the pflib is located
⇨⇨`plans`	Catalogue	Yes	Plans (only for Imexporter)
⇨⇨`server_errors`	Catalogue	No	Catalog for Server Error Information	`<directory/logfile>.errors`
⇨⇨`tmp`	Catalogue	Yes	Catalogue for temporary files
⇨⇨`umask`	Integer	Yes	umask	`022`
⇨`dirty_queuer`
⇨⇨`num_processes`	Integer	Yes	Number of processes	`1`
⇨`egid`	Integer	No	Effective group ID for running processes. If not configured, no group switch is attempted. (since version 5.81)
⇨`euid`	Integer	No	Effective user ID for running processes. If not configured, no user switch is attempted. (since version 5.81)
⇨`exporter`
⇨⇨`batch_size`	Integer	Yes	Batch Size	`100`
⇨⇨`max_serial_exports`	Integer	Yes	Maximum number of export jobs to process in a worker before it is restarted.	10
⇨⇨`max_xml_size_for_xslt`	Integer	Yes	Max. size for XML Files to allow XSLT post processing (in MB)	`10`
⇨⇨`num_workers`	Integer	Yes	Number of Workers	`0`
⇨`external_url`	String	No	URL for the Server connection from outside of Easydb
⇨`frontend`
⇨⇨`fast`
⇨⇨⇨`num_services`	Integer	No	Number of services in “fast” group (e.g. event polling)	0
⇨⇨⇨`socket`	File	No	Socket of “fast” group
⇨⇨`medium`
⇨⇨⇨`num_services`	Integer	No	Number of services in “medium” group (most requests)	0
⇨⇨⇨`socket`	File	No	Socket of “medium” group
⇨⇨`num_services`	Integer	Yes	Number of services (deprecated; superseded by `server.frontend.slow.num_services`)	`0`
⇨⇨`slow`
⇨⇨⇨`num_services`	Integer	No	Number of services in “slow” group (e.g. synchronous download service)	0
⇨⇨⇨`socket`	File	No	Socket of “slow” group
⇨⇨`socket`	File	Yes	Socket (deprecated; superseded by `server.frontend.slow.socket`)	`/tmp/easydb-server-frontend.sock`
⇨`imexporter`
⇨⇨`num_services`	Integer	Yes	Number of services	`2`
⇨⇨`socket`	File	Yes	Socket	`/tmp/easydb-server-imexporter.sock`
⇨`indexer`
⇨⇨`enabled`	Boolean	Yes	Whether the indexer is running	`true`
⇨⇨`num_processes`	Integer	Yes	Number of processes	`1`
⇨⇨`objects_per_batch`	Integer	Yes	Number of objects in a batch	`1000`
⇨`janitor`
⇨⇨`eas_sync_commit`	Boolean	No	Enable asset status sync to EAS. Assets not linked in easydb are removed by EAS janitor	`true`
⇨⇨`enabled`	Boolean	Yes	Whether the janitor is running	`true`
⇨⇨`enable_asset_cleanup`	Boolean	No	If enabled, assets not linked anymore are removed from database, the EAS may delete them (since version 5.90)	`true` (since 5.109.0, `false` before)
⇨`mailer`
⇨⇨`enabled`	Boolean	Yes	Whether the mailer is running	`true`
⇨⇨`envelope_address`	String	Yes	Envelope Address
⇨⇨`interval`	Integer	Yes	How often the mailer runs (every X seconds)	`60` (1 Minute)
⇨⇨`max_attempts`	Integer	Yes	Number of attempts before an e-mail is classified as undeliverable	`3`
⇨⇨`sender_address`	String	Yes	Sender Address	`easydb-server@localhost`
⇨`max_request_size_mb`	Integer	No	Maximum body size accepted by server, in MB. File uploads are handled separately and are not affected by this limit.	32
⇨`preindexer`
⇨⇨`num_processes`	Integer	Yes	Number of processes	`1`
⇨`upload`
⇨⇨`num_services`	Integer	Yes	Number of services	`2`
⇨⇨`socket`	File	Yes	Socket	`/tmp/easydb-server-upload.sock`

`sso`			Settings used by sso, see extra page

`ldap`			Settings used by ldap, see extra page

`solution`
⇨`name`	String	Yes	Name of the Solution used
⇨`plugins`	File-List	No	List of Solution Plugins	(empty)

`suggest`
⇨`aggregation_chunksize`	Integer	Yes	Number of Objects that are used to aggregate the fields in one batch. Should not be more than `1000`. The higher the number of objects, the bigger the response size will be, also the more complex the objecttype is, the more fields will be aggregated at once.	`1000`
⇨`document_chunksize`	Integer	Yes	Batch Size (in MB) of aggregated documents that are uploaded to the Suggest Index after words and contexts were generated. Must not be more than the maximum request size of the Elasticsearch Instance	`100`
⇨`fields_per_aggregation_chunksize`	Integer	Yes	Defines how many fields of an objecttype are grouped in an aggregation. The higher this number, the fewer aggregation requests are sent, but the higher the request and response sizes will be. If this value is not a positive number, all fields of an objecttype are aggregated at once.	`0` (every field is aggregated seperatedly)
⇨`max_context_map_size`	Integer	Yes	Maximum number of keys in the temporary map of words and contexts that is kept in the RAM, before a batch upload of the suggest index documents is started	`10 000`
⇨`max_per_bucket`	Integer	No	Maximum number of terms in one search request (against the main index) during the building of the suggest index. Min: `1`, max: `1024`	`100`
⇨`settings`	File	Yes	Path to the JSON File with the Elasticsearch Settings for the Suggest Index	`es_suggest_settings.json`
⇨`timestamps`	String List	No	Array of Time Stamps when the Suggest Index is rebuilt. Expected Format: `HH:MM`	`["00:00", "02:00", "04:00", "06:00", "08:00", "10:00", "12:00", "14:00", "16:00", "18:00", "20:00", "22:00"]`

`nodejs`
⇨`node_runner_binary`	String	Yes	Path to the NodeJS instance used by the server to run JavaScript	`"/usr/bin/env node"`
⇨`node_modules`	String	Yes	Path to the `node_modules` folder of the NodeJS instance	`"../../node-runner/node_modules"`
⇨`node_runner_app`	String	Yes	Path to the Node Runner script file	`"../../node-runner/app.js"`

¹ contains somethings like:

{
    "template": "*",
    "settings": {
        "number_of_shards": 1,
        "number_of_replicas": 0
    }
}