This documentation is for Release 6.3.x.
For older releases:
Note
Changes to configuration files often require restarting Avalon to take affect. They also require Resque (the background jobs processor) to be restarted.
Avalon Web Application
config/authentication.yml | |
---|---|
Purpose | List of available Authentication Providers and associated configurations. |
Format | YAML |
Example | --- |
Notes | The name and logo settings are used when displaying multiple auth providers to choose from at login time. provider and params are passed directly to config.omniauth as described in the Devise OmniAuth Overview. |
config/settings.yml | |
Contents | Environment-specific Avalon configuration options |
Format | YAML |
Example | production: name: 'Avalon' # used in page titles controlled_vocabulary: path: 'config/controlled_vocabulary.yml' dropbox: email: ffmpeg: fedora: groups: matterhorn: solr: controlled_vocabulary: |
Notes | Managing Master Files explains available strategies for how avalon can handle master files after they have been processed. Bibliographic Import Configuration explains how to configure Avalon to import metadata from an external source such as an OPAC. Config overwrites should be placed in |
config/database.yml | |
Purpose | Environment-specific database connection information for Rails. |
Format | YAML |
Example | production: |
Notes | See Configuring a Database in the Ruby on Rails Getting Started Guide for more options. Changing the database adapter will require updating Gemfile to require the correct adapter. Here are the instructions for installing the mysql adapter called mysql2. |
config/fedora.yml | |
Contents | Environment-specific Fedora repository connection information for Hydra |
Format | YAML |
Example | production: |
config/intercom.yml | |
Contents | Configuration for optional Intercom feature. Allows this instance on Avalon to push contents to another instance of Avalon. |
Format | YAML |
Example | intercom: |
Notes | Intercom utilizes the Ingest API and requires an API token to connect. This token is generated on the target Avalon with `bundle exec rake avalon:token:generate username=archivist email=archivist1@example.com` The streaming files will remain in place. Both instances of Avalon must be able to stream from that location. |
config/matterhorn.yml | |
Contents | Environment-specific Matterhorn connection information for Avalon's Matterhorn adapter |
Format | YAML |
Example | production: |
Notes | This file specifies the system account used to send media to and fetch updates from Matterhorn, as opposed to the public Matterhorn root URL provided in avalon.yml, which is used solely for client-side interactions. |
config/solr.yml | |
Purpose | Environment-specific Solr connection information for Hydra |
Format | YAML |
Example | production: |
config/role_map_<environment>.yml | |
Contents | Role groups and associated members to initialize the Hydra access controls database with |
Format | YAML |
Example | collection_manager: |
Notes | Example environments: development, production, test. So the filename would look like role_map_production.yml for the production environment. |
config/controlled_vocabulary.yml
See Managing Controlled Vocabularies.
config/secrets.yml
Rails 4+ uses a secrets.yml file to store a secret key used for signed cookies as well as other things. See http://edgeguides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml for more information.
Opencast Matterhorn
etc/config.properties | |
---|---|
Contents | Configuration info for Matterhorn |
Format | key=value |
Relevant Keys |
|
Notes | Other keys and their values are documented in comments within the file |
etc/encoding/avalon.properties (ADVANCED) | |
Contents | Specifics of Avalon transcoding operations |
Format | key=value |
Notes | Allows specific tweaking of ffmpeg parameters for different content types and quality levels |
etc/workflows/avalon-video.xml (ADVANCED) | |
etc/workflows/avalon-audio.xml (ADVANCED) | |
Contents | Avalon-related transcoding and processing workflows |
Format | XML |
Notes | See the Matterhorn Workflow Documentation (registration required). If using Adobe Media Server be sure to disable the distribute-hls step in both files. |