config/settings.yml

Contents

Environment-specific Avalon configuration options

Format

YAML

Example

production:

name:

'Avalon Media System'

#

used

in

page

titles

domain:

host:

localhost

port:

80 protocol:

http

dropbox:

path: '/usr/local/masterfiles/dropbox/'
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.
client_id: id
client_secret: secret
redis_token_store_url: redis://host:port # if different from Avalon's Redis

encoding:
engine_adapter: ffmpeg
presets_path: config/ffmpeg_presets.yml
working_file_path: '/usr/local/masterfiles

mediainfo:
path: '/usr/bin/mediainfo'

ffmpeg:
path: '/usr/bin/ffmpeg'

email:
comments: 'digitalcollections@northwestern.edu'

notification:

'digitalcollections@northwestern.edu'

support:'digitalcollections@northwestern.edu'

mailer:

:smtp # or aws_sdk if using Amazon SES
config:
address: 'mail-relay.iu.edu'

port:

587

enable_starttls_auto:

false

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"

streaming:
server: :nginx # or :wowza
content_path: /var/avalon/derivatives
http_base: http://localhost:3000/streams

stream_token_ttl:

20

#minutes

redis:
host: localhost
port: 6379

groups:
system_groups: ['administrator', 'group_manager', 'manager']

master_file_management:

strategy:

'move'

path:

'/mnt/diskarray/avalon-archive'

bib_

retriever:

protocol: sru
url: http://zgate.library.example.edu:9000/catdb
query: rec.id=%{bib_id}

 controlled_vocabulary:

path: 'config/controlled_vocabulary.yml'

fedora:
namespace: 'numedia'

minio: # if using
endpoint: http://minio:9000
public_host: http://localhost:9000 # if different from endpoint
access: <minio access key>
secret: <minio secret key>

flash_message:
type: ['success', 'notice', 'error', 'alert']
message: '<p>A test message.</p>'

redis:
host: localhost
port: 6379

db: 0 # The redis database is now configurable.  0 is the default redis database.

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

recaptcha:
site_key: # Setting a site_key will enable recaptcha on the comments form
secret_key: # Required along with site_key
type: "v2_checkbox" # or "v3"
v3:
action: "comment"
minimum_score: 0.5

google_analytics_tracking_id: "your_GA_id"

max_upload_size: "4294967296" # Change maximum file size accepted for web upload, in bytes (ex is for 4 GiB).

supplemental_files:
proxy: false
waveform:
player_width: 1200 #pixels
finest_zoom: 5 #seconds
sample_rate: 41000
active_storage:
service: local
#bucket: supplementalfiles
root: 'storage' # The directory used for storing supplemental files locally can now be configured using the root setting and in s3 or minio using the bucket setting.  This avoids the need to edit config/storage.yml

controlled_digital_lending:
enable: false
collections_enabled: false # Set Controlled Digital Lending (CDL) to be enabled or disabled by default for new collections
default_lending_period: 'P14D' # ISO8601 duration format: P14D == 14.days, PT8H == 8.hours, etc.

caption_default: # Define default values in the HLS manifest for caption language and label
language: 'eng' # language should be 3 letter ISO 639-2 code
name: 'English'

home_page:
featured_collections: ['7m01bk80s', 'qz20ss619']
carousel_collections: ['v118rd550', 'pn89d6567', 'mp48sc83h', 'qz20ss50s']

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

If using env var, set SETTINGS__EMAIL__MAILER=aws_sdk to send emails using Amazon SES 

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:

⁵

^timeout:

⁵⁰⁰⁰ 

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 

Contents

Configuration for optional Intercom feature. Allows this instance on Avalon to push contents to another instance of Avalon.

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

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