DE EN EN (Google)

easydb-server.yml

Types

Variables are structured in maps, but a general map is not a valid type for a variable. The types supported are:

Easydb-Type YAML-Type Comments
String String
Integer Integer
Boolean Boolean, String, Integer true: true, "on", "1", 1
false: false, "off", "0", 0, null, not set
File String either absolute or relative to the YAML file in which the variable is defined
Catalogue String as file
File-List Sequence of Strings not set = null = empty list
each file is absolute or relative to the YAML file in which it is defined, i.e. a list can contain files with different relative paths

replacements

If a variable has already been defined, its value is replaced if it is redefined at a later time. Further opportunities are:

  plugins:
    enabled+:
      - base.custom-data-type-link
      - base.custom-data-type-gnd

List of variables

base

Variable Type Required Description Default
base
plugins File-List No List of base plugins (empty)
exporter
  batch_size Integer Yes Batch Size 100
  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
debug
exporter_fail
exporter_sleep
exporter_warnings
search_sleep
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
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
api
  settings
   buildsuggest Boolean No Allow requests on POST /api/v1/schema/buildsuggest false
   purgeall Boolean No Allow requests on POST /api/v1/schema/purgeall false
   purgedata Boolean No Allow requests on POST /api/v1/schema/purgedata false
   reindex Boolean No Allow requests on POST /api/v1/schema/reindex false
   restart Boolean No Allow requests on POST /api/v1/schema/restart false
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
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
  interval Integer Yes How often the Janitor runs (every X seconds) 600 (10 minutes)
  max_age Integer Yes When a file expires (after X seconds) 259200 (3 days)
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
upload
  num_services Integer Yes Number of services 2
  socket File Yes Socket /tmp/easydb-server-upload.sock
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
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. Excpected 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
    }
}

easydb-server.yml