Skip to content

Commit bcf4763

Browse files
authored
Update README.md
1 parent c4f858f commit bcf4763

1 file changed

Lines changed: 6 additions & 253 deletions

File tree

README.md

Lines changed: 6 additions & 253 deletions
Original file line numberDiff line numberDiff line change
@@ -4,263 +4,16 @@ SIP receiving tools for archives.
44

55
# Installation Guide
66

7-
## Prerequisites
7+
Instructions for preparing for, installing and setting up ETA (and ESSArch Core) can be found at http://doc.essarch.org/
88

9-
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'.
9+
# Documentation
1010

11-
## Supported OS platforms
11+
Source for the documentation can be found in the `docs` folder
1212

13-
| **OS** | **Version** | |
14-
| --- | --- | --- |
15-
| CentOS | 5.5 (x86\_64) | |
16-
| CentOS | 6.4 (x86\_64) | CentOS release 6.6 (Final) |
17-
| Redhat Enterprise Server | 5 (x86\_64) | |
18-
| SUSE Linux Enterprise Server | 10 (x86\_64) | |
19-
| SUSE Linux Enterprise Server | 11 (x86\_64) SP3 | |
20-
| Fedora | 11 (x86\_64) | |
13+
# Contributing
2114

22-
## OS Packages
15+
Please see `CONTRIBUTING.md` for information about contributing to the project.
2316

24-
Before installing ESSArch you need to verify that the following packages are installed on your platform
25-
26-
| **Package** | **Minimum version** | **Note** | **Verified version** |
27-
| --- | --- | --- | --- |
28-
| kernel-devel | 2.6.x | | kernel-devel-2.6.32-504.el6.x86\_64 |
29-
| sysstat | 7.x | | sysstat-9.0.4-27.el6.x86\_64 |
30-
| make | 3.81-15 | | make-3.81-20.el6.x86\_64 |
31-
| patch | 2.6.1-1 | | patch-2.6-6.el6.x86\_64 |
32-
| erlang \*\* | R12B-5.8 | | erlang-R14B-04.3.el6.x86\_64 |
33-
| gcc | 4.1.2 | | gcc-4.4.7-11.el6.x86\_64 |
34-
| gcc-c++ | 4.1.2 | | gcc-c++-4.4.7-11.el6.x86\_64 |
35-
| ppenssl | 0.9.8 | | openssl-1.0.1e-30.el6.x86\_64 |
36-
| openssl-devel | 0.9.8 | | openssl-devel-1.0.1e-30.el6.x86\_64 |
37-
| openldap | 2.3.43 | | openldap-2.4.39-8.el6.x86\_64 |
38-
| openldap-devel | 2.3.43 | | openldap-devel-2.4.39-8.el6.x86\_64 |
39-
| mt-st | 0.9b | | mt-st-1.1-5.el6.x86\_64 |
40-
| mtx | 1.2.18 | | mtx-1.3.12-5.el6.x86\_64 |
41-
| sg3\_utils | 1.25 | | sg3\_utils-1.28-6.el6.x86\_64 |
42-
| sg3\_utils-libs | 1.25 | | sg3\_utils-libs-1.28-6.el6.x86\_64 |
43-
| sg3\_utils-devel | 1.25 | | sg3\_utils-devel-1.28-6.el6.x86\_64 |
44-
| mysql | 5.0.77 | | mysql-5.1.73-3.el6\_5.x86\_64 |
45-
| mysql-server | 5.0.77 | | mysql-server-5.1.73-3.el6\_5.x86\_64 |
46-
| mysql-devel | 5.0.77 | | mysql-devel-5.1.73-3.el6\_5.x86\_64 |
47-
| mysql-libs | 5.0.77 | | mysql-libs-5.1.73-3.el6\_5.x86\_64 |
48-
| gnutls | 1.4.1 | | gnutls-2.8.5-14.el6\_5.x86\_64 |
49-
| readline | 5.1.3 | | readline-6.0-4.el6.x86\_64 |
50-
| readline-devel | 5.1.3 | | readline-devel-6.0-4.el6.x86\_64 |
51-
| unixODBC | 2.2.11 | | unixODBC-2.2.14-14.el6.x86\_64 |
52-
| unixODBC-devel | 2.2.11 | | unixODBC-devel-2.2.14-14.el6.x86\_64 |
53-
| freetds | 0.64 | | freetds-0.91-2.el6.x86\_64 |
54-
| freetds-devel | 0.64 | | freetds-devel-0.91-2.el6.x86\_64 |
55-
| pcre | 7.8 | | pcre-7.8-6.el6.x86\_64 |
56-
| pcre-devel | 7.8 | | pcre-devel-7.8-6.el6.x86\_64 |
57-
| lzo | 2.03-2 | | lzo-2.03-3.1.el6\_5.1.x86\_64 |
58-
| lzo-devel | 2.03-2 | | lzo-devel-2.03-3.1.el6\_5.1.x86\_64 |
59-
| xz | 4.999.9-0.1 | | xz-4.999.9-0.5.beta.20091007git.el6.x86\_64 |
60-
| bzip2-devel (libbz2-devel) | 1.0.5-5 | | bzip2-devel-1.0.5-7.el6\_0.x86\_64 |
61-
| libffi-devel | 3.0.5-3.2 | | libffi-devel.x86\_64 0:3.0.5-3.2.el6 |
62-
| sqlite-devel | 3.6 | | 3.6.20-1.el6.x86\_64 |
63-
64-
\*\* Centos require extra package: [epel-release](http://ftp.acc.umu.se/mirror/fedora/epel/6/i386/epel-release-6-8.noarch.rpm)
65-
66-
## Prepare Environment
67-
68-
### Create user and group
69-
70-
Don't forget to create /home/arch
71-
72-
Please run the following command as user root.
73-
# groupadd arch
74-
# useradd -c "ESSArch System Account" -m -g arch arch
75-
76-
### Set password for arch user
77-
78-
Please run the following command as user root.
79-
# passwd arch
80-
Changing password for user arch.
81-
New UNIX password: password
82-
Retype new UNIX password: password
83-
84-
### Customize user environment for arch user
85-
86-
Add the following rows to /home/arch/.bash_profile:
87-
88-
### ESSArch start
89-
##
90-
export PATH=/ESSArch/pd/python/bin:$PATH:/usr/sbin
91-
export LANG=en_US.UTF-8
92-
export LD_LIBRARY_PATH=/ESSArch/pd/python/lib:/ESSArch/pd/libxslt/lib:/ESSArch/pd/libxml/lib:$LD_LIBRARY_PATH
93-
export ETA=/ESSArch/pd/python/lib/python2.7/site-packages/ESSArch_TA
94-
export PYTHONPATH=$ETA:/ESSArch/config
95-
export DJANGO_SETTINGS_MODULE=config.settings
96-
alias bin='cd /ESSArch/bin'
97-
alias log='cd /ESSArch/log'
98-
##
99-
### ESSArch end
100-
101-
### Create installation directory
102-
103-
Please run the following command as user root.
104-
# mkdir /ESSArch
105-
# chown -R arch:arch /ESSArch
106-
107-
## Installation
108-
109-
### ETA installation script
110-
111-
Change to user "arch" with the following command.
112-
# su - arch
113-
114-
Download and extract ESSArch_TA_install tarfile.
115-
[arch@server ~]$ wget http://xxx.xxx.xxx.xxx/ESSArch_TA_installer_xxxxxxxxxxxx.tar.gz
116-
[arch@server ~]$ tar xvf ESSArch_TA_installer_xxxxxxxxxxxx.tar.gz
117-
[arch@server ~]$ cd ESSArch_TA_installer
118-
[arch@server ~]$ ./install
119-
120-
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.
121-
[arch@server ~]$ tail -f /ESSArch/install.log
122-
123-
When installation is finished, search in the log file /ESSArch/install.log for any unexpected errors indicating failure of installation of any modules.
124-
125-
### Installation of Advanced Message Queuing Protocol
126-
127-
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.
128-
129-
Follow the instructions below in order to install RabbitMQ required by ESSArch.
130-
131-
Please run the following commands as root user.
132-
# rpm -i /ESSArch/install/packages/rabbitmq-server.rpm
133-
# chkconfig rabbitmq-server on
134-
# service rabbitmq-server start
135-
136-
If startup failed and you see an error message in /var/log/rabbitmq/startup_log after a minute or so like:
137-
138-
ERROR: epmd error for host "yourhostname": timeout (timed out)_
139-
140-
Then you need to update your /etc/hosts file to add your hostname to the list of localhost:
141-
142-
127.0.0.1 yourhostname
143-
144-
## Configuring
145-
146-
### Apache httpd configuration
147-
148-
Edit file /ESSArch/config/httpd-eta.conf and change the configuration entry for "ServerName" to same as the hostname of the ESSArch server.
149-
150-
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.
151-
152-
### ESSArch configuration
153-
154-
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.
155-
156-
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
157-
158-
## Database
159-
160-
ESSArch is designed to be RDBMS-independent.
161-
162-
### Create default tables in database
163-
164-
Please run the following command as user: arch
165-
[arch@server ~]$ python $ETA/manage.py migrate
166-
167-
## Add default configuration data to database
168-
169-
Use only this default configuration for test purpose, do not install this default configuration in production.
170-
171-
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.
172-
173-
Please run the following command as user: arch
174-
[arch@server ~]$ python $ETA/install/install_config_eta.py
175-
176-
### For production/custom installation
177-
178-
[arch@server ~]$ cp $ETA/install/install_config_eta.py /home/arch/install_config_eta_custom.py
179-
180-
Update /home/arch/install_config_eta_custom.py
181-
182-
Install configuration:
183-
184-
[arch@server ~]$ python /home/arch/install_config_eta_custom.py
185-
186-
## Enable automatic startup at system boot
187-
188-
Login as root user and set ETA path variable:
189-
# export ETA=/ESSArch/pd/python/lib/python2.7/site-packages/ESSArch_TA
190-
191-
### Enable workerprocess
192-
193-
Please run the following commands as root user.
194-
# cp $ETA/extra/celeryd.sh /etc/init.d/celeryd
195-
# chmod 744 /etc/init.d/celeryd
196-
# chkconfig celeryd on
197-
# cp $ETA/extra/celerybeat.sh /etc/init.d/celerybeat
198-
# chmod 744 /etc/init.d/celerybeat
199-
# chkconfig celerybeat on
200-
201-
### Enable automatic startup of Apache HTTPD
202-
203-
Please run the following command as user root.
204-
# cp $ETA/extra/httpd.sh /etc/init.d/httpd
205-
# chmod 744 /etc/init.d/httpd
206-
# chkconfig httpd on
207-
208-
# Running the ETA Server
209-
210-
## Start ETA server
211-
212-
Note that a startup or shutdown of ETA should always be controlled.
213-
214-
Please run the following command as user root to start ETA.
215-
# service celeryd start
216-
# service celerybeat start
217-
# service httpd start
218-
219-
## Stop ETA server
220-
221-
Please run the following command as user root to stop ETA.
222-
# service httpd stop
223-
# service celeryd stop
224-
# service celerybeat stop
225-
226-
## Start ETA WEB interface
227-
228-
Start your preferable web browser and connect to ETA Server name or IP address.
229-
230-
URL: [https://xxxxxxxx](https://xxxxxxxx)
231-
232-
By default, for test purpose, the installation has configured the following users:
233-
234-
| **Username** | **Password** | **Role/Permissions** |
235-
| --- | --- | --- |
236-
| usr2 | usr2 | receive, events, transfer |
237-
| admin | admin | admin |
238-
239-
## Important files to backup
240-
241-
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.
242-
243-
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.
244-
245-
Areas that need to be backed up to an external "backup system" daily is the following:
246-
247-
- /ESSArch/eta
248-
- /ESSArch/backups_mysql
249-
- /ESSArch/config
250-
- /ESSArch/log
251-
- /ESSArch/data
252-
253-
##Events and log information
254-
255-
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:
256-
257-
- /ESSArch/log
258-
- /ESSArch/log/celerybeat.log
259-
- /ESSArch/log/celery_worker1.log
260-
- /ESSArch/log/httpd_access.log
261-
- /ESSArch/log/httpd_error.log
262-
- /ESSArch/log/httpd_ssl_request.log
263-
264-
# Service och support
17+
# Service and support
26518

26619
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

0 commit comments

Comments
 (0)