...
Info |
---|
|
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 | --- - :name: My LDAP Server :logo: auth_provider_logo.png :provider: :ldap :params: :method: :ssl :host: ldap.example.edu :port: 636 :bind_dn: cn=avalon,ou=service,dc=example,dc=edu :password: avalon_bind_password |
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/database.yml |
Purpose | Environment-specific database connection information for Rails. |
Format | YAML |
Example | production: adapter: mysql2 host: localhost database: rails username: rails password: rails pool: 5 timeout: 5000 |
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: user: fedoraAdmin password: fedoraAdmin url: http://127.0.0.1:8984/fedora4/rest base_path: /prod |
|
config/intercom.yml |
---|
Contents | Configuration for optional Intercom feature. Allows this instance on Avalon to push contents to another instance of Avalon. The streaming files will remain in place. Both instances of Avalon must be able to stream from that location. 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` |
Format | YAML |
Example | intercom: default: url: https://some.avalon.com/ api_token: a_valid_token import_bib_record: true publish: false push_label: text for the 'push' button |
|
config/matterhorn.yml |
Contents | Environment-specific Matterhorn connection information for Avalon's Matterhorn adapter |
Format | YAML |
Example | production: url: http://matterhorn_system_account:CHANGE_ME@127.0.0.1:8080/ |
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: url: http://localhost:8983/solr/avalon |
|
|
config/role_map_<environment>.yml |
Contents | Role groups and associated members to initialize the Hydra access controls database with |
Format | YAML |
Example | collection_manager: - archivist1@example.edu - archivist2@example.edu group_manager: - donor1@example.com manager: - researcher1@example.edu administrator: - user1@example.edu - user2@otherinstitution.edu |
Notes | Example environments: development, production, test. So the filename would look like role_map_production.yml for the production environment. |
config/controlled_vocabulary.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 | org.opencastproject.server.url : Public URL of the Matterhorn server
org.opencastproject.streaming.url : Base URL of the streaming application
org.opencastproject.streaming.directory : Directory where streaming derivatives will be written
org.opencastproject.composer.ffmpegpath : Location of the ffmpeg binary
org.opencastproject.inspection.mediainfo.path : Location of the mediainfo binary
org.avalonmediasystem.avalon.url : Base URL of the Avalon server
|
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. |