Page tree

Versions Compared


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

Recipe instructions for building your own virtual machine

Install EPEL

rpm -ivh


Make sure a valid hostname is resolvable

The default hostname is “”, so name the machine this and enter it into /etc/hosts

# hostname
# cat /etc/hosts   localhost localhost.localdomain localhost4 localhost4.localdomain4

Install the NUL repository information into /etc/yum.repos.d/nul-public.repo, and place the GPG key in the proper location:


Contents of nul-public.repo

name=NUL Library Public RHEL repository

NUL yumrepo GPG key


Disable SELinux

setenforce 0

Stop iptables

service iptables stop

Development Libraries

yum groupinstall “Development Tools”

Ruby development packages for building Ruby:

yum install readline-devel zlib-devel libyaml-devel libffi-devel openssl-devel libxml2-devel libxslt-devel


Install Apache Tomcat with the nulrepo-public repository configured and enabled.

yum install tomcat
service tomcat start

Change the Tomcat connector port on line 70 of /usr/local/tomcat/conf/server.xml to port 8983:

<Connector port="8983" protocol="HTTP/1.1"

Restart tomcat

service tomcat restart


Download the solr tarball and unpack it to /usr/local/solr/:

tar xvf solr-4.2.0.tgz
mv solr-4.2.0 /usr/local/solr
cd /usr/local/solr/dist/
cp solr-4.2.0.war /usr/local/tomcat/webapps/solr.war
mv solr-4.2.0.war /usr/local/solr/solr.war

Place into /usr/local/tomcat/conf/Catalina/localhost/solr.xml:

<Context docBase="/usr/local/solr/solr.war" debug="0" crossContext="true">
<Environment name="solr/home" type="java.lang.String" value="/usr/local/solr" override="true"/>

Place into /usr/local/solr/solr.xml:

<?xml version="1.0" encoding="UTF-8" ?>
<solr persistent="true">
<cores defaultCoreName="avalon" adminPath="/admin/cores" zkClientTimeout="${zkClientTimeout:15000}" hostPort="8983" hostContext="solr">
    <core instanceDir="avalon/" name="avalon"/>


mkdir /usr/local/solr/lib

