Configuration

You can configure Omeka S by editing config/local.config.php. Options from the application and module configuration files are merged into local configuration and used by Omeka S services to operate the application. See the following files to reference default options and their format (do not modify the files):

• application/config/module.config.php
• application/config/navigation.config.php
• application/config/routes.config.php

Local configuration comes with options that are most likely to be changed from one installation to another. Feel free to add more depending on your system's requirements.

navigation

Navigation configuration. Details about configuration can be found in Zend's documentation.

router

Router configuration. Details about configuration can found in Zend's documentation.

session

• config: Session configuration options. Options can be found in Zend's documentation.
• save_handler: The session save handler service (must implement Zend\Session\SaveHandler\SaveHandlerInterface). Set this to null to use the database save handler.

listeners

A list of MVC listeners. Add module-specific listeners to MVC events.

view_manager

View manager options. Options can be found in Zend's documentation.

assets

Configuration for asset files.

• use_externals: Whether to use external assets.
• externals: Lists of external asset URLs, keyed by local asset path.

permissions

Configuration for the access control list (ACL).

• acl_resources: A list of resources to load into the access control list. API adapters, Doctrine entities, and controllers that are registered in configuration are automatically loaded.

temp_dir

The path to the temporary directory.

entity_manager

Doctrine entity manager options.

• is_dev_mode: Whether to run the entity manager in development mode. See Doctrine's documentation for more information.
• mapping_classes_paths: A list of paths containing Doctrine entity classes.
• resource_discriminator_map: A list of entities that are mapped to Omeka's Resource entity (for first-class resources that can be described using values).

installer

• pre_tasks: A list of tasks to run before installation, usually to check environment.
• tasks: A list of tasks to run during installation.

translator

• locale: The language code for this locale.
• translation_file_patterns: Options for translation.

logger

Logging options for application-level messages.

• log: Whether to log messages.
• path: The path to the log file. The file must be writable by your web server.

http_client

• adapter: The connection adapter class to use.
• sslcapath: The path to the SSL certificate directory.
• sslcafile: The path to the SSL certificate file.

You can add other configuration options to this list, from Zend's documentation.

cli

• execute_strategy: The CLI execution strategy to use, either "exec" to use PHP's exec() or "proc_open" to use PHP's proc_open().
• phpcli_path: The path to PHP CLI.

file_manager

• store: The file store service, responsible for managing the storage of files.
• thumbnailer: The thumbnailer service, responsible for creating derivative images of files.
• thumbnail_types: The types of thumbnails to create and store, including the strategy and pixels constraint.
• thumbnail_options
  • imagemagick_dir: The path to the directory where the ImageMagick command is.
  • page: The page from which to create a thumbnail in a multi-paged file.
• thumbnail_fallbacks: A list of fallback images for files that have no thumbnail derivatives, keyd by the original file type.

service_manager

A list of services.

controllers

A list of controllers.

controller_plugins

A list of controller plugins.

api_adapters

A list of API adapters.

view_helpers

A list of view helpers.

data_types

A list of data types.

block_layouts

A list of block layouts.

navigation_links

A list of navigation links.

media_ingesters

A list of media ingesters.

media_renderers

A list of media renderers.

file_renderers

A list of file renderers.

oembed

A whitelist of URL patterns for oEmbed media.

mail

• transport:
• default_message_options: