Info | |
---|---|
title | 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: |
name: |
'Avalon |
Media |
System' |
# |
used |
in |
page |
titles |
|
host: |
localhost |
port: |
80 |
protocol: |
http |
'/usr/local/masterfiles/dropbox/' |
'sftp://localhost/srv/avalon/dropbox' 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 |
protocol: sru
url: http://zgate.library.example.edu:9000/catdb
query: rec.id=%{bib_id}
controlled_vocabulary:
path: 'config/controlled_vocabulary.yml' |
email: |
comments: |
'digitalcollections@northwestern.edu' |
notification: |
'digitalcollections@northwestern.edu' |
support:'digitalcollections@northwestern.edu' |
mailer: |
:smtp |
# |
or |
aws_sdk |
if |
using |
Amazon |
SES |
config: |
address: |
port: |
587 |
enable_starttls_auto: |
false |
solr: |
configset: |
namespace: 'numedia'
groups:streaming:
system_groups: ['administrator', 'group_manager', 'manager']
server: :nginx # or :wowza
content_path:
avalon streaming: |
http_base: |
stream_token_ttl: |
20 |
#minutes redis: master_file_management: |
strategy: |
'move' |
path: |
'/mnt/diskarray/avalon-archive' bib_retriever: controlled_vocabulary: path: ' |
config/controlled_vocabulary.yml' fedora:
|
# |
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> |
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"
controlled_vocabulary: |
path: |
config/controlled_vocabulary.yml |
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 |
site_key: |
"site_key" |
secret_key: |
"secret_key"
|
"your_GA_id"
|
"4294967296" |
# |
Increase |
maximum |
file |
size |
accepted |
for |
web |
upload |
to |
4 |
gigabytes supplemental_files: # Choose whether every collection has CDL enabled or disabled by default collections_enabled: false
# Language should be 2 or 3 letter ISO 639 codes language: 'en'
|
['7m01bk80s', |
'qz20ss619'] |
['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 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 |
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. |
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 |
- |
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
...