Versions Compared

Old Version 48

changes.mady.by.user Phuong Dinh

Saved on

compared with

New Version 49

changes.mady.by.user mschnaar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
titleNote

Changes to configuration files often require restarting avalon Avalon to take affect. They also require Resque , (the background jobs processor, ) to be restarted.

 

Table of Contents

...

config/authentication.yml

PurposeList of available Authentication Providers and associated configurations.
FormatYAML
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
NotesThe 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/avalon.yml

 
ContentsEnvironment-specific Avalon configuration options
FormatYAML
Example
production:
 name: 'Avalon' # used in page titles

 domain:
   host: localhost
   port: 3000
   protocol: http

 bib_retriever:
   protocol: sru
   url: http://zgate.library.example.edu:9000/catdb
   query: rec.id=%{bib_id}
 controlled_vocabulary:
   path: 'config/controlled_vocabulary.yml'
 dropbox:
   path: '/usr/local/masterfiles/dropbox/'
   upload_uri: 'sftp://localhost/srv/avalon/dropbox'
 email:
   comments: 'digitalcollections@northwestern.edu'
   notification: 'digitalcollections@northwestern.edu'
   support:'digitalcollections@northwestern.edu'
   mailer:
     smtp:
       address: 'mail-relay.iu.edu'
       port: 587
       enable_starttls_auto: false
 ffmpeg:
   path: '/usr/bin/ffmpeg'
 fedora:
   namespace: 'numedia'
 groups:
   system_groups: ['administrator', 'group_manager', 'manager']
 matterhorn:
   root: 'http://avalon-mhorn-dev.library.northwestern.edu:8080/'
   media_path: '/usr/local/masterfiles'
 mediainfo:
   path: '/usr/bin/mediainfo'
 streaming:
   server: :generic # or :adobe
   content_path: /var/avalon/rtmp_streams
   rtmp_base: rtmp://localhost/avalon
   http_base: http://localhost:3000/streams
   stream_token_ttl: 20 #minutes
 master_file_management:
   strategy: 'move'
   path: '/mnt/diskarray/avalon-archive'
Notes

Managing Master File ManagementFiles 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/database.yml

PurposeEnvironment-specific database connection information for Rails.
FormatYAML
Example
production:
  adapter: mysql2
  host: localhost
  database: rails
  username: rails
  password: rails
  pool: 5
  timeout: 5000 
NotesSee 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

ContentsEnvironment-specific Fedora repository connection information for Hydra
FormatYAML
Example
production:
  user: fedoraAdmin
  password: fedoraAdmin
  url: http://127.0.0.1:8984/fedora4/rest
 base_path: /prod 
 

config/matterhorn.yml

ContentsEnvironment-specific Matterhorn connection information for Avalon's Matterhorn adapter
FormatYAML
Example
production:
  url: http://matterhorn_system_account:CHANGE_ME@127.0.0.1:8080/
NotesThis 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

PurposeEnvironment-specific Solr connection information for Hydra
FormatYAML
Example
production:
  url: http://localhost:8983/solr/avalon
 

config/role_map_<environment>.yml

ContentsRole groups and associated members to initialize the Hydra access controls database with
FormatYAML
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
NotesExample environments: development, production, test. So the filename would look like role_map_production.yml for the production environment.

...