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.
Ready the Installation Environment
The instructions below require being run as root unless specifically noted otherwise.
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:
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: avalon-iptables-config.sh
If you're connected over ssh, it might kick you off.
Save your script to /etc/sysconfig/avalon-iptables-config.sh, make it executable and run it.
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".
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
This package has libyaml-devel which is required by ruby and not provided by Redhat.
Install development libraries and packages for building Ruby
Install Java 8
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
Fedora Commons Repository
Fedora runs as a webapp in Tomcat
Install Apache Tomcat
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.
Create Fedora user and database
Enter the mariadb client
Check your work and exit
Configure Tomcat for Fedora
Append the following to
Download and run the fcrepo installer
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.
Download the solr tarball and run the installation script
Download Solr from http://archive.apache.org/dist/lucene/solr/
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
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: https://cwiki.apache.org/confluence/display/solr/Running+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.
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.
nginx user and let it own nginx stuff
Make 8980 bindable and start nginx
Later: Avalon config should be updated to be compatible with Nginx:
If you enable SSL on Avalon server, you should also enable SSL on the streaming server to avoid Mixed content warning.
Download prebuilt ffmpeg
The following prebuilt binaries are provided by a third party. Proceed with caution.
Download and install ffmpeg:
Install and start the httpd service.
Apache Passenger and Ruby
Change current user to avalon then install RVM and ruby 2.4.1
Source the RVM shell (as avalon user) or close the terminal and open it back up.
Install Passenger apache module requirements (as root)
Create a virtual host for avalon
In 20-avalon.conf add this line inside the VirtualHost tag:
If using SSL, the following fix should be added to address BEAST, POODLE, RC4 issues (after the
Validate passenger install and restart apache
Grab Avalon code from github
Configure database settings
Replace database.yml with the correct values for your production environment
Install the mysql2 adapter
Run the bundle install
Install yarn and node modules
Finish configuring Avalon
Edit /var/www/avalon/config/solr.yml and /var/www/avalon/config/blacklight.yml
Avalon 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
Change the secrets.yml file:
grab the output of rake secret and add it to secrets.yml where instructed.
More information: Configuration Files#config/secrets.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
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'
Avalon uses Sidekiq for background processing, which relies on Redis as its key-value store.
Edit the following lines in sidekiq.service
Sidekiq logs STDOUT.
To manually start a batch ingest job, run as avalon user
this will translate content in
schedule.rb to cron job syntax. Once verified, run the following to write job to crontab
You should get the cron job automatically if you were deploying from Capistrano.
Using the System
You should be able to visit the webpage with just the hostname (ie http://localhost)
Create an admin account
Click on "Sign in" in the upper right corner of the website main page. Set up a default identity with administrative privileges using the following properties.
You can also create an account from the command line in the root of your avalon install:
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.
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: