...
config/avalon.yml
...
Info |
---|
This documentation is for Release 3.x. For the Release 1 version of this page, see v.9. For the Release 2 version of this page, see v.21. |
Table of Contents |
---|
Avalon Web Application
...
config/authentication.yml
...
---
- :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
...
NoteChanges to configuration files often require restarting Avalon to take affect. They also require Sidekiq (the background jobs processor) to be restarted. It's recommended to override the default settings by creating a You can also use environment variables, for example |
Warning |
---|
Since the Config gem doesn't support arrays in environment variable,
|
Table of Contents |
---|
Configuration Files and Values
config/settings.yml | |
Contents | Environment-specific Avalon configuration options |
Format | YAML |
Example | production: |
controlled_vocabulary:
path: 'config/controlled_vocabulary.yml'
dropbox: name: 'Avalon Media System' # used in page titles |
upload_uri: |
' |
sftp://localhost/srv/avalon/dropbox' google_drive: # Google Drive is now an option for the dropbox modal. See Google Drive Dropbox for more details. encoding: mediainfo: ffmpeg: |
email: |
comments: |
'digitalcollections@northwestern.edu' |
notification: |
'digitalcollections@northwestern.edu' |
support:'digitalcollections@northwestern.edu' |
mailer: |
smtp:
address:
:smtp # or aws_sdk if using Amazon SES |
port: |
587 |
enable_starttls_auto: |
false solr: |
configset: |
path: '/usr/bin/ffmpeg'
fedora:groups:
namespace: 'numedia'
system_groups: ['administrator',
avalon streaming: redis: |
'manager'] |
master_file_management: |
media_path: '/usr/local/masterfiles'
mediainfo:
path: '/usr/bin/mediainfo'
streaming:
server: :generic # or :adobe
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'
strategy: 'move' bib_retriever: controlled_vocabulary: path: 'config/controlled_vocabulary.yml' fedora: redis: controlled_vocabulary: - :name: My LDAP Server
supplemental_files:
| |
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 If using env var, set | |
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 | |
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: |
url: |
https:// |
some.avalon.com/ | |
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/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 |
- |
donor1@example.com |
- |
researcher1@example.edu |
- |
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
See Managing Controlled Vocabularies.
Opencast Matterhorn
...
etc/config.properties
...
org.opencastproject.server.url
: Public URL of the Matterhorn serverorg.opencastproject.streaming.url
: Base URL of the streaming applicationorg.opencastproject.streaming.directory
: Directory where streaming derivatives will be writtenorg.opencastproject.composer.ffmpegpath
: Location of the ffmpeg binaryorg.opencastproject.inspection.mediainfo.path
: Location of the mediainfo binaryorg.avalonmediasystem.avalon.url
: Base URL of the Avalon server
...
etc/encoding/avalon.properties (ADVANCED)
...
etc/workflows/avalon-video.xml (ADVANCED)
...
etc/workflows/avalon-audio.xml (ADVANCED)
...
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.