mv /usr/local/solr/dist/* /usr/local/solr/lib/

mv /usr/local/solr/contrib /usr/local/solr/lib/



unzip master

mv puppet-solr-master/files/avalon /usr/local/solr

chown -R tomcat7:tomcat /usr/local/solr/

chown -R tomcat7:tomcat /usr/local/tomcat

service tomcat restart



Install MySQL server 

yum install mysql-server

service mysqld start


and create 1 user with ALL privileges to 1 database for Fedora Commons Repository software, and 1 user with 1 database for the Avalon web application. 



create database fedora3;

create user ‘fcrepo’@’localhost’ identified by ‘fcrepo’;

grant all privileges on fedora3.* to 'fcrepo'@'localhost';

flush privileges;


create database rails;

create user 'rails'@'localhost' identified by 'rails';

grant all privileges on rails.* to 'rails'@'localhost';

flush privileges;



Please see documentation for your version of MySQL Server for detailed syntax (



Fedora Commons repository


java -jar fcrepo-installer-3.6.2.jar

Enter values:

Installation type: custom

Fedora home directory: /usr/local/fedora

fedoraAdmin password: fedoraPassword

server host: localhost

Application context: fedora

require authentication for api-a: false

ssl availability: true 

ssl required for api-a: false

ssl required for api-m: true

servlet engine: existingTomcat

tomcat home: /usr/local/tomcat

tomcat http port: 8389

tomcat shutdown port: 8005

tomcat secure port: 8443

keystore file: default

password for keystore: changeit

keystore type: jks

database: mysql

mysql jdbc driver: included

database username:fcrepo

database password: fcrepo

jdbc url: default jdbc:mysql://localhost/fedora3?useUnicode=true&amp;characterEncoding=UTF-8&amp;autoReconnect=true

jdbc driverclass:  default


accept remaining defaults


chown -R tomcat7:tomcat /usr/local/fedora

service tomcat restart


Red5 media server

useradd red5


tar xvf red5-1.0.1.tar.gz

mv red5-server-1.0 /usr/local/red5


mv /etc/rc.d/init.d/red5

chown -R red5:red5 /usr/local/red5

chmod +x /etc/rc.d/init.d/red5



Install prerequisite packages using yum and the NUL-public repository:



































Download ffmpeg SRPM


Install rpmdev-setuptree

yum install rpmdevtools

As any non-root user, install ffmpeg srpm

su - red5


rpm -ivh


   1:ffmpeg                 warning: user makerpm does not exist - using root

warning: group makerpm does not exist - using root

########################################### [100%]

warning: user makerpm does not exist - using root

warning: group makerpm does not exist - using root

Build ffmpeg binary as non-root and install as root

[as not root] rpmbuild -bb rpmbuild/SPECS/ffmpeg12.spec

[as root] rpm -ivh /home/red5/rpmbuild/RPMS/x86_64/ffmpeg-*.rpm



Create user for matterhorn

useradd matterhorn

Create user for avalon

useradd avalon



tar xvf 1.4.x

mv avalon-felix-1.4.x /usr/local/matterhorn


mv /etc/init.d/matterhorn

chmod +x /etc/init.d/matterhorn

chown -R matterhorn:matterhorn /usr/local/matterhorn


Install in /usr/local/matterhorn/etc: 


mv /usr/local/matterhorn/etc/

Matterhorn for streaming files

[security.pp ~line 37]

mkdir /usr/local/red5/webapps/avalon/streams

chown red5:avalon 

chmod 0775 /usr/local/red5/webapp/avalon/streams

ln -s /usr/local/red5/webapps/avalon/streams /var/avalon/rtmp_streams


 mkdir /var/avalon/hls_streams

chown avalon:avalon /var/avalon/hls_streams/

ln -s /var/avalon/hls_streams/ /var/www/avalon/public/streams

chmod 0775 /var/avalon/hls_streams/


add matterhorn user into the avalon group


Install sqlite-devel

yum install sqlite-devel

Create avalon user


[root@localhost avalon]# useradd avalon

mkdir /var/www/avalon

[root@localhost avalon]# chown -R avalon:avalon /var/www/avalon

[root@localhost avalon]# su - avalon


As Avalon user, Install RVM and ruby 1.9.3-p392

# curl -L | bash -s stable --ruby=1.9.3


As Avalon user, Source the RVM shell

# source /home/avalon/.rvm/scripts/rvm

As Avalon user, Install Passenger via Gem

gem install passenger

As Avalon user, Check to make sure passenger installed in the expected location


$ passenger-config --root



Install Passenger apache module requirements (as root)

yum install curl-devel httpd httpd-devel apr-devel apr-util-devel


As Avalon user, build passenger for your version of Apache and Ruby.

[avalon@localhost ~]$ passenger-install-apache2-module


create an appropriate apache configuration file passenger.conf with appropriate settings.  Example contents of /etc/httpd/conf.d/passenger.conf


LoadModule passenger_module /home/avalon/.rvm/gems/ruby-1.9.3-p392/gems/passenger-3.0.19/ext/apache2/

<IfModule passenger_module>

   PassengerRoot /home/avalon/.rvm/gems/ruby-1.9.3-p392/gems/passenger-3.0.19

   PassengerRuby /home/avalon/.rvm/wrappers/ruby-1.9.3-p392/ruby

  PassengerMaxPoolSize 30

  PassengerPoolIdleTime 300

  PassengerMaxInstancesPerApp 0


  PassengerMinInstances 3

  PassengerSpawnMethod smart-lv2





Apache security configuration

Retrieve and place into /usr/local/sbin

chmod +x /usr/local/sbin/avalon_auth



and place into /etc/httpd/conf.d/

Create a virtual host for avalon in /etc/httpd/conf.d/avalon.conf

Retrieve and place into /etc/httpd/conf.d/


Restart apache.  With apache running, check passenger-status:

[avalon@localhost ~]$ which passenger-status


As Root

mkdir /var/www/avalon

chown avalon:avalon /var/www/avalon

As avalon user:

git clone git:// /var/www/avalon/.

git checkout release/1.0.0

rm  /var/www/avalon/.rvmrc

cd /var/www/avalon

bundle install



Add to /var/www/avalon/config/setup_load_paths.rb

if ENV['MY_RUBY_HOME'] && ENV['MY_RUBY_HOME'].include?('rvm')
    gems_path = ENV['MY_RUBY_HOME'].split(/@/)[0].sub(/rubies/,'gems')
    ENV['GEM_PATH'] = "#{gems_path}:#{gems_path}@global"
    require 'rvm'
    RVM.use_from_path! File.dirname(File.dirname(__FILE__))
  rescue LoadError
    raise "RVM gem is currently unavailable."
# If you're not using Bundler at all, remove lines bellow
ENV['BUNDLE_GEMFILE'] = File.expand_path('../Gemfile', File.dirname(__FILE__))
require 'bundler/setup'

edit /var/www/avalon/.ruby-version and enter 1.9.3-p327

cp config/authentication.yml.example config/authentication.yml

edit config/database.yml

  adapter: mysql2
  database: rails

  username: rails

  password: rails

  pool: 5

  timeout: 5000

yum install mysql-devel

gem install activerecord-mysql2-adapter

gem install mysql2


edit Gemfile.local:

gem 'mysql2', '~>0.3.11'

edit solr.yml


    url: http://localhost:8983/solr/

edit fedora.yml


  user: fedoraAdmin

  password: FedoraPassword



create config/matterhorn.yml


  url: http://matterhorn_system_account:CHANGE_ME@localhost:8080/


Visit port 80

Sign in

Create identify:


This is a known identity with administrative privileges.


Start delayed_job:

in /var/www/avalon (as avalon user)

bundle exec rake delayed_job:start


Red5 Avalon Security Webapp

cd /usr/local/red5/webapps


tar xvzf red5-avalon.tar.gz

chown -R red5:red5 avalon/

edit /usr/local/red5/webapps/avalon/WEB-INF/


Restart red5



This documentation is for Release 7.0 and above. For documentation on previous releases, please select from the options below.

  • Release 1.x version of this page: v.81
  • Release 2.x version of this page: v.87.
  • Release 3.0-3.1 version of this page: v.111.
  • Release 3.2 version of this page: v.116.
  • Release 4.0 version of this page: v.143.
  • Release 5.x version of this page: v.163.
  • Release 6.0 version of this page: v.177
  • Release 6.3-6.5 version of this page: v.201

These instructions provide a recipe for building your own all-in-one Avalon system from scratch on CentOS or Red Hat Enterprise Linux version 7.x.  Please note that while an all-in-one installation as outlined here is certainly suitable for testing and demos, a single, all-in-one, server may not be suitable for production environments.

Table of Contents

Ready the Installation Environment


The instructions below require being run as root unless specifically noted otherwise.

Storage requirement

Avalon and components need about 20GB of disk space to install.

Open ports requirement

The Avalon Media System requires several ports to be open to client browsers.

Here are the port settings that will need to be configured:

80HTTP (Avalon)Yes
8983HTTP (Solr)No
8984HTTP (Fedora)No
8980HTTP (Nginx)Yes

The preferred method is to create a shell script that will do the work for you. Here is an example script that you should look through and customize as needed:


If you're connected over ssh, it might kick you off.

Save your script to /etc/sysconfig/, make it executable and run it.

Code Block
chmod +x /etc/sysconfig/

If you run into connection issues you can disable the iptables, by running "service iptables stop". This will completely drop your firewall. When finished troubleshooting run "service iptables start".

Disable SELinux

Code Block
vim /etc/selinux/config #change the value of `SELINUX` from `enforcing` to `permissive`

You may have to disable SELinux completely if there's Passenger installation problem

vim /etc/selinux/config #change the value of `SELINUX` to `disabled`

Reboot to apply change

Code Block
shutdown -r now

Install EPEL

This package has libyaml-devel which is required by ruby and not provided by Redhat.

Code Block
yum install

Install development libraries and packages for building Ruby

Code Block
yum groupinstall "Development Tools"
yum install readline-devel zlib-devel libyaml-devel libffi-devel openssl-devel libxml2-devel libxslt-devel cmake

Install Java 8

Code Block
yum install java-1.8.0-openjdk

Main Components



MariaDB is now the default database system for CentOS/RHEL7 and can be used interchangeably with MySql.  MySql or PostgreSQL can be substituted if desired.

Avalon uses MariaDB for storing search queries, user data and roles, and as a back end our encoding dashboard. 

Install MariaDB server 

Code Block
yum install mariadb-server
systemctl start mariadb

Fedora Commons Repository


Fedora runs as a webapp in Tomcat

Install Apache Tomcat 

Code Block
titleRHEL 7
yum install tomcat
vim /etc/tomcat/server.xml #line 71, change the Tomcat connector port from 8080 to 8984

Add Tomcat manager user

By default, no user has access to the Tomcat Manager App. Define a user in /etc/tomcat/tomcat-users.xml with access to the manager-gui role. Below is a very basic example.

Code Block
  <role rolename="manager-gui"/>
  <user username="admin" password="<insert strong password here>" roles="manager-gui"/>

Create Fedora user and database

Enter the mariadb client

Code Block
mariadb> create database fcrepo CHARACTER SET utf8 COLLATE utf8_general_ci;
mariadb> create user 'fcrepo'@'localhost' identified by '<fcrepo_password>';
mariadb> grant all privileges on fcrepo.* to 'fcrepo'@'localhost';

mariadb> create database rails CHARACTER SET utf8 COLLATE utf8_general_ci;
mariadb> create user 'rails'@'localhost' identified by '<rails_pasword>';
mariadb> grant all privileges on rails.* to 'rails'@'localhost';

mariadb> flush privileges;

Check your work and exit

Code Block
mariadb> show databases;
| Database           |
| information_schema |
| mysql              |
| fcrepo             |
| performance_schema |
| test               |
5 rows in set (0.00 sec)
mariadb> exit;

Configure Tomcat for Fedora

Append the following to /etc/tomcat/tomcat.conf

Code Block
JAVA_OPTS="-Dfcrepo.modeshape.configuration=classpath:/config/jdbc-mysql/repository.json -Dfcrepo.mysql.username=fcrepo -Dfcrepo.mysql.password=<fcrepo_password> -Dfcrepo.mysql.port=3306 -Dfcrepo.home=/var/avalon/fedora/"

Download and run the fcrepo installer

Code Block
mkdir -p /var/avalon/fedora
chown tomcat:tomcat /var/avalon/fedora
wget -O /usr/share/tomcat/webapps/fedora4.war

Restart Tomcat

Code Block
systemctl restart tomcat

See if you can access Fedora's REST interface at http://<server host name>:8984/fedora4/rest

Try it out on your local machine and on another machine. If you can't reach the app from another machine, your iptables might need to be changed to allow access. If Fedora is not up, check the tomcat logs in /var/log/tomcat/. Catalina.out and localhost.<date>.log usually provide the best information.


Avalon makes use of Solr through the Blacklight gem for faceting and relevance-based searching.

Install prerequisites

Code Block
yum install lsof

Download the solr tarball and run the installation script

Download Solr from

Code Block
tar xzf solr-6.6.6.tgz solr-6.6.6/bin/ --strip-components=2
bash ./ solr-6.6.6.tgz

By default, the script extracts the distribution archive into /opt, configures Solr to write files into /var/solr, and runs Solr as the solr user. Follow the linked guide if you wish to change these defaults.

Create Avalon core for Solr

Code Block
mkdir -p /tmp/avalon_solr/
wget -O /tmp/avalon_solr/solrconfig.xml
wget -O /tmp/avalon_solr/schema.xml
su solr # Needs to run as solr user
/opt/solr/bin/solr create_core -c avalon -d /tmp/avalon_solr

If you have successfully installed Solr you should be able to access the dashboard page at http://<server host name>:8983/solr

Instructions on how to manually start/stop Solr:

Media Streaming Server

An HLS-enabled server like Wowza, Adobe Media Server (commercial) or Nginx + the HLS module (open-source) can take an mp4 created by Avalon and stream it on the fly.

Nginx instructions

Code Block
titleInstall Nginx with vod module
rpm -ihv
yum install kaltura-nginx

Add /etc/nginx/nginx.conf

Code Block
user nginx;
worker_processes 4;

events {
  worker_connections 1024;

http {
  server {
    listen 8980;

    vod_mode local;
    vod_last_modified 'Sun, 19 Nov 2000 08:52:00 GMT';
    vod_last_modified_types *;
    vod_metadata_cache metadata_cache 512m;
    vod_response_cache response_cache 128m;
    gzip on;
    gzip_types application/;
    open_file_cache          max=1000 inactive=5m;
    open_file_cache_valid    2m;
    open_file_cache_min_uses 1;
    open_file_cache_errors   on;

    location ~ ^/avalon/(?<stream>.+)/(?<resource>.+\.(?:m3u8|ts)) {
      alias /var/avalon/derivatives/$stream;
      vod hls;

      set $token "$arg_token";
      add_header X-Stream-Auth-Token "$token";
      sub_filter_types application/;
      sub_filter_once off;
      sub_filter '.ts' ".ts?token=$token";

      auth_request /auth;
      add_header Access-Control-Allow-Headers '*';
      add_header Access-Control-Expose-Headers 'Server,range,Content-Length,Content-Range';
      add_header Access-Control-Allow-Methods 'GET, HEAD, OPTIONS';
      add_header Access-Control-Allow-Origin '*';
      expires 100d;

    location = /auth {
      # resolver;
      proxy_pass_request_body off;
      proxy_set_header Content-Length "";
      proxy_set_header X-Original-URI $request_uri;


listen should use a public open port.

alias should point to where the actual stream files are.

proxy_pass needs changing if installing Nginx on a different server.

Add /lib/systemd/system/nginx.service

Code Block
Description=The NGINX HTTP and reverse proxy server

ExecStartPre=/usr/sbin/nginx -t
ExecReload=/usr/sbin/nginx -s reload
ExecStop=/bin/kill -s QUIT $MAINPID


Add nginx user and let it own nginx stuff

Code Block
useradd -M -s /bin/nologin nginx
chown -R nginx:nginx /etc/nginx /var/log/nginx 

Make 8980 bindable and start nginx

Code Block
semanage port -a -t http_port_t  -p tcp 8980
systemctl start nginx

Later: Avalon config should be updated to be compatible with Nginx:

Code Block
  server: :nginx
  http_base: 'http://localhost:8980/avalon'
  content_path: '/var/avalon/derivatives'


If you enable SSL on Avalon server, you should also enable SSL on the streaming server to avoid Mixed content warning.

FFmpeg & Mediainfo

titleDownload prebuilt ffmpeg

The following prebuilt binaries are provided by a third party. Proceed with caution.

Download and install ffmpeg (for transcoding & thumbnails)

Code Block
mkdir -p /tmp/ffmpeg && cd /tmp/ffmpeg
curl | tar xJ
cp `find . -type f -executable` /usr/bin/

Install Mediainfo (for technical metadata)

Code Block
yum install mediainfo


Install and start the httpd service.

Code Block
yum install httpd
systemctl start httpd

Apache Passenger and Ruby

Change current user to avalon then install RVM and ruby 2.4.1

Code Block
yum install ruby sqlite-devel # Needed to build Ruby using RVM.
useradd avalon
su - avalon
curl -L | bash -s stable --ruby=2.5.5

Source the RVM shell (as avalon user) or close the terminal and open it back up.

Code Block
source /home/avalon/.rvm/scripts/rvm
rvm use 2.5.5

Install Passenger apache module requirements (as root)

Code Block
yum install pygpgme curl
curl --fail -sSLo /etc/yum.repos.d/passenger.repo

yum install mod_passenger || yum-config-manager --enable cr && yum install mod_passenger

Create a virtual host for avalon

Code Block
wget --no-check-certificate -P /etc/httpd/conf.d/
vim /etc/httpd/conf.d/20-avalon.conf

In 20-avalon.conf add this line inside the VirtualHost tag:

Code Block
RailsEnv production

If using SSL, the following fix should be added to address BEAST, POODLE, RC4 issues (after the SSLEngine on)

Code Block
SSLProtocol all -SSLv2 -SSLv3

Modify /etc/httpd/conf.d/passenger.conf

Code Block
PassengerRuby /home/avalon/.rvm/rubies/ruby-2.5.5/bin/ruby

Validate passenger install and restart apache

Code Block
passenger-config validate-install
systemctl start httpd


Grab Avalon code from github

Code Block
git clone /var/www/avalon
chown -R avalon:avalon /var/www/avalon

Set rails environment to production, if it has not defaulted to this. On the first line of /var/www/avalon/config/environment.rb make sure it says 'production'

Code Block
ENV['RAILS_ENV'] ||= 'production'

Configure database settings

Code Block
cd /var/www/avalon/config
vim database.yml

Replace database.yml with the correct values for your production environment. Note that the pool setting should be equal or exceed the number of concurrent jobs in Sidekiq.

Code Block
  adapter: mysql2
  host: localhost
  database: rails
  username: rails
  password: rails
  pool: 20
  timeout: 5000

Install the mysql2 adapter 

Code Block
yum install cmake #<--will be required for rugged gem
yum install mariadb-devel

Install gems

Run the bundle install

Code Block
# as root
yum install nodejs # Javascript runtime 

# as avalon
su - avalon
cd /var/www/avalon
gem install bundler
bundle install --with mysql production --without development test

Finish configuring Avalon

Edit /var/www/avalon/config/solr.yml and /var/www/avalon/config/blacklight.yml

Code Block
    url: http://localhost:8983/solr/avalon

Edit /var/www/avalon/config/fedora.yml

Code Block
    user: fedoraAdmin
    password: fedoraAdmin
    base_path: ""

Create streaming directory

Code Block
# as root
mkdir -p /var/avalon/derivatives
chown avalon:avalon /var/avalon/derivatives

titleAvalon config file

Avalon settings now live in /var/www/avalon/config/settings.yml. The default values should be sufficient to start with.

They can be selectively overwritten by creating a settings/<environment>.yml, or by using environment variables. Consult the config gem doc to understand how it works, or Avalon's documentation to customize this file for your installation.

Let Avalon know where your HLS streams are

Code Block
  server: :nginx
  http_base: 'http://localhost:8980/avalon'
  content_path: '/var/avalon/derivatives'

Change the secrets.yml file:

Code Block
export RAILS_ENV=production
rake secret

grab the output of rake secret and add it to secrets.yml where instruSTDOUTSTDOUTSTDOUTcted.

More information: Configuration Files#config/secrets.yml

Create controlled_vocabulary.yml

Code Block
cp config/controlled_vocabulary.yml.example config/controlled_vocabulary.yml

If you get an error message saying that you can't connect to the database, take a look at this post and follow some of the troubleshooting steps.

Run the database migrations

Code Block
rake db:migrate

Install yarn and node modules

Code Block
# as root
curl --silent --location | sudo tee /etc/yum.repos.d/yarn.repo
yum install yarn

# as avalon
su - avalon
cd /var/www/avalon
yarn install

Precompile assets

Code Block
# as avalon
RAILS_ENV=production bundle exec rake assets:precompile

Restart Apache

Code Block
# as root
systemctl restart httpd

Install ImageMagick

Code Block
# as root
yum install imagemagick


Avalon uses Sidekiq for background processing, which relies on Redis as its key-value store.

Install Redis

Code Block
# as root
yum install redis
systemctl start redis

Install Sidekiq

Code Block
# as root
wget -O /lib/systemd/system/sidekiq.service

Edit the following lines in sidekiq.service 

Code Block
ExecStart=/bin/bash -lc '/home/avalon/.rvm/gems/ruby-2.5.5/bin/bundle exec sidekiq -e production'

Code Block
# as root
systemctl start sidekiq

Sidekiq logs to STDOUT. 

titletmp Error after uploading file

When ingesting a media file, you may encounter an error message saying that file:///tmp/filename can’t be accessed or located.  This may result from the protected temp file settings that are defaults in CentOS 7.  Fix by changing “true” to “false” for PrivateTmp in these files in /usr/lib/systemd/system:

sidekiq.service  PrivateTmp=false
nginx.service   PrivateTmp=false
httpd.service   PrivateTmp=false

Additional Configurations


Code Block
groupadd -r dropbox
useradd -r avalondrop
usermod -G dropbox avalon
mkdir -p /srv/avalon/dropbox
chown avalondrop:dropbox /srv/avalon/dropbox
chmod 2775 /srv/avalon/dropbox

Edit /etc/ssh/sshd_config

Code Block
# override default of no subsystems
Subsystem sftp internal-sftp
# Example of overriding settings on a per-user basis
#Match User anoncvs
# X11Forwarding no
# AllowTcpForwarding no
# ForceCommand cvs server
Match Group dropbox
ChrootDirectory /srv/avalon
X11Forwarding no
AllowTcpForwarding no
ForceCommand internal-sftp

Restart SSH

Code Block
service sshd restart

Batch ingest

To manually start a batch ingest job, run as avalon user

Code Block
rake avalon:batch:ingest

To make batch ingest run automatically whenever a manifest is present, you need to add a cron job. This cron job can be created by the whenever gem from reading config/schedule.rb. To preview, run

Code Block

this will translate content in schedule.rb to cron job syntax. Once verified, run the following to write job to crontab

Code Block
whenever --update-crontab

You should get the cron job automatically if you were deploying from Capistrano.

Authentication Strategy

Avalon comes with Persona by default but it can be configured to work with other authentication strategies by using the appropriate omniauth gems. The following example is applicable to Indiana University CAS, it may need some adjustments in order to work with other CAS implementation.

Add to Gemfile

Code Block
gem 'net-ldap'
gem 'omniauth-cas', :git => ""

Install new gems

Code Block
bundle install

Add to config/initializers/my-ldap.rb

Code Block
module Avalon
      MY_GUEST_LDAP = = ""
      MY_GUEST_LDAP.authenticate 'cn=******,ou=Accounts,dc=eads,dc=myuni,dc=edu', '******'

      GROUP_LDAP = = ""
      GROUP_LDAP.authenticate 'cn=******,ou=Accounts,dc=ads,dc=myuni,dc=edu', '******'
      GROUP_LDAP_TREE = "dc=ads,dc=myuni,dc=edu"

Add config/initializers/user_auth_cas.rb

Code Block
require 'net/ldap'

User.instance_eval do
  def self.find_for_cas(access_token, signed_in_resource=nil)
    logger.debug "#{access_token.inspect}"
    #data =
    username = access_token.uid
    email = nil

    user = User.where(:username => username).first

    unless user
      if email.nil?
        tree = "dc=ads,dc=myuni,dc=edu"
        filter = Net::LDAP::Filter.eq("cn", "#{username}")
        email = => tree, :filter => filter, :attributes=> ["mail"]).first.mail.first
      user = User.find_or_create_by_username_or_email(username, email)
      raise "Finding user (#{ user }) failed: #{ user.errors.full_messages }" unless user.persisted?

Add to config/settings/production.local.yml

Code Block
    - :name: My University
      :logo: my_logo.png
      :provider: :cas
        :login_url: /cas/login
        :service_validate_url: /cas/validate
        :logout_url: /cas/logout
        :ssl: true

Using the System

You should be able to visit the webpage with just the hostname (ie http://localhost)

Create an admin account

You can  create an account from the command line in the root of your avalon install:

Code Block
bundle exec rake avalon:user:create avalon_password=password avalon_groups=administrator

Additional information

You can find specific information about using the system in the Collection Manager's Guide.  Sample content is available for your convenience.  Upload new items individually or by batch directly via SFTP using the avalondrop account you created above.

Configure additional feataures

Known Issues - a list of bugs, workarounds, and cautions.

Restarting the Server

Before you restart your Avalon server, you'll want to make sure all of the services necessary to run Avalon will start automatically after the restart. Run these commands once and you should be set:

Code Block
chkconfig --level 345 tomcat on
chkconfig --level 345 mariadb on
chkconfig --level 345 nginx on
chkconfig --level 345 sshd on
chkconfig --level 345 redis on
chkconfig --level 345 sidekiq on
chkconfig --level 345 httpd on