]> git.evergreen-ils.org Git - working/Evergreen.git/blob - 1.6/admin/requirements-configuration.xml
Merge github.com:rsoulliere/Evergreen-DocBook
[working/Evergreen.git] / 1.6 / admin / requirements-configuration.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <chapter xml:id="requirements" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
3     xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
4     <info>\r
5         <title>System Requirements and Hardware Configurations</title>\r
6     </info>\r
7 \r
8     <para>Evergreen is extremely scalable and can serve the need of a large range of libraries. The specific requirements and configuration of your system should be determined based on your \r
9         specific needs of your organization or consortium.</para>\r
10     \r
11         <section xml:id="requirements_server">\r
12                 <info>\r
13                     <title>Server Minimum Requirements</title>\r
14                 </info> \r
15                          <para>The following are the base requirements setting Evergreen up on a test server:</para>\r
16                         <itemizedlist>\r
17                                 <listitem><para>An available desktop, server or virtual image</para></listitem>\r
18                                 <listitem><para>512MB RAM</para></listitem>                     \r
19                                 <listitem><para>Linux Operating System</para></listitem>\r
20                         </itemizedlist>\r
21                         <tip><para>Debian and Ubuntu are the most widely used Linux distributions for installing Evergreen and most development takes place on Debian based systems. If you are new \r
22                         to Linux, it is strongly recommended that you install Evergreen on the latest stable server edition of Debian (<ulink url="http://www.debian.org/">http://www.debian.org/</ulink>)\r
23                         or Ubuntu 10.04 Server(<ulink url="http://www.ubuntu.com/">http://www.ubuntu.com/</ulink>) since the installation instructions have been tested on these distributions. Debian and                              Ubuntu are free distributions of Linux.</para></tip>\r
24                 </section>        \r
25                 <section xml:id="hardwareconfigurations">\r
26                         <info>\r
27                                 <title>Server Hardware Configurations and Clustering</title>\r
28                         </info>\r
29                         <para>As apparent in the previous section, the base hardware requirements for running a functional Evergreen server are extremely minimal. It is also possible\r
30                         to scale up your evergreen configuration to be spread your Evergreen resources and services over several or even many servers in a clustered approach for the purpose \r
31                         of system redundancy, load balancing and downtime reduction. This allows very large \r
32                         consortia to share one Evergreen system with hundreds of libraries with millions of records and millions of users, making the scalability of Evergreen almost infinite.</para>\r
33                         <para>Here are some example scenarios for networked server configurations:</para>\r
34                         <itemizedlist>\r
35                                 <listitem><para>A small library library with 1 location, under 25,000 items and a few thousand users could easily run Evergreen on a single server \r
36                                 (1 machine).</para></listitem>\r
37                                 <listitem><para>A college or university with 1 million items and 20,000 users could run an Evergreen system using several servers balancing the load on their \r
38                                 system by spreading services over multiple servers. It should host their PostgreSQL database on a separate server. They could also cluster the Evergreen services       \r
39                                 strategically to minimize or eliminate any necessary downtown when upgrading Evergreen or other server software. Moreover, system redundancy will reduce the chance of \r
40                                 unplanned catastrophic downtime caused by system failure since Evergreen will be running over several machines.</para></listitem>                       \r
41                                 <listitem><para>A large library consortium with several public library systems and/or academic libraries with millions of users and items could run an Evergreen \r
42                                 system over many servers with clusters for Evergreen services as well as a cluster for the Postgresql Database.</para></listitem>\r
43                         </itemizedlist>\r
44                         <para>The key to Evergreen scalability is in the openSRF configuration files <filename>/openils/conf/opensrf.xml</filename> and \r
45                         <filename>/openils/conf/opensrf_core.xml</filename>. \r
46                         By configuring these files, an administrator could cluster evergreen services over multiple hosts, change the host running a specific service \r
47                         or change the host of the postgreSQL database.</para> \r
48 \r
49                         <note><para>The default configuration of Evergreen in the installation instructions assumes a single <emphasis>localhost</emphasis> server setup. For more complex \r
50                         multi-server clustered configurations, some server administration and database administration experience or knowledge will be required.</para></note>           \r
51                 </section>    \r
52         \r
53                 <section xml:id="requirements_staffclient">\r
54                         <info>\r
55                             <title>Staff Client Requirements</title>\r
56                         </info>\r
57         \r
58                         <para> Staff terminals connect to the central database using the Evergreen staff client, available for download from \r
59                         <link xlink:href="http://www.open-ils.org/downloads.php">The Evergreen download page</link>. The staff client must be installed on each staff workstation and requires at \r
60                         minimum: </para>\r
61                         <itemizedlist>\r
62                                 <listitem><para>Windows (XP, Vista, or 7), Mac OS X, or Linux operating system</para></listitem>\r
63                                 <listitem><para>a reliable high speed internet connection</para></listitem>\r
64                                 <listitem><para>512Mb of RAM</para></listitem>\r
65                         </itemizedlist>\r
66                         <simplesect>\r
67                                 <info>\r
68                                         <title>Barcode Scanners</title>   \r
69                                 </info>\r
70                                         <para>Evergreen will work with virtually any barcode scanner – if it worked with your legacy system it should work on Evergreen.</para>\r
71                         </simplesect>\r
72                         <simplesect>\r
73                                 <info>\r
74                                         <title>Printers</title>\r
75                                 </info>\r
76                                 <para>Evergreen can use any printer configured for your terminal to print receipts, check-out slips, holds\r
77                                 lists, etc. The single exception is spine label printing, which is still under development. Evergreen\r
78                                 currently formats spine labels for output to a label roll printer. If you do not have a roll printer\r
79                                  manual formatting may be required.  For more on configuring receipt printers, see <link linkend="lsa-printer">Printer Settings</link>.</para>    \r
80                         </simplesect>    \r
81                 </section>\r
82 </chapter>\r