Obviously this document is a little dated now anyway, and the reader should know that as of May 2012 RHEL and CentOS targets in the prerequisites installer "Makefile.install" have been removed. It's not that we think it's impossible to get Evergreen working on these systems (we know it isn't, at least in the former case), but that we haven't had anyone share with the community up-to-date working Redhat configs or volunteer to test them. Start here if you want to resurrect what we had from our version control system to try to get it working again: http://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/dbs/update_makefile_prereqs
The following steps have been tested on Redhat x86 (32-bit) and x86-64 (64-bit) architectures.
In the following instructions, you are asked to perform certain steps as either the root user, the opensrf user, or the postgres user. To become the root user, issue the su - command and enter the password of the root user.
To switch from the root user to a different user, issue the su - <username> command; for example, su - opensrf. Once you have become a non-root user, to become the root user again simply issue the exit command.
cd ~ && svn checkout svn://svn.open-ils.org/ILS/trunk Evergreen-trunk
cd /home/opensrf/Evergreen-trunk make -f Open-ILS/src/extras/Makefile.install rhel
This will install a number of packages required by OpenSRF on your system, including some Perl modules from CPAN. You can say “no” to the initial CPAN configuration prompt to allow it to automatically configure itself to download and install Perl modules from CPAN. The CPAN installer will ask you a number of times whether it should install prerequisite modules - say “yes”.
/usr/local/lib/dbd
to the system dynamic library path and make Linux recognize the newly installed libraries. Then restart PostgreSQL to avoid a problem where plperl.so
cannot be found:/etc/ld.so.conf.d/eg.conf
containing the following lines:/usr/local/lib/dbd
ldconfig chkconfig --levels 345 postgresql on #to start up postgres on boot service postgresql initdb vi /var/lib/pgsql/data/pg_hba.conf
local all all trust
host all all 127.0.0.1 255.255.255.255 trust
/etc/init.d/postgresql restart
cd /home/opensrf/Evergreen-trunk cat /usr/share/aclocal/libtool.m4 /usr/share/aclocal/ltoptions.m4 /usr/share/aclocal/ltversion.m4 /usr/share/aclocal/ltsugar.m4 /usr/share/aclocal/lt~obsolete.m4 >> aclocal.m4 ./autogen.sh ./configure --prefix=/openils --sysconfdir=/openils/conf make
STAFF_CLIENT_BUILD_ID
variable to match the version of the staff client you will use to connect to the Evergreen server. Create a symbolic link named server
in /openils/var/web/xul/
to the /server/
subdirectory of your staff client build.cd /home/opensrf/Evergreen-trunk make STAFF_CLIENT_BUILD_ID=current install cd /openils/var/web/xul ln -sf current/server server
cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml cp /openils/conf/oils_web.xml.example /openils/conf/oils_web.xml chown -R opensrf:opensrf /openils/
createdb -E UNICODE evergreen createlang plperl evergreen createlang plperlu evergreen createlang plpgsql evergreen psql -f /usr/share/pgsql/contrib/tablefunc.sql evergreen psql -f /usr/share/pgsql/contrib/tsearch2.sql evergreen psql -f /usr/share/pgsql/contrib/pgxml.sql evergreen psql -f /usr/share/pgsql/contrib/isn.sql evergreen
evergreen
for the database cluster:createuser -P -s evergreen exit
localhost
and <port> will be 5432
:cd /home/opensrf/Evergreen-trunk perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \ --service all --create-schema --create-bootstrap --create-offline \ --user <user> --password <password> --hostname <hostname> --port <port> \ --database <dbname>
cd /home/opensrf/Evergreen-trunk mkdir /etc/httpd/sites-available cp Open-ILS/examples/apache/eg.conf /etc/httpd/sites-available/ cp Open-ILS/examples/apache/eg_vhost.conf /etc/httpd/ cp Open-ILS/examples/apache/startup.pl /etc/httpd/ chmod +x /etc/httpd/startup.pl rm -f /etc/httpd/conf.d/welcome.conf # Now setting up SSL mkdir /etc/httpd/ssl cd /etc/httpd/ssl # Step 7 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key # Step 8 vi /etc/httpd/sites-available/eg.conf
/etc/httpd/sites-available/eg.conf
for editing:Allow from 10.0.0.0/8
and uncomment Allow from all
(to enable access to the configuration CGI scripts from any workstation on any network - note that you must secure this for a production instance, preferably by locking down the allowed IP addresses and adding authentication, because you don't want just anyone adding and deleting libraries from your Evergreen instance!)/etc/httpd/conf/httpd.conf
:User apache
to User opensrf
KeepAliveTimeout
to 1
MaxKeepAliveRequests
to 100
LoadModule ssl_module modules/mod_ssl.so LoadModule perl_module modules/mod_perl.so
LoadModule osrf_json_gateway_module /usr/lib64/httpd/modules/osrf_json_gateway.so LoadModule osrf_http_translator_module /usr/lib64/httpd/modules/osrf_http_translator.so
<IfModule prefork.c> StartServers 20 MinSpareServers 5 MaxSpareServers 20 ServerLimit 256 MaxClients 256 MaxRequestsPerChild 10000 </IfModule>
cd /openils/var/web/js/dojo wget http://download.dojotoolkit.org/release-1.3.2/dojo-release-1.3.2.tar.gz tar zxf dojo-release-1.3.2.tar.gz mv dojo-release-1.3.2/* . rm -rf dojo-release-1.3.2*
chown opensrf /var/log/httpd
/openils/conf/opensrf_core.xml
:/openils/conf/opensrf_core.xml
to change the Jabber usernames and passwords as follows. I'm using XPath syntax on the left-hand side to indicate the position in the XML file:/config/opensrf/username
= opensrf/config/opensrf/passwd
= password for private.localhost opensrf user/config/gateway/username
= opensrf/config/gateway/passwd
= password for public.localhost opensrf user/config/routers/router/transport
- first entry, where transport/server
== public.localhost :username
= routerpassword
= password for public.localhost router user/config/routers/router/transport
- second entry, where transport/server
== private.localhost :username
= routerpassword
= password for private.localhost router user/openils/conf/srfsh.xml.example
to .srfsh.xml
in the home directory of each user you want to use to run the srfsh command line client for testing OpenSRF, and edit .srfsh.xml
as follows:domain
is the router hostname (following our domain examples, private.localhost
will give your srfsh access to all OpenSRF services, while public.localhost
will only give you access to those OpenSRF services that are publicly exposed)username
and password
must match your opensrf
ejabber user for the chosen domainlogfile
is the full path for a log file to which that user has write access<?xml version="1.0"?> <!-- This file follows the standard bootstrap config file layout found in opensrf_core.xml --> <srfsh> <router_name>router</router_name> <domain>private.localhost</domain> <username>opensrf</username> <passwd>evergreen</passwd> <port>5222</port> <logfile>/tmp/srfsh.log</logfile> <loglevel>4</loglevel> </srfsh>
.bashrc
file:chmod 755 /openils/var/cgi-bin/*.cgi echo "export PERL5LIB=/openils/lib/perl5:\$PERL5LIB" >> ~/.bashrc . ~/.bashrc # inherit the new environment
[ -z "$PS1" ] && return
This will allow headless (scripted) logins to load the correct environment.
/etc/init.d/ejabberd start /etc/init.d/memcached start
'-l
' flag in the following command is only necessary if you want to force Evergreen to treat the hostname as 'localhost
'; if you have configured opensrf.xml
using the real hostname of your machine as returned by perl -ENet::Domain 'print Net::Domain::hostfqdn() . "\n";
', you should not use the '-l
' flag.osrf_ctl.sh -l -a start_all
/openils/bin
directory; this should have been set by .bashrc
when you logged in as the opensrf
user, based on step 19 above, but you can manually set it using the following command:export PATH=$PATH:/openils/bin
/openils/lib/perl5
directory; this should have been set by .bashrc
when you logged in as the opensrf
user, based on step 19 above, but you can manually set it using the following command:export PERL5LIB=$PERL5LIB:/openils/lib/perl5
config.cgi
):cd /openils/bin ./autogen.sh -c /openils/conf/opensrf_core.xml -u
/etc/init.d/httpd restart
If the Apache Web server was running when you started the OpenSRF services, you might not be able to successfully log in to the OPAC or staff client until the Apache Web server is restarted.
Once you have installed and started Evergreen, test your connection to Evergreen via srfsh
:
srfsh
and try logging onto the Evergreen server using the default administrator user ID and password:/openils/bin/srfsh srfsh% login admin open-ils
You should see a result like:
Received Data: "250bf1518c7527a03249858687714376" ------------------------------------ Request Completed Successfully Request Time in seconds: 0.045286 ------------------------------------ Received Data: { "ilsevent":0, "textcode":"SUCCESS", "desc":" ", "pid":21616, "stacktrace":"oils_auth.c:304", "payload":{ "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a", "authtime":420 } } ------------------------------------ Request Completed Successfully Request Time in seconds: 1.336568 ------------------------------------
If this does not work, it's time to do some troubleshooting.
settings-tester.pl
script to see if it finds any system configuration problems. The script is found at Open-ILS/src/support-scripts/settings-tester.pl
in the Evergreen source tree. If the output of settings-tester.pl
does not help you find the problem, please do not make any significant changes to your configuration. You can run the staff client on Linux using XULRunner.
application.ini
file for the source files of the local build of the Evergreen staff client. For example, if the source files for your Evergreen installation are in the /home/opensrf/Evergreen-trunk/
directory, you would issue the following command:xulrunner /home/opensrf/Evergreen-trunk/Open-ILS/xul/staff_client/build/application.ini
Once you've started Evergreen and confirmed that a basic login attempt works, you can start up the Web server:
apachectl configtest && /etc/init.d/httpd restart
If there are any problems with your configuration file(s), they will be displayed.
osrf_ctl.sh -l -a stop_all
Evergreen reports are extremely powerful, but some configuration is required.
Once the open-ils.reporter
process is running and enabled on the gateway, you have to start the reporter daemon. The reporter daemon periodically checks for requests for new reports or scheduled reports and gets them running.
To start the reporter daemon, run the following command as the opensrf user:
clark-kent.pl --daemon
You can also specify other options:
/tmp/reporter-LOCK
/openils/conf/opensrf_core.xml
To stop the reporter daemon, you have to kill the process and remove the lockfile. Assuming you're running just a single process and that the lockfile is in the default location, perform the following commands as the opensrf user:
kill `ps wax | grep "Clark Kent" | grep -v grep | cut -b1-6` rm /tmp/reporter-LOCK