-README for Evergreen master
-===========================
+Installing the Evergreen server
+===============================
+:toc:
+:numbered:
Preamble: referenced user accounts
----------------------------------
Evergreen that you will use to test connectivity and configure your
Evergreen instance.
-Preamble: Developer instructions
+Preamble: developer instructions
--------------------------------
[NOTE]
[source, bash]
------------------------------------------------------------------------------
-./autogen.sh
+autoreconf -i
------------------------------------------------------------------------------
After running `make install`, developers also need to install the Dojo Toolkit
cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
------------------------------------------------------------------------------
-Installing prerequisites:
--------------------------
+Installing prerequisites
+------------------------
Evergreen has a number of prerequisite packages that must be installed
before you can successfully configure, compile, and install Evergreen.
-1. Begin by installing the most recent version of OpenSRF (2.0 or later).
+1. Begin by installing the most recent version of OpenSRF (2.1 or later).
You can download OpenSRF releases from http://evergreen-ils.org/opensrf.php
2. On many distributions, it is necessary to install PostgreSQL 9 from external
repositories.
add-apt-repository ppa:pitti/postgresql
------------------------------------------------------------------------------
+
- * Fedora 15 comes with PostgreSQL 9, so no additional steps are required.
+ * Ubuntu Precise comes with PostgreSQL 9, so no additional steps are required.
++
+ * Fedora comes with PostgreSQL 9, so no additional steps are required.
+
3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
retrieve the new packages from the backports repository.
4. Issue the following commands as the *root* Linux account to install
prerequisites using the `Makefile.install` prerequisite installer,
- substituting `debian-squeeze`, `fedora15`, `ubuntu-lucid`, `centos`, or
- `rhel` for <osname> below:
+ substituting `debian-squeeze`, `fedora`, `ubuntu-lucid`, or
+ `ubuntu-precise` for <osname> below:
+
[source, bash]
------------------------------------------------------------------------------
make -f Open-ILS/src/extras/Makefile.install <osname>
------------------------------------------------------------------------------
+
-[NOTE]
-`centos` and `rhel` are less tested than the `debian`, `fedora`,
-and `ubuntu` options. Your patches and suggestions for improvement are
-welcome!
-+
5. Add the libdbi-libdbd libraries to the system dynamic library path by
issuing the following commands as the *root* Linux account:
+
-.Debian / Ubuntu
+[NOTE]
+You should skip this step if installing on Ubuntu Precise. The ubuntu-precise
+target uses libdbd-pgsql from packages.
++
+.Debian / Ubuntu Lucid
[source, bash]
------------------------------------------------------------------------------
echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
ldconfig
------------------------------------------------------------------------------
-Configuration and compilation instructions:
--------------------------------------------
+Configuration and compilation instructions
+------------------------------------------
For the time being, we are still installing everything in the `/openils/`
directory. From the Evergreen source directory, issue the following commands as
make
------------------------------------------------------------------------------
-Installation instructions:
---------------------------
+Installation instructions
+-------------------------
1. Once you have configured and compiled Evergreen, issue the following
command as the *root* Linux account to install Evergreen, build the server
+
[source, bash]
------------------------------------------------------------------------------
-make STAFF_CLIENT_STAMP_ID=rel_name install
+make STAFF_CLIENT_STAMP_ID=rel_2_3_0 install
------------------------------------------------------------------------------
+
2. The server portion of the staff client expects `http://hostname/xul/server`
ln -sf rel_name/server server
------------------------------------------------------------------------------
-Change ownership of the Evergreen files:
-----------------------------------------
+Change ownership of the Evergreen files
+---------------------------------------
All files in the `/openils/` directory and subdirectories must be owned by the
`opensrf` user. Issue the following command as the *root* Linux account to
chown -R opensrf:opensrf /openils
------------------------------------------------------------------------------
-Configure the Apache Web server:
---------------------------------
+Configure the Apache Web server
+-------------------------------
1. Use the example configuration files in `Open-ILS/examples/apache/` to
configure your Web server for the Evergreen catalog, staff client, Web
.Fedora
[source,bash]
------------------------------------------------------------------------------
-cp Open-ILS/examples/apache/eg.conf /etc/httpd/sites-available/
+cp Open-ILS/examples/apache/eg.conf /etc/httpd/conf.d/
cp Open-ILS/examples/apache/eg_vhost.conf /etc/httpd/
cp Open-ILS/examples/apache/startup.pl /etc/httpd/
# Now set up SSL
a. Replace `Allow from 10.0.0.0/8` with `Allow from all` (to enable
access to the offline upload / execute interface from any workstation on
any network - note that you must secure this for a production instance)
+ b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
+ to `/etc/httpd/`.
4. Change the user for the Apache server.
* (Debian and Ubuntu): As the *root* Linux account, edit
`/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
</IfModule>
------------------------------------------------------------------------------
+
-6. (Debian and Ubuntu): As the *root* Linux account, enable the Evergreen site:
+6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
+ file to change references from the non-existent `/etc/apache2/` directory
+ to `/etc/httpd/`.
+7. (Debian and Ubuntu): As the *root* Linux account, enable the Evergreen site:
+
[source,bash]
------------------------------------------------------------------------------
a2ensite eg.conf
------------------------------------------------------------------------------
-Configure OpenSRF for the Evergreen application:
-------------------------------------------------
+Configure OpenSRF for the Evergreen application
+-----------------------------------------------
There are a number of example OpenSRF configuration files in `/openils/conf/`
that you can use as a template for your Evergreen installation. Issue the
following commands as the *opensrf* Linux account:
[source, bash]
------------------------------------------------------------------------------
-cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
-cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
+cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
+cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
------------------------------------------------------------------------------
When you installed OpenSRF, you created four Jabber users on two
Evergreen version of the `opensrf_core.xml` file using the same Jabber users
and domains as you used while installing and testing OpenSRF.
+[NOTE]
+The `-b` flag tells the `cp` command to create a backup version of the
+destination file. The backup version of the destination file has a tilde (`~`)
+appended to the file name, so if you have forgotten the Jabber users and
+domains, you can retrieve the settings from the backup version of the files.
+
`eg_db_config.pl`, described in the following section, sets the database
connection information in `opensrf.xml` for you.
-Creating the Evergreen database:
---------------------------------
+Creating the Evergreen database
+-------------------------------
By default, the `Makefile.install` prerequisite installer does not install
the PostgreSQL 9 database server required by every Evergreen system;
for production use, most libraries install the PostgreSQL database server on a
-dedicated machine. You can install the packages required by Debian or Ubuntu
+dedicated machine. You can install the packages required by Debian or Ubuntu Lucid
on the machine of your choice using the following commands as the *root*
Linux account:
-.(Debian / Ubuntu) Installing PostgreSQL 9.1 server packages
+.(Debian and Ubuntu Lucid) Installing PostgreSQL 9.1 server packages
+[source, bash]
+------------------------------------------------------------------------------
+make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_backport_debs_91
+------------------------------------------------------------------------------
+
+.(Ubuntu Precise) Installing PostgreSQL 9.1 server packages
[source, bash]
------------------------------------------------------------------------------
make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_91
You can install the packages required by Fedora on the machine of your choice
using the following commands as the *root* Linux account:
-.(Fedora 15) Installing PostgreSQL 9.0 server packages
+.(Fedora) Installing PostgreSQL server packages
[source, bash]
------------------------------------------------------------------------------
make -f Open-ILS/src/extras/Makefile.install install_fedora_pgsql_server
+postgresql-setup initdb
------------------------------------------------------------------------------
For a standalone PostgreSQL server, install the following Perl modules as the
cpan UUID::Tiny
------------------------------------------------------------------------------
-.(Fedora 15) Installing additional Perl modules on a standalone PostgreSQL 9 server
+.(Fedora) Installing additional Perl modules on a standalone PostgreSQL 9 server
[source, bash]
------------------------------------------------------------------------------
yum install gcc perl-XML-LibXML perl-XML-LibXSLT perl-Business-ISBN
-cpan JSON::XS
cpan Library::CallNumber::LC
cpan MARC::Record
cpan MARC::File::XML
Creating the database on a remote server
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In a production instance of Evergreen, your PostgreSQL server should be
-installed on a dedicated server. For PostgreSQL 9.1 and later you should be
-able to continue to use the --create-database flag on eg_db_config.pl, without
-needing to install any server modules on your application machine. For
-PostgreSQL 9.0 you can either:
+installed on a dedicated server.
+
+PostgreSQL 9.1 and later
+^^^^^^^^^^^^^^^^^^^^^^^^
+To create the database instance on a remote database server running PostgreSQL
+9.1 or later, simply use the `--create-database` flag on `eg_db_config.pl`.
+
+For PostgreSQL 9.0
+^^^^^^^^^^^^^^^^^^
+To create the database instance on a remote database server running PostgreSQL
+9.0, you can either:
* Install the PostgreSQL contrib modules on the machine on which you
- are installing the Evergreen code, and use the --create-database
+ are installing the Evergreen code, and use the `--create-database`
option from that machine, or
* Copy the `Open-ILS/src/sql/Pg/create_database.sql` script to your
PostgreSQL server and invoke it as the *postgres* Linux account:
+
[source, bash]
------------------------------------------------------------------------------
-psql -vdb_name=<dbname> -vcontrib_dir=`pg_config --sharedir`/contrib
+psql -vdb_name=<dbname> -vcontrib_dir=`pg_config --sharedir`/contrib -f create_database.sql
------------------------------------------------------------------------------
Then you can issue the `eg_db_config.pl` command as above _without_ the
+
[source, bash]
------------------------------------------------------------------------------
-osrf_ctl.sh -l -a start_all</code>
+osrf_ctl.sh -l -a start_all
------------------------------------------------------------------------------
+
** If you receive the error message `bash: osrf_ctl.sh: command not found`,
for assistance before making any drastic changes to your system
configuration.
-Getting help:
--------------
+Getting help
+------------
Need help installing or using Evergreen? Join the mailing lists at
http://evergreen-ils.org/listserv.php or contact us on the Freenode
IRC network on the #evergreen channel.
+
+License
+-------
+This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
+Unported License. To view a copy of this license, visit
+http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
+Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
projects / transitory.git / blobdiff