1 <?xml version='1.0' encoding='UTF-8'?>
\r
2 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
\r
3 xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="adminmisc">
\r
6 <title>Server Operations and Maintenance</title>
\r
7 <indexterm><primary>receipt template editor</primary></indexterm>
\r
9 <para>This chapter deals with basic server operations such as starting and stopping <application>Evergreen</application> as well wall
\r
10 security, backing up and troubleshooting <application>Evergreen</application>.</para>
\r
13 <section xml:id="startingopensrf">
\r
14 <title>Starting, Stopping and Restarting</title>
\r
15 <para>Occasionally, you may need to restart <application>Evergreen</application>. It is imperative that you understand the basic
\r
16 commands to stop and start the <application>Evergreen</application> server. You can start and stop <application>Evergreen</application> from the command line of
\r
17 the server using the <command>osrf_ctl.sh</command> script located in the
\r
18 <filename class="directory">openils/bin</filename> directory.</para>
\r
19 <note><para><command>The osrf_ctl.sh</command> command must be run as the <systemitem class="username">opensrf</systemitem> user.</para></note>
\r
20 <para>To view help on <command>osrf_ctl.sh</command> and get all of its options, run:</para>
\r
21 <screen><userinput>osrf_ctl.sh -h</userinput></screen>
\r
22 <para>To start Evergreen, run:</para>
\r
23 <screen><userinput>osrf_ctl.sh -l -a start_all</userinput></screen>
\r
24 <para>The <option>-l</option> flag is used to indicate that Evergreen is configured to use <systemitem class="domainname">localhost</systemitem> as
\r
25 the host. If you have configured <filename>opensrf.xml</filename> to use your real hostname, do not use the <option>-l</option> flag. The <option>-a</option>
\r
26 option is required and indicates the <emphasis>action</emphasis> of the command. In this case
\r
27 <option>start_all</option>.
\r
30 <para>If you receive the error message: <errortext>osrf_ctl.sh: command not found</errortext>, then your environment variable
\r
31 <varname>PATH</varname><indexterm><primary>environment variable</primary><secondary>PATH</secondary></indexterm> does not include the
\r
32 <filename class="directory">/openils/bin</filename> directory. You can set it using the following command:</para>
\r
33 <screen><userinput>export <varname>PATH</varname>=$PATH:<filename class="directory">/openils/bin</filename></userinput></screen>
\r
34 <para>If you receive the error message <errortext>Can't locate OpenSRF/System.pm in @INC … BEGIN
\r
35 failed–compilation aborted</errortext>, then your environment variable <varname>PERL5LIB</varname><indexterm><primary>environment
\r
36 variable</primary><secondary>PERL5LIB</secondary></indexterm> does not
\r
37 include the <filename class="directory">/openils/lib/perl5</filename> directory. You can set it
\r
38 using the following command:</para>
\r
39 <screen><userinput>export <varname>PERL5LIB</varname>=$PERL5LIB:<filename class="directory">/openils/lib/perl5</filename></userinput></screen>
\r
41 <para>It is also possible to start a specific service. For example:</para>
\r
42 <screen><userinput>osrf_ctl.sh -l -a start_router</userinput></screen>
\r
43 <para>will only start the <systemitem class="service">router</systemitem> service.</para>
\r
45 <para>If you decide to start each service individually, you need to start them in a specific order
\r
46 for Evergreen to start correctly. Run the commands in this exact order:</para>
\r
47 <screen><userinput>osrf_ctl.sh -l -a start_router</userinput></screen>
\r
48 <screen><userinput>osrf_ctl.sh -l -a start_perl</userinput></screen>
\r
49 <screen><userinput>osrf_ctl.sh -l -a start_c</userinput></screen>
\r
51 <para>After starting or restarting Evergreen, it is also necessary to restart the <systemitem class="service">Apache web server</systemitem>
\r
52 <indexterm><primary>web server</primary><secondary>Apache</secondary></indexterm> for the OPAC to work correctly.</para>
\r
53 <para>To stop <application>Evergreen</application>, run:</para>
\r
54 <screen><userinput>osrf_ctl.sh -l -a stop_all</userinput></screen>
\r
55 <para>As with starting, you can choose to stop services individually.</para>
\r
56 <para>To restart <application>Evergreen</application>, run:</para>
\r
57 <screen><userinput>osrf_ctl.sh -l -a restart_all</userinput></screen>
\r
59 <title>Starting Specific Perl Services</title>
\r
60 <para>It is also possible to start and stop a specific perl service using <filename>opensrf-perl.pl</filename>. Here is the syntax for starting a perl service with this command:</para>
\r
61 <screen><userinput>opensrf-perl.pl --service <systemitem class="service"><service-name></systemitem> -a start -p <filename class="directory"><PID-directory></filename> </userinput></screen>
\r
62 <para>Example (starting the booking module):</para>
\r
63 <screen><userinput>opensrf-perl.pl --service <systemitem class="service">open-ils.booking</systemitem> -a start -p <filename class="directory">/openils/var/run/opensrf</filename></userinput></screen>
\r
65 <para>This is the syntax for stopping a perl service with this command:</para>
\r
66 <screen><userinput>opensrf-perl.pl --service <systemitem class="service"><service-name></systemitem> -a stop -p <filename class="directory"><PID-directory></filename> </userinput></screen>
\r
67 <para>Example (stopping the booking module):</para>
\r
68 <screen><userinput>opensrf-perl.pl --service <systemitem class="service">open-ils.booking</systemitem> -a stop -p <filename class="directory">/openils/var/run/opensrf</filename></userinput></screen>
\r
69 <para>These commands can be very useful when you edit Perl modules and only need to restart the specific service for changes to take effect.</para>
\r
72 <para>The default for the PID-directory: <filename class="directory">/openils/var/run/opensrf</filename></para>
\r
73 <para>For a clustered server instance of Evergreen, you must store the PIDs on a directory
\r
74 that is local to each server, or else one of your cluster servers may try killing processes on itself that actually have PIDs on other servers.</para>
\r
75 <para>For services running on the local server use the <option>--localhost</option> to force the hostname to be <systemitem class="domainname">localhost</systemitem>,
\r
76 instead of the fully qualified domain name for the machine.</para>
\r
77 <para>To see other options run the command with the <option>-h</option> option:</para>
\r
78 <screen><userinput>opensrf-perl.pl -h</userinput></screen>
\r
80 <para>For a list of Evergreen/OpenSRF perl services see: <xref linkend="_evergreen_specific_opensrf_services"/>.</para>
\r
83 <section xml:id="evergreen_startup_script">
\r
84 <title>Automating Evergreen Startup and Shutdown</title>
\r
85 <para>Once you understand starting and stopping Evergreen, you will want to create a start up script for two purposes:</para>
\r
87 <listitem>Allow you to start, restart and stop Evergreen, SIP, reporter and z39.50 services with one command.</listitem>
\r
88 <listitem>Allow Evergreen to stop and start properly during a system restart.</listitem>
\r
90 <para>The following procedure is for Debian or Ubuntu distributions of Linux.</para>
\r
93 <para>Create a bash script for starting Evergreen and all associated services. Here is an example script:</para>
\r
95 <programlisting><![CDATA[
\r
98 OPENILS_BASE="/openils"
\r
99 OPENILS_CORE="${OPENILS_BASE}/conf/opensrf_core.xml"
\r
100 SRU_LOG="${OPENILS_BASE}/var/log/sru.log"
\r
102 SIP_PID="${OPENILS_BASE}/var/run"
\r
103 SIP_CONF="${OPENILS_BASE}/conf/oils_sip.xml"
\r
105 REP_LOCK="${OPENILS_BASE}/var/lock/reporter-LOCK"
\r
106 REP_NAME="Clark Kent, waiting for trouble"
\r
108 sru_name='simple2zoom'
\r
110 if [ $(whoami) != 'opensrf' ]; then
\r
111 PERL5LIB='/openils/lib/perl5:$PERL5LIB';
\r
116 echo "Starting Evergreen"
\r
117 sudo -u opensrf /bin/bash -c "PERL5LIB=${PERL5LIB}:${OPENILS_BASE}/lib/perl5 PATH=${PATH}:${OPENILS_BASE}/bin osrf_ctl.sh -l -a start_all"
\r
121 echo "Stopping Evergreen"
\r
122 sudo -u opensrf /bin/bash -c "PERL5LIB=${PERL5LIB}:${OPENILS_BASE}/lib/perl5 PATH=${PATH}:${OPENILS_BASE}/bin osrf_ctl.sh -l -a stop_all"
\r
126 echo "Running Autogen Update"
\r
127 sudo -u opensrf /bin/bash -c "PERL5LIB=${PERL5LIB}:${OPENILS_BASE}/lib/perl5 PATH=${PATH}:${OPENILS_BASE}/bin autogen.sh -u -c ${OPENILS_CORE}"
\r
131 sudo -u opensrf /bin/bash -c "PERL5LIB=${PERL5LIB}:${OPENILS_BASE}/lib/perl5 PATH=${PATH}:${OPENILS_BASE}/bin oils_ctl.sh \
\r
138 sudo -u opensrf /bin/bash -c "PERL5LIB=${PERL5LIB}:${OPENILS_BASE}/lib/perl5 PATH=${PATH}:${OPENILS_BASE}/bin oils_ctl.sh \
\r
145 sudo -u opensrf /bin/bash -c "PERL5LIB=${PERL5LIB}:${OPENILS_BASE}/lib/perl5 PATH=${PATH}:${OPENILS_BASE}/bin oils_ctl.sh \
\r
152 pids="$(pidof "$REP_NAME")"
\r
153 if [ ! x"$pids" = x ] ; then
\r
154 echo FAILURE ; echo $"Starting Reporting: already running as $pids"
\r
158 sudo -u opensrf bash -c "PERL5LIB=${PERL5LIB}:${OPENILS_BASE}/lib/perl5 PATH=${PATH}:${OPENILS_BASE}/bin clark-kent.pl \
\r
159 --lockfile=${REP_LOCK} --boostrap=${OPENILS_CORE} --concurrency=1 --sleep=30 --daemon" ;
\r
160 pids="$(pidof "$REP_NAME")"
\r
161 if [ x"$pids" = x ] ; then
\r
166 echo "Starting Reporting: $pids"
\r
171 pids="$(pidof "$REP_NAME")"
\r
172 if [ x"$pids" = x ] ; then
\r
173 echo FAILURE ; echo $"Stopping Reporting: not running" ; RETVAL=1
\r
175 kill $pids ; RETVAL=$?
\r
176 if [ $RETVAL ] ; then
\r
177 echo OK ; echo $"Stopping Reporting: $pids"
\r
187 pids=`ps -eo pid,args | grep $sru_name | grep -v grep | cut -c1-6`
\r
188 if [ ! x"$pids" = x ] ; then
\r
189 echo FAILURE ; echo $"Starting Z39.50/SRU: already running as $pids"
\r
192 sudo -u opensrf bash -c "touch ${SRU_LOG}"
\r
193 sudo bash -c "PERL5LIB=${PERL5LIB}:${OPENILS_BASE}/lib/perl5 PATH=${PATH}:${OPENILS_BASE}/bin z39_50.sh >> ${SRU_LOG} 2>&1" &
\r
195 pids=`ps -eo pid,args | grep $sru_name | grep -v grep | cut -c1-6`
\r
196 if [ x"$pids" = x ] ; then
\r
201 echo "Starting Z39.50/SRU: $pids"
\r
206 pids=`ps -eo pid,args | grep $sru_name | grep -v grep | cut -c1-6`
\r
207 if [ x"$pids" = x ] ; then
\r
208 echo FAILURE ; echo $"Stopping Z39.50/SRU: not running" ; RETVAL=1
\r
210 kill $pids ; RETVAL=$?
\r
211 if [ $RETVAL ] ; then
\r
212 echo OK ; echo $"Stopping Z39.50/SRU: $pids"
\r
234 echo "Restarting Evergreen, Reporter and Z39.50 Processes"
\r
276 start_router|stop_router|restart_router|start_perl|stop_perl|restart_perl| \
\r
277 start_c|stop_c|restart_c|start_osrf|stop_osrf|restart_osrf|stop_all|start_all|restart_all)
\r
278 sudo -u opensrf /bin/bash -c "PERL5LIB=${PERL5LIB}:${OPENILS_BASE}/lib/perl5 PATH=${PATH}:${OPENILS_BASE}/bin osrf_ctl.sh -l -a $1"
\r
281 echo " * Usage: /etc/init.d/evergreen {start|stop|restart|autogen"
\r
282 echo " |sip_start|sip_stop|sip_restart"
\r
283 echo " |z39_50_start|z39_50_stop|z39_50_restart"
\r
284 echo " |start_reporter|stop_reporter|restart_reporter"
\r
285 echo " |start_router|stop_router|restart_router|start_perl|stop_perl|restart_perl"
\r
286 echo " |start_c|stop_c|restart_c|start_osrf|stop_osrf|restart_osrf|stop_all|start_all|restart_all}"
\r
290 ]]></programlisting>
\r
293 <para>Save file in <filename class="directory">/etc/bin</filename> folder as <filename>evergreenstart</filename> if you would like this as a manual script for starting Evergreen services.</para>
\r
295 <para>Save file in <filename class="directory">/etc/init.d</filename> folder as <filename>evergreenstart</filename> if you would like to run this script automatically
\r
296 during your server's boot process as explained in later steps.</para>
\r
299 <para>Ensure that the script is executable.</para>
\r
300 <screen><userinput>sudo chmod 755 evergreenstart </userinput></screen>
\r
303 <para>Test the script by running it from the command line as the <systemitem class="username">root</systemitem> user.</para>
\r
304 <screen><userinput>/etc/init.d/evergreenstart restart</userinput></screen>
\r
305 <para>You will also need to restart apache as the <systemitem class="username">root</systemitem> user.</para>
\r
306 <screen><userinput>/etc/init.d/apache2 restart</userinput></screen>
\r
310 <para>The next steps are optional if you want to automate Evergreen so it starts during your server's boot process.</para>
\r
312 <para>Update runlevel defaults of the new evergreenstart service as the <systemitem class="username">root</systemitem> user:</para>
\r
313 <screen><userinput>update-rc.d evergreenstart defaults 80 20</userinput></screen>
\r
315 <para>For Evergreen to start properly during a reboot, you will want to ensure that the first number (<option>80</option>) is lower than the assigned
\r
316 starting priority for Apache, so it starts before Apache. It should also have a larger stopping priority number (<option>20</option>) than Apache so it stops
\r
317 after Apache during a boot cycle.</para>
\r
321 <para>Test the startup script by rebooting the Evergreen Server and checking to ensure that all Evergreen sercices started properly.</para>
\r
324 <caution><para>This has not yet been tested in a Evergreen multi-server, <quote>brick</quote> configuration.</para></caution>
\r
325 <para>For more information on update-rc.d you should review the documentation on this topic for <link xl:href="http://www.debuntu.org/how-to-manage-services-with-update-rc.d">
\r
326 Debian</link> or <link xl:href="http://manpages.ubuntu.com/manpages/hardy/man8/update-rc.d.8.html">Ubuntu</link> depending on your distribution of Linux.</para>
\r
328 <section xml:id="backingup">
\r
329 <title>Backing Up</title>
\r
330 <indexterm><primary>databases</primary><secondary>backing up</secondary></indexterm>
\r
332 <para>Backing up your system files and data is a critical task for server and database administrators.
\r
333 Having a strategy for backing up and recovery could be the difference between a minor annoyance for users and
\r
334 a complete catastrophe.</para>
\r
336 <title>Backing up the <application>Evergreen</application> Database</title><indexterm><primary>databases</primary></indexterm>
\r
337 <para>Most of the critical data for an <application>Evergreen</application> system – patrons, bibliographic records, holdings,
\r
338 transactions, bills – is stored in the <application>PostgreSQL</application><indexterm><primary>databases</primary>
\r
339 <secondary>PostgreSQL</secondary></indexterm> database. You can therefore use normal
\r
340 <application>PostgreSQL</application> backup procedures to backup this data. For example, the simplest method of backing up the Evergreen
\r
341 database is to use the <command>pg_dump</command> command to create a live backup of the database without having to
\r
342 interrupt any Evergreen services. Here is an example pg_dump command which will dump a local Evergreen database into a the file <filename>evergreen_db.backup</filename>:</para>
\r
343 <screen><userinput>pg_dump -U evergreen -h localhost -f evergreen_db.backup evergreen</userinput></screen>
\r
344 <para>To restore the backed up database into a new database, create a new database using the
\r
345 template0 database template and the UTF8 encoding, and run the <command>psql</command> command, specifying the new
\r
346 database as your target:</para>
\r
347 <screen><userinput>createdb -T template0 -E UTF8 -U evergreen -h localhost new_evergreen</userinput></screen>
\r
348 <screen><userinput>psql -U evergreen -h localhost -f evergreen_db.backup new_evergreen</userinput></screen>
\r
350 <para>This method of backup is only suitable for small Evergreen instances. Larger sites
\r
351 should consider implementing continuous archiving (also known as <quote>log shipping</quote>) to provide
\r
352 more granular backups with lower system overhead. More information on backing up <application>PostgreSQL</application>
\r
353 databases can be found in the official <link xl:href="http://www.postgresql.org/docs/"><application>PostgreSQL</application> documentation</link>.</para>
\r
357 <title>Backing up Evergreen Files</title>
\r
358 <indexterm><primary>directories</primary><secondary>backing up</secondary></indexterm>
\r
359 <para>When you deploy Evergreen, you will probably customize many aspects of your system including
\r
360 the system configuration files, <application>Apache</application> configuration files, OPAC and Staff Client. In order to
\r
361 protect your investment of time, you should carefully consider the best approach to backing up
\r
363 <para>There are a number of ways of tackling this problem. You could create a script that regularly
\r
364 creates a time-stamped tarball of all of these files and copies it to a remote server - but that
\r
365 would build up over time to hundreds of files. You could use <link xl:href="http://www.samba.org/rsync/"><application>rsync</application></link>
\r
366 <indexterm><primary>rsync</primary></indexterm> to ensure that the files of
\r
367 interest are regularly updated on a remote server - but then you would lose track of the changes to
\r
368 the files, should you make a change that introduces a problem down the road.</para>
\r
369 <para>Perhaps one of the best options is to use a version control system like <link xl:href="http://bazaar.canonical.com">
\r
370 <application>Bazaar</application></link><indexterm><primary>Version Control System</primary><secondary>Subversion</secondary></indexterm>,
\r
371 <link xl:href="http://git-scm.com/"><application>git</application></link><indexterm><primary>Version Control System</primary><secondary>git</secondary></indexterm>
\r
372 or <link xl:href="http://subversion.apache.org/"><application>Subversion</application></link><indexterm><primary>Version Control System</primary>
\r
373 <secondary>Subversion</secondary></indexterm> to regularly push updates of the files you care about to a repository on a
\r
374 remote server. This gives you the advantage of quickly being able to run through the history of the
\r
375 changes you made, with a commenting system that reminds you why each change was made, combined with
\r
376 remote storage of the pertinent files in case of disaster on site. In addition, your team can create
\r
377 local copies of the repository and test their own changes in isolation from the production
\r
378 system. Using a version control system also helps to recover system customizations after an
\r
382 <title>Full System Backup</title>
\r
383 <para>A full system backup archives every file on the file system. Some basic methods require you
\r
384 to shut down most system processes; other methods can use mirrored RAID<indexterm><primary>RAID</primary></indexterm> setups or
\r
385 SAN<indexterm><primary>SAN</primary></indexterm> storage to
\r
386 take <quote>snapshot</quote> backups of your full system while the system continues to run. The subject of how
\r
387 to implement full system backups is beyond the scope of this documentation.</para>
\r
390 <section xml:id="security">
\r
391 <title>Security</title>
\r
392 <indexterm><primary>security</primary></indexterm>
\r
393 <para>As with an ILS and resource accessible from the world wide web careful consideration needs to be
\r
394 given to the security of your <application>Evergreen</application> servers and database. While it is impossible to cover all aspects
\r
395 of security, it is important to take several precautions when setting up production <application>Evergreen</application> site.</para>
\r
398 <para>Change the Evergreen <systemitem class="username">admin</systemitem> password and keep it secure. The
\r
399 default admin password is known by anyone who has installed <application>Evergreen</application>. It is not a secret
\r
400 and needs to be changed by the Administrator. It should also only be shared by those who
\r
401 need the highest level of access to your system.</para>
\r
404 <para>Create strong passwords using a combination of numerical and alphabetical characters
\r
405 for all of the Administrative passwords including the <systemitem class="username">postgres</systemitem> and
\r
406 <systemitem class="username">opensrf</systemitem> users</para>
\r
409 <para>Open ports in the firewall<indexterm><primary>firewall</primary></indexterm> with caution - It is only necessary to open ports
\r
410 <systemitem class="protocol">80</systemitem> and <systemitem class="protocol">443</systemitem>
\r
411 for <systemitem class="protocol">TCP</systemitem> connections to the Evergreen server from the OPAC and the staff client. It is critical for administrators to
\r
412 understand the concepts of network security and take precautions to minimize vulnerabilities.
\r
416 <para>Use permissions <indexterm><primary>permissions</primary></indexterm> and permission groups wisely - it is important to understand the
\r
417 purpose of the permissions and to only give users the level of access that they require.
\r
422 <section xml:id="logfiles">
\r
423 <title>Managing Log Files</title>
\r
424 <indexterm><primary>logs</primary><secondary>managing</secondary></indexterm>
\r
425 <para><application>Evergreen</application> comes with a sophisticated logging system, but it is important to manage the <application>OpenSRF</application>
\r
426 and <application>Evergreen</application> logs. This section will provide a couple of log management techniques and tools.</para>
\r
428 <title>Using the <systemitem class="service">logrotate</systemitem> Utility to Manage Log Size</title>
\r
429 <indexterm><primary>logs</primary><secondary>Log Rotate</secondary></indexterm>
\r
430 <para>Fortunately, this is not a new problem for <systemitem class="osname">Unix</systemitem> administrators, and there are a number of ways of keeping your logs under control.
\r
431 On <systemitem class="osname">Debian</systemitem> and <systemitem class="osname">Ubuntu</systemitem>, for example,
\r
432 the <systemitem class="service">logrotate</systemitem> utility controls when old log files are compressed and a new log file is started.
\r
433 <systemitem class="service">logrotate</systemitem> runs once a day and checks all log files that it knows about to see if a
\r
434 threshold of time or size has been reached and rotates the log files if a threshold condition has been met.</para>
\r
435 <para>To teach <systemitem class="service">logrotate</systemitem> to rotate Evergreen logs on a weekly basis, or if they are > 50MB in size,
\r
436 create a new file <filename>/etc/logrotate.d/evergreen</filename> with the following contents: </para>
\r
439 /openils/var/log/*.log {
\r
440 # keep the last 4 archived log files along with the current log file
\r
441 # log log.1.gz log.2.gz log.3.gz log.4.gz
\r
442 # and delete the oldest log file (what would have been log.5.gz)
\r
444 # if the log file is > 50MB in size, rotate it immediately
\r
446 # for those logs that don't grow fast, rotate them weekly anyway
\r
452 <title>Changing Logging Level for <application>Evergreen</application></title>
\r
453 <indexterm><primary>logs</primary><secondary>logging levels</secondary></indexterm>
\r
454 <para>Change the Log Levels in your config files. Changing the level of logging will help
\r
455 narrow down errors.</para>
\r
457 <para>A high logging level is not wise to do in a production environment since it
\r
458 will produce vastly larger log files and thus reduce server performance.</para>
\r
460 <para>Change logging levels by editing the configuration file
\r
461 <filename>/openils/conf/opensrf_core.xml</filename><indexterm><primary>configuration files</primary><secondary>opensrf_core.xml</secondary></indexterm></para>
\r
462 <para>you will want to search for lines containing <loglevel>.</para>
\r
463 <para> the default setting for loglevel is 3 which will log <emphasis>errors</emphasis>,
\r
464 <emphasis>warnings</emphasis> and <emphasis>information</emphasis>.</para>
\r
465 <para>The next level is 4 which is for debugging and provides additional information
\r
466 helpful for the debugging process.</para>
\r
467 <para>Thus, lines with:</para>
\r
468 <programlisting><loglevel>3</loglevel></programlisting>
\r
469 <para>Should be changed to:</para>
\r
470 <programlisting><loglevel>4</loglevel></programlisting>
\r
471 <para>to allow debugging level logging</para>
\r
472 <para>Other logging levels include <emphasis>0</emphasis> for no logging,
\r
473 <emphasis>1</emphasis> for logging errors and <emphasis>2</emphasis> for logging warnings
\r
477 <section xml:id="InstallingPostgreSQL">
\r
478 <title>Installing PostgreSQL from Source</title>
\r
479 <indexterm><primary>databases</primary><secondary>PostgreSQL</secondary></indexterm>
\r
480 <para>Some <systemitem class="osname">Linux</systemitem> distributions, such as <systemitem class="osname">Debian Etch (4.0)</systemitem>, do not offer PostgreSQL
\r
481 version 8.2 as an installable package. Before you continue, examine the software dependencies listed in <xref linkend="serversideinstall-software-dependencies"/>
\r
482 to ensure that your Linux distribution supports the required version of PostgreSQL.</para>
\r
485 <para>Some <systemitem class="osname">Linux</systemitem> distributions, such as <systemitem class="osname">Debian Etch (4.0)</systemitem>, do not offer PostgreSQL
\r
486 version 8.2 as an installable package. Before you continue, examine the software dependencies listed in <xref linkend="serversideinstall-software-dependencies"/>
\r
487 to ensure that your Linux distribution supports the required version of PostgreSQL.</para>
\r
492 <para>Install the application <application>stow</application> on your system if it is not already installed. Issue the following command as
\r
493 the <systemitem class="username">root</systemitem> user:</para>
\r
495 <userinput>apt-get install stow</userinput>
\r
499 <para>Download, compile, and install the latest release for PostgreSQL 8.2 (which was version <literal>8.2.12</literal> at the time of this writing).
\r
500 As the <systemitem class="username">root</systemitem> user, follow these steps:</para>
\r
504 wget http://wwwmaster.postgresql.org/redir/198/h/source/v8.2.17/postgresql-8.2.17.tar.bz2
\r
505 tar xzf postgresql-8.2.17.tar.gz
\r
506 cd postgresql-8.2.17
\r
507 ./configure --with-perl --enable-integer-datetimes --with-openssl --prefix=/usr/local/stow/pgsql
\r
523 <para>Create the new user <systemitem class="username">postgres</systemitem> to run the PostgreSQL processes.
\r
524 As the <systemitem class="username">root</systemitem> user, execute this command:</para>
\r
525 <screen><userinput>adduser postgres</userinput></screen>
\r
528 <para>Initialize the database directory and start up PostgreSQL. As the <systemitem class="username">root</systemitem> user, follow these steps:</para>
\r
532 mkdir -p /usr/local/pgsql/data
\r
533 chown postgres /usr/local/pgsql/data
\r
535 initdb -D /usr/local/pgsql/data -E UNICODE --locale=C
\r
536 pg_ctl -D /usr/local/pgsql/data -l /home/postgres/logfile start
\r
540 <para>If an error occurs during the final step above, review the path of the home directory for the
\r
541 <systemitem class="username">postgres</systemitem> user. It may be <literal>/var/lib/postresql</literal> instead of <literal>/home/postres</literal>.</para>
\r
546 <section xml:id="configuringPostgreSQL">
\r
547 <title>Configuring PostgreSQL</title>
\r
548 <indexterm><primary>databases</primary><secondary>PostgreSQL</secondary></indexterm>
\r
549 <para>The values of several PostreSQL configuration parameters may be changed for enhanced performance. The following table lists the default values
\r
550 and some suggested updates for several useful parameters:</para>
\r
552 <title>Suggested configuration values</title>
\r
553 <tgroup align="left" cols="3" colsep="1" rowsep="1">
\r
554 <colspec colnum="1" colwidth="1.0*"/>
\r
555 <colspec colnum="2" colwidth="1.0*"/>
\r
556 <colspec colnum="3" colwidth="1.0*"/>
\r
559 <entry>Parameter</entry>
\r
560 <entry>Default</entry>
\r
561 <entry>Suggested</entry>
\r
566 <entry>default_statistics_target</entry>
\r
571 <entry>work_mem</entry>
\r
573 <entry>128Mb</entry>
\r
576 <entry>shared_buffers</entry>
\r
578 <entry>512Mb</entry>
\r
581 <entry>effective_cache_size</entry>
\r
582 <entry>128Mb</entry>
\r