ETA (ESSArch Tools Archive)

SIP receiving tools for archives.

Installation Guide

Prerequisites

Hardware configuration for server, network and storage architecture is not affected in this guide. Software configurations for server operating systems occur preferably before the installation of ESSArch begins. The installation is expected to be done as user 'root'.

Supported OS platforms

OS Packages

Before installing ESSArch you need to verify that the following packages are installed on your platform

** Centos require extra package: epel-release

Prepare Environment

Create user and group

Don't forget to create /home/arch

Please run the following command as user root.
# groupadd arch
# useradd -c "ESSArch System Account" -m -g arch arch

Set password for arch user

Please run the following command as user root.
# passwd arch
Changing password for user arch.
New UNIX password: password
Retype new UNIX password: password

Customize user environment for arch user

Add the following rows to /home/arch/.bash_profile:

### ESSArch start
##
export PATH=/ESSArch/pd/python/bin:$PATH:/usr/sbin
export LANG=en_US.UTF-8
export LD_LIBRARY_PATH=/ESSArch/pd/python/lib:/ESSArch/pd/libxslt/lib:/ESSArch/pd/libxml/lib:$LD_LIBRARY_PATH
export ETA=/ESSArch/pd/python/lib/python2.7/site-packages/ESSArch_TA
export PYTHONPATH=$ETA:/ESSArch/config
export DJANGO_SETTINGS_MODULE=config.settings
alias bin='cd /ESSArch/bin'
alias log='cd /ESSArch/log'
##
### ESSArch end

Create installation directory

Please run the following command as user root.
# mkdir /ESSArch
# chown -R arch:arch /ESSArch

Installation

ETA installation script

Change to user "arch" with the following command.
# su - arch

Download and extract ESSArch_TA_install tarfile.
[arch@server ~]$ wget http://xxx.xxx.xxx.xxx/ESSArch_TA_installer_xxxxxxxxxxxx.tar.gz
[arch@server ~]$ tar xvf ESSArch_TA_installer_xxxxxxxxxxxx.tar.gz
[arch@server ~]$ cd ESSArch_TA_installer
[arch@server ~]$ ./install

The installation of ESSArch is now running and dependent on hardware configuration, the installation may take some time. To see details of the installation progress please start a new terminal window and run the following command.
[arch@server ~]$ tail -f /ESSArch/install.log

When installation is finished, search in the log file /ESSArch/install.log for any unexpected errors indicating failure of installation of any modules.

Installation of Advanced Message Queuing Protocol

ESSArch is designed to be AMQP (Advanced Message Queuing Protocol) independent. However the installation package is prepared for RabbitMQ and the following instructions assume that you use RabbitMQ.

Follow the instructions below in order to install RabbitMQ required by ESSArch.

Please run the following commands as root user.
# rpm -i /ESSArch/install/packages/rabbitmq-server.rpm
# chkconfig rabbitmq-server on
# service rabbitmq-server start

If startup failed and you see an error message in /var/log/rabbitmq/startup_log after a minute or so like:

ERROR: epmd error for host "yourhostname": timeout (timed out)_

Then you need to update your /etc/hosts file to add your hostname to the list of localhost:

127.0.0.1 yourhostname

Configuring

Apache httpd configuration

Edit file /ESSArch/config/httpd-eta.conf and change the configuration entry for "ServerName" to same as the hostname of the ESSArch server.

For test purpose you can use the existing configuration for SSL certificate, but for production environment and for maximum security we recommend generating your own SSL certificate or if you have your own SSL trusted certificate install them in the apache httpd configuration.

ESSArch configuration

In /ESSArch/config you will find all the configuration files for ESSArch. The main configuration file for ESSArch WEB GUI is local_eta_settings.py.

For ESSArch you will find the configuration in the local database tables. To change the configuration please login as admin user is ETA and select menu MANAGEMENT > Configuration

Database

ESSArch is designed to be RDBMS-independent.

Create default tables in database

Please run the following command as user: arch
[arch@server ~]$ python $ETA/manage.py migrate

Add default configuration data to database

Use only this default configuration for test purpose, do not install this default configuration in production.

For production environment you should first make a copy of this configuration file and update for example site_profile, site_name. After you done all your updates you install it.

Please run the following command as user: arch
[arch@server ~]$ python $ETA/install/install_config_eta.py

For production/custom installation

[arch@server ~]$ cp $ETA/install/install_config_eta.py /home/arch/install_config_eta_custom.py

Update /home/arch/install_config_eta_custom.py

Install configuration:

[arch@server ~]$ python /home/arch/install_config_eta_custom.py

Enable automatic startup at system boot

Login as root user and set ETA path variable:
# export ETA=/ESSArch/pd/python/lib/python2.7/site-packages/ESSArch_TA

Enable workerprocess

Please run the following commands as root user.
# cp $ETA/extra/celeryd.sh /etc/init.d/celeryd
# chmod 744 /etc/init.d/celeryd
# chkconfig celeryd on
# cp $ETA/extra/celerybeat.sh /etc/init.d/celerybeat
# chmod 744 /etc/init.d/celerybeat
# chkconfig celerybeat on

Enable automatic startup of Apache HTTPD

Please run the following command as user root.
# cp $ETA/extra/httpd.sh /etc/init.d/httpd
# chmod 744 /etc/init.d/httpd
# chkconfig httpd on

Running the ETA Server

Start ETA server

Note that a startup or shutdown of ETA should always be controlled.

Please run the following command as user root to start ETA.
# service celeryd start
# service celerybeat start
# service httpd start

Stop ETA server

Please run the following command as user root to stop ETA.
# service httpd stop
# service celeryd stop
# service celerybeat stop

Start ETA WEB interface

Start your preferable web browser and connect to ETA Server name or IP address.

URL: https://xxxxxxxx

By default, for test purpose, the installation has configured the following users:

Important files to backup

Important data in ESSArch to backup is the configuration, log files and database. All areas which are mounted from external file servers should be backed up.

Everything in the file area /ESSArch should be backed up before and after configuration changes or changes in ESSArch system installation, for example when upgrading and software patches.

Areas that need to be backed up to an external "backup system" daily is the following:

• /ESSArch/eta
• /ESSArch/backups_mysql
• /ESSArch/config
• /ESSArch/log
• /ESSArch/data

Events and log information

Different types of events are logged both in physical files and tables in ESSArch database. Log entries are tagged with the log level - Debug, Critical, Error, Warning, Info. These log levels can be felt by the ETA's system logs:

• /ESSArch/log
• /ESSArch/log/celerybeat.log
• /ESSArch/log/celery_worker1.log
• /ESSArch/log/httpd_access.log
• /ESSArch/log/httpd_error.log
• /ESSArch/log/httpd_ssl_request.log

Service och support

Service and support on ETA is regulated in maintenance contract with ES Solutions AB. A case is registered on the support portal http://projects.essolutions.se