Configuration
The typical configuration of the easydb takes place outside of the containers, in YAML files.
Load order
The YAML files are loaded in the following order:
/srv/easydb/config/
easydb5-master.yml Assumption from now on: the folder/srv/easydb/config
was chosen during installation./srv/easydb/config/
easydb-server.yml and/srv/easydb/config/easydb-server.d/*.yml
for the containers easydb-server and easydb-webfrontend/srv/easydb/config/
eas.yml for the container easydb-eas/srv/easydb/config/easydb_asset_server.conf
(discouraged, soon obsolete, not YAML) for the container easydb-eas/srv/easydb/config/
fylr.yml for the container easydb-fylr/srv/easydb/config/
elasticsearch.yml for the container easydb-elasticsearch/srv/easydb/config/pgsql.yml
for the container easydb-pgsql
Inside the containers:
- Files inside of containers should only be relevant for you as a customer in exceptional cases.
- Files inside of containers are overwritten by recreation of containers, for example, during updates. This is opposed to files which are mapped/mounted into containers (“volumes”).
- For example in the docker container easydb-server, the file
easydb-server.yml
, if available, is first loaded from the current directory of the executable. - Then other files are loaded that are specified as arguments in the command line (with
--configfile
) in the order in which they are specified.
A YAML file can also include other configuration files:
- The variable include_before is a list of files that are loaded before the file in which it is defined
- The variable include_after is a list of files that are loaded after the file in which it is defined
- Such files are defined either with an absolute path or relative to the YAML file in which they were specified. Paths will be interpreted inside the container, where for example
/srv/easydb/config
(outside) is typically mapped to/config
(inside).
Auxiliary configuration
The Easydb server is primarily configured by YAML files, but there are other configuration mechanisms for certain areas:
- Email Configuration
- Preview and Download Versions
- Apache2 (HTTPS)
- Plugin Configuration
- LDAP
- Single Sign-On
- Hotfolder
- Data Model Server
Lists by type
eas.yml
easydb-server.yml
- base.plugins
- debug.exporter_fail
- debug.exporter_sleep
- debug.exporter_warnings
- debug.search_sleep
- default_client.asset_browser_max_preview_filesize
- default_client.audio_player_use_original
- default_client.collection_refresh_rate_seconds
- default_client.database.instance
- default_client.database.level
- default_client.database.server
- default_client.database.uid
- default_client.debug
- default_client.download_zip.url
- default_client.index_html_body_include
- default_client.index_html_head_include
- default_client.print_limit
- default_client.sso_authentication_required_html
- default_client.suggest_disable
- default_client.tag_colors
- default_client.tag_icons
- default_client.video_player_use_original
- default_client.webdvd_player_open_window_parameter
- default_pics.background
- default_pics.logo
- default_pics.user_avatar
- eas-rights_management.archive.versions.class.group
- eas-rights_management.archive.versions.class.limit
- eas-rights_management.archive.versions.class.rightsmanagement
- eas-rights_management.archive.versions.class.size_print
- eas-rights_management.archive.versions.class.standard
- eas-rights_management.archive.versions.class.version
- eas-rights_management.audio.versions.class.export
- eas-rights_management.audio.versions.class.group
- eas-rights_management.audio.versions.class.rightsmanagement
- eas-rights_management.audio.versions.class.size_print
- eas-rights_management.audio.versions.class.standard
- eas-rights_management.audio.versions.class.version
- eas-rights_management.office.versions.class.export
- eas-rights_management.office.versions.class.rightsmanagement
- eas-rights_management.office.versions.class.size_print
- eas-rights_management.office.versions.class.standard
- eas-rights_management.office.versions.class.version
- eas-rights_management.unknown.versions
- eas-rights_management.vector2d.versions
- eas-rights_management.vector3d.versions
- eas.external_url
- eas.instance
- eas.produce_settings
- eas.rights_management.class
- eas.rights_management.class.versions.export
- eas.rights_management.class.versions.group
- eas.rights_management.class.versions.rightsmanagement
- eas.rights_management.class.versions.size_limit
- eas.rights_management.class.versions.size_print
- eas.rights_management.class.versions.standard
- eas.rights_management.class.versions.version
- eas.rights_management.class.versions.watermark
- eas.rights_management.class.versions.zoomable
- eas.rights_management.image.versions.class.export
- eas.rights_management.image.versions.class.group
- eas.rights_management.image.versions.class.rightsmanagement
- eas.rights_management.image.versions.class.size_limit
- eas.rights_management.image.versions.class.size_print
- eas.rights_management.image.versions.class.zoomable
- eas.rights_management.video.versions.class.export
- eas.rights_management.video.versions.class.group
- eas.rights_management.video.versions.class.rightsmanagement
- eas.rights_management.video.versions.class.size_limit
- eas.rights_management.video.versions.class.size_print
- eas.rights_management.video.versions.class.standard
- eas.rights_management.video.versions.class.version
- eas.supervisor_enabled
- eas.thumbnail_size
- eas.url
- eas.vhost
- elasticsearch.begin_with_wildcards_allowed
- elasticsearch.connect_timeout_ms
- elasticsearch.default_template
- elasticsearch.fielddata_memory
- elasticsearch.max_limit
- elasticsearch.settings
- elasticsearch.transfer_timeout_ms
- elasticsearch.url
- email.login_disabled
- email.welcome_new_user
- imexporter-database.dsn
- imexporter-database.schema
- imexporter-database.server.directory.plans
- logging.pf
- logging.pf.base
- logging.pf.base.config
- logging.pf.base.transition
- logging.pf.collection
- logging.pf.database-schema
- logging.pf.database-schema.check
- logging.pf.database-schema.enrich
- logging.pf.database-schema.json
- logging.pf.database-schema.manager
- logging.pf.database-schema.upgrade
- logging.pf.database-schema.xml
- logging.pf.databaseschema
- logging.pf.databaseschema.main
- logging.pf.datamodel
- logging.pf.datamodel.base
- logging.pf.datamodel.base.mapping
- logging.pf.datamodel.mask
- logging.pf.db
- logging.pf.db.prepared
- logging.pf.dbapi
- logging.pf.dbapi.export
- logging.pf.dbapi.import
- logging.pf.dbapi.simple
- logging.pf.dbapi.standard
- logging.pf.dirtyqueuer
- logging.pf.elasticsearch
- logging.pf.elasticsearch.index
- logging.pf.elasticsearch.request
- logging.pf.elasticsearch.response
- logging.pf.export
- logging.pf.export.common
- logging.pf.export.io
- logging.pf.export.scheduler
- logging.pf.export.worker
- logging.pf.exporter
- logging.pf.exporter.csv2xml
- logging.pf.exporter.def_loader
- logging.pf.exporter.exporter
- logging.pf.exporter.main
- logging.pf.exporter.plan
- logging.pf.ez5
- logging.pf.ez5.admin
- logging.pf.ez5.collection
- logging.pf.ez5.db
- logging.pf.ez5.dbdebug
- logging.pf.ez5.eas
- logging.pf.ez5.event
- logging.pf.ez5.export
- logging.pf.ez5.index_manager
- logging.pf.ez5.jsonmaskio
- logging.pf.ez5.l10n
- logging.pf.ez5.mapping
- logging.pf.ez5.metadata
- logging.pf.ez5.objects
- logging.pf.ez5.plugin
- logging.pf.ez5.right
- logging.pf.ez5.search
- logging.pf.ez5.session
- logging.pf.ez5.settings
- logging.pf.ez5.suggest
- logging.pf.ez5.xmlmaskio
- logging.pf.frontend
- logging.pf.frontend.get
- logging.pf.frontend.l10n
- logging.pf.frontend.post
- logging.pf.groupedit
- logging.pf.ic
- logging.pf.ic.exception
- logging.pf.ic.exception.affected_rows_mismatch_too_few
- logging.pf.ic.exception.affected_rows_mismatch_too_many
- logging.pf.ic.exception.result_rows_mismatch_too_few
- logging.pf.ic.exception.result_rows_mismatch_too_many
- logging.pf.ic.imagehandler
- logging.pf.ic.manager
- logging.pf.ic.parse_url
- logging.pf.imexporter
- logging.pf.imexporter.annotate
- logging.pf.imexporter.eas_bridge
- logging.pf.imexporter.eas_bridge.request
- logging.pf.imexporter.eas_bridge.response
- logging.pf.imexporter.eas_supervisor
- logging.pf.imexporter.split
- logging.pf.imexporter.support
- logging.pf.importer
- logging.pf.importer.def_loader
- logging.pf.importer.importer
- logging.pf.importer.main
- logging.pf.indexer
- logging.pf.mailer
- logging.pf.mask
- logging.pf.mask.standard
- logging.pf.maskio
- logging.pf.metadata
- logging.pf.metadata.mapper
- logging.pf.plugin.base.hotfolder
- logging.pf.preindexer
- logging.pf.run
- logging.pf.run.child_group
- logging.pf.run.request_child_group
- logging.pf.search
- logging.pf.search.fields
- logging.pf.search.request
- logging.pf.search.response
- logging.pf.server
- logging.pf.server.asset_io
- logging.pf.server.config
- logging.pf.server.datamodel
- logging.pf.server.datamodel.manager
- logging.pf.server.deep_link.processor
- logging.pf.server.dirtyqueuer
- logging.pf.server.event_io
- logging.pf.server.groupio
- logging.pf.server.handler
- logging.pf.server.handler.s
- logging.pf.server.indexer
- logging.pf.server.janitor
- logging.pf.server.mail_manager
- logging.pf.server.main
- logging.pf.server.maskio
- logging.pf.server.objecttype_io
- logging.pf.server.plugin
- logging.pf.server.plugin.process
- logging.pf.server.preindexer
- logging.pf.server.python
- logging.pf.server.right_io
- logging.pf.server.rights_manager
- logging.pf.server.rights_manager.check_acl
- logging.pf.server.rights_manager.check_right
- logging.pf.server.session
- logging.pf.server.tagio
- logging.pf.server.type_system
- logging.pf.server.upload
- logging.pf.server.userio
- logging.pf.server.worker
- logging.pf.suggest
- logging.pf.suggest.indexer
- logging.pf.suggest.request
- logging.pf.test
- logging.pf.translation
- logging.pf.watermarkio
- logging.pf.xmlmapper
- logging.pf.xmlmapper.fieldparser
- logging.pf.xslt
- nodejs.node_modules
- nodejs.node_runner_app
- nodejs.node_runner_binary
- plugins.enable.base.auto-keyworder
- plugins.enable.base.basemigration
- plugins.enable.base.connector
- plugins.enable.base.custom-data-type-dante
- plugins.enable.base.custom-data-type-gazetteer
- plugins.enable.base.custom-data-type-geonames
- plugins.enable.base.custom-data-type-georef
- plugins.enable.base.custom-data-type-getty
- plugins.enable.base.custom-data-type-gn250
- plugins.enable.base.custom-data-type-gnd
- plugins.enable.base.custom-data-type-gvk
- plugins.enable.base.custom-data-type-link
- plugins.enable.base.custom-data-type-location
- plugins.enable.base.custom-data-type-tnadiscovery
- plugins.enable.base.detail-map
- plugins.enable.base.easydb4migration
- plugins.enable.base.editor-tagfilter-defaults
- plugins.enable.base.eventmanager
- plugins.enable.base.export-transport-ftp
- plugins.enable.base.hotfolder
- plugins.enable.base.oai
- plugins.enable.base.presentation
- plugins.enable.base.remote-plugin
- plugins.enable.base.server
- plugins.url_prefix
- plugins.url_prefix_external
- plugins.url_prefix_internal
- schema.base_dir
- schema.dsn
- schema.user_dir
- server.api.settings.buildsuggest
- server.api.settings.purgeall
- server.api.settings.purgedata
- server.api.settings.reindex
- server.api.settings.restart
- server.api.user.include_password
- server.directory.imexporter
- server.directory.l10n_dir
- server.directory.logfile
- server.directory.output
- server.directory.pflib
- server.directory.server_errors
- server.directory.tmp
- server.directory.umask
- server.exporter.batch_size
- server.exporter.max_xml_size_for_xslt
- server.exporter.num_workers
- server.external_url
- server.frontend.num_services
- server.frontend.socket
- server.imexporter.num_services
- server.imexporter.socket
- server.indexer.enabled
- server.indexer.num_processes
- server.indexer.objects_per_batch
- server.janitor.eas_sync_commit
- server.janitor.enabled
- server.janitor.interval
- server.janitor.max_age
- server.mailer.enabled
- server.mailer.envelope_address
- server.mailer.interval
- server.mailer.max_attempts
- server.mailer.sender_address
- server.upload-server.num_services
- server.upload-server.socket
- smtp.from-address
- smtp.hostname
- smtp.server
- solution.name
- solution.plugins
- suggest.aggregation_chunksize
- suggest.document_chunksize
- suggest.settings
- suggest.timestamps