Add Admin requurements and configurations chapter.
[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 Recommended 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                \r
16                 <simplesect>\r
17                          <para>The following are the base requirements setting Evergreen up on a test server:</para>\r
18                         <itemizedlist>\r
19                                 <listitem><para>An available desktop, server or virtual image</para></listitem>\r
20                                 <listitem><para>512MB RAM</para></listitem>                     \r
21                                 <listitem><para>Linux Operating System</para></listitem>\r
22                         </itemizedlist>\r
23                         <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
24                         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
25                         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
26                 </simplesect> \r
27                 <simplesect>\r
28                         <info>\r
29                                 <title>Server Network Configurations</title>\r
30                         </info>\r
31                         <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
32                         to scale up your evergreen configuration to be spread your Evergreen resources and services over many servers in a clustered approach. This allows very large consortia to share \r
33                         one Evergreen system with hundreds of libraries with millions of records and millions of users making the scalability of Evergreen almost infinite.</para>\r
34                         <para>Here are some example scenarios for a server network configuration:</para>\r
35                         <itemizedlist>\r
36                                 <listitem><para>A small public library or school library with 1 location, under 25,000 items and a few thousand users could easily run Evergreen on a single server \r
37                                 (1 machine).</para></listitem>\r
38                                 <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
39                                 system by spreading services over multiple servers. It could also run  \r
40                                 PostgreSQL on a separate server. They could also cluster the Evergreen services in a way to minimize or eliminate any necessary downtown when upgrading Evergreen, \r
41                                 the operating system or the database software.</para></listitem>                        \r
42                                 <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
43                                 system over many servers, balancing the load on the system while sharing resource costs. At the same time, it gives users searching capabilities to search \r
44                                 several library systems simultaneously.</para></listitem>\r
45                         </itemizedlist>\r
46                         <para>The key to Evergreen scalability is in the openSRF configuration files <filename>/openils/conf/opensrf.xml</filename> and \r
47                         <filename>/openils/conf/opensrf_core.xml</filename>. \r
48                         By editing these files an administrator could quickly cluster evergreen services over multiple servers, change the server running a specific service \r
49                         or change the server of the postgreSQL database.</para> \r
50 \r
51                         <note><para>The default configuration of Evergreen in the installation instructions assumes a single <emphasis>localhost</emphasis> server setup. For more complex \r
52                         multi-server configurations, some server administration and database administration experience or knowledge may be required.</para></note>              \r
53                 </simplesect>    \r
54         </section>\r
55         <section xml:id="requirements_staffclient">\r
56                 <info>\r
57                     <title>Staff Client Requirements</title>\r
58                 </info>\r
59         \r
60                 <para> Staff terminals connect to the central database using the Evergreen staff client, available for download from <link xlink:href="http://www.open-ils.org/downloads.php">The Evergreen \r
61                 download page</link>. The staff client must be installed on each staff workstation and requires at minimum: </para>\r
62                 <itemizedlist>\r
63                         <listitem><para>Windows (XP, Vista, or 7), Mac OS X, or Linux operating system</para></listitem>\r
64                         <listitem><para>a reliable high speed internet connection</para></listitem>\r
65                         <listitem><para>512Mb of RAM</para></listitem>\r
66                 </itemizedlist>\r
67                 <simplesect>\r
68                         <info>\r
69                                 <title>Barcode Scanners</title>   \r
70                         </info>\r
71                                 <para>Evergreen will work with virtually any barcode scanner – if it worked with your legacy system it should work on Evergreen.</para>\r
72                 </simplesect>\r
73                 <simplesect>\r
74                         <info>\r
75                                 <title>Printers</title>\r
76                         </info>\r
77                         <para>Evergreen can use any printer configured for your terminal to print receipts, check-out slips, holds\r
78                         lists, etc. The single exception is spine label printing, which is still under development. Evergreen\r
79                         currently formats spine labels for output to a label roll printer. If you do not have a roll printer\r
80                          manual formatting may be required.  For more on configuring receipt printers, see <link linkend="lsa-printer">Printer Settings</link>.</para>    \r
81                 </simplesect>    \r
82         </section>\r
83 </chapter>\r