Page tree

Versions Compared

Key

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

This documentation is for Release 6.3.x.
For older releases:

  • Release 6.2.x, see v.51.
  • Release 5.x, see v.47.
  • Release 4.0, see v.40.
  • Release 3.3, see v.36.
  • Release 3.2, see v.32.
  • Release 3.0 and 3.1 version of this page, see v.31.
  • Release 2 version of this page, see v.21.
  • Release 1 version of this page, see v.9.

...

Table of Contents

Avalon Web Application

authentication.ymlThe name and logo 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/

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
Notes

settings

.

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'
flash_message:
type: ['success', 'notice', 'error', 'alert']
message: '<p>A test message.</p>'
 solr:
configset: avalon
configset_source_path: <%= File.join(Rails.root, 'solr', 'config') %>
collection_options:
async:
auto_add_replicas:
collection:
config_name: avalon
create_node_set:
max_shards_per_node:
num_shards: 1
replication_factor:
router:
name:
field:
rule:
shards:
snitch:
zookeeper:
connection_str: "localhost:9983/configs"

redis:
host: localhost
port: 6379

 controlled_vocabulary:
path: config/controlled_vocabulary.yml
auth:
configuration:
# List of available Authentication Providers and associated configurations.
# 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.
  - :name: Avalon Test Auth
:provider: :identity
:params:
:fields:
- :email
- :name: Avalon Lti OAuth
:provider: :lti
:hidden: true
:params:
:oauth_credentials:
somekey: somevalue
  - :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

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/settings/<environment>.local.yml


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/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`

FormatYAML
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
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

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.

...