X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=doc%2Fbook.xml;h=9f96d75a39d3f3fdad14e70eb20d3451c304428d;hb=0393c84c2d2383ec40fe6058325b8b0f5334d16b;hp=a577d5b279760f05d87ccc018a3ee54021c58218;hpb=3bfc9073c490d556d12dd2d69e0bb2ed6059b71b;p=pazpar2-moved-to-github.git
diff --git a/doc/book.xml b/doc/book.xml
index a577d5b..9f96d75 100644
--- a/doc/book.xml
+++ b/doc/book.xml
@@ -1,6 +1,6 @@
-
%local;
@@ -24,6 +24,12 @@
JakubSkoczen
+
+ MikeTaylor
+
+
+ DennisSchafroth
+
&version;
©right-year;
@@ -45,150 +51,172 @@
-
-
-
-
-
+
+
+
+
+
Introduction
-
- Pazpar2 is a stand-alone metasearch engine with a web-service API, designed
- to be used either from a browser-based client (JavaScript, Flash,
- Java applet,
- etc.), from server-side code, or any combination of the two.
- Pazpar2 is a highly optimized client designed to
- search many resources in parallel. It implements record merging,
- relevance-ranking and sorting by arbitrary data content, and facet
- analysis for browsing purposes. It is designed to be data-model
- independent, and is capable of working with MARC, DublinCore, or any
- other XML-structured response format
- -- XSLT is used to normalize and extract
- data from retrieval records for display and analysis. It can be used
- against any server which supports the
- Z39.50 or SRU/SRW
- protocol. Proprietary
- backend modules can function as connectors between these standard
- protocols and any non-standard API, including web-site scraping, to
- support a large number of other protocols
- (please contact Index Data for further information about this).
-
-
- Additional functionality such as
- user management and attractive displays are expected to be implemented by
- applications that use Pazpar2. Pazpar2 itself is user-interface independent.
- Its functionality is exposed through a simple XML RPC web-service API,
- designed to be easy to use from an AJAX-enabled browser, Flash
- animation, Java applet, etc., or from a higher-level server-side language
- like PHP, Perl or Java. Because session information can be shared between
- browser-based logic and server-side scripting, there is tremendous
- flexibility in how you implement application-specific logic on top
- of Pazpar2.
-
-
- Once you launch a search in Pazpar2, the operation continues behind the
- scenes. Pazpar2 connects to servers, carries out searches, and
- retrieves, deduplicates, and stores results internally. Your application
- code may periodically inquire about the status of an ongoing operation,
- and ask to see records or result set facets. Results become
- available immediately, and it is easy to build end-user interfaces than
- feel extremely responsive, even when searching more than 100 servers
- concurrently.
-
-
- Pazpar2 is designed to be highly configurable. Incoming records are
- normalized to XML/UTF-8, and then further normalized using XSLT to a
- simple internal representation that is suitable for analysis. By
- providing XSLT stylesheets for different kinds of result records, you
- can configure Pazpar2 to work against different kinds of information
- retrieval servers. Finally, metadata is extracted in a configurable
- way from this internal record, to support display, merging, ranking,
- result set facets, and sorting. Pazpar2 is not bound to a specific model
- of metadata, such as DublinCore or MARC: by providing the right
- configuration, it can work with any combination of different kinds of data in
- support of many different applications.
-
-
- Pazpar2 is designed to be efficient and scalable. You can set it up to
- search several hundred targets in parallel, or you can use it to support
- hundreds of concurrent users. It is implemented with the same attention
- to performance and economy that we use in our indexing engines, so that
- you can focus on building your application without worrying about the
- details of metasearch logic. You can devote all of your attention to
- usability and let Pazpar2 do what it does best -- metasearch.
-
-
- If you wish to connect to commercial or other databases which do not
- support open standards, please contact Index Data. We have a
- proprietary framework for building connectors that enable Pazpar2
- to access
- thousands of online databases, in addition to the vast number of catalogs
- and online services that support the Z39.50/SRU/SRW protocols.
-
-
- Pazpar2 is our attempt to re-think the traditional paradigms for
- implementing and deploying metasearch logic, with an uncompromising
- approach to performance, and attempting to make maximum use of the
- capabilities of modern browsers. The demo user interface that
- accompanies the distribution is but one example. If you think of new
- ways of using Pazpar2, we hope you'll share them with us, and if we
- can provide assistance with regards to training, design, programming,
- integration with different backends, hosting, or support, please don't
- hesitate to contact us. If you'd like to see functionality in Pazpar2
- that is not there today, please don't hesitate to contact us. It may
- already be in our development pipeline, or there might be a
- possibility for you to help out by sponsoring development time or
- code. Either way, get in touch and we will give you straight answers.
-
-
- Enjoy!
-
-
- Pazpar2 is covered by the GNU General Public License (GPL) version 2.
- See for further information.
-
+
+
+ What Pazpar2 is
+
+ Pazpar2 is a stand-alone metasearch engine with a web-service API, designed
+ to be used either from a browser-based client (JavaScript, Flash,
+ Java applet,
+ etc.), from server-side code, or any combination of the two.
+ Pazpar2 is a highly optimized client designed to
+ search many resources in parallel. It implements record merging,
+ relevance-ranking and sorting by arbitrary data content, and facet
+ analysis for browsing purposes. It is designed to be data-model
+ independent, and is capable of working with MARC, DublinCore, or any
+ other XML-structured response format
+ -- XSLT is used to normalize and extract
+ data from retrieval records for display and analysis. It can be used
+ against any server which supports the
+ Z39.50, SRU/SRW
+ or SOLR protocol. Proprietary
+ backend modules can function as connectors between these standard
+ protocols and any non-standard API, including web-site scraping, to
+ support a large number of other protocols.
+
+
+ Additional functionality such as
+ user management and attractive displays are expected to be implemented by
+ applications that use Pazpar2. Pazpar2 itself is user-interface independent.
+ Its functionality is exposed through a simple XML-based web-service API,
+ designed to be easy to use from an Ajax-enabled browser, Flash
+ animation, Java applet, etc., or from a higher-level server-side language
+ like PHP, Perl or Java. Because session information can be shared between
+ browser-based logic and server-side scripting, there is tremendous
+ flexibility in how you implement application-specific logic on top
+ of Pazpar2.
+
+
+ Once you launch a search in Pazpar2, the operation continues behind the
+ scenes. Pazpar2 connects to servers, carries out searches, and
+ retrieves, deduplicates, and stores results internally. Your application
+ code may periodically inquire about the status of an ongoing operation,
+ and ask to see records or result set facets. Results become
+ available immediately, and it is easy to build end-user interfaces than
+ feel extremely responsive, even when searching more than 100 servers
+ concurrently.
+
+
+ Pazpar2 is designed to be highly configurable. Incoming records are
+ normalized to XML/UTF-8, and then further normalized using XSLT to a
+ simple internal representation that is suitable for analysis. By
+ providing XSLT stylesheets for different kinds of result records, you
+ can configure Pazpar2 to work against different kinds of information
+ retrieval servers. Finally, metadata is extracted in a configurable
+ way from this internal record, to support display, merging, ranking,
+ result set facets, and sorting. Pazpar2 is not bound to a specific model
+ of metadata, such as DublinCore or MARC: by providing the right
+ configuration, it can work with any combination of different kinds of data
+ in support of many different applications.
+
+
+ Pazpar2 is designed to be efficient and scalable. You can set it up to
+ search several hundred targets in parallel, or you can use it to support
+ hundreds of concurrent users. It is implemented with the same attention
+ to performance and economy that we use in our indexing engines, so that
+ you can focus on building your application without worrying about the
+ details of metasearch logic. You can devote all of your attention to
+ usability and let Pazpar2 do what it does best -- metasearch.
+
+
+ Pazpar2 is our attempt to re-think the traditional paradigms for
+ implementing and deploying metasearch logic, with an uncompromising
+ approach to performance, and attempting to make maximum use of the
+ capabilities of modern browsers. The demo user interface that
+ accompanies the distribution is but one example. If you think of new
+ ways of using Pazpar2, we hope you'll share them with us, and if we
+ can provide assistance with regards to training, design, programming,
+ integration with different backends, hosting, or support, please don't
+ hesitate to contact us. If you'd like to see functionality in Pazpar2
+ that is not there today, please don't hesitate to contact us. It may
+ already be in our development pipeline, or there might be a
+ possibility for you to help out by sponsoring development time or
+ code. Either way, get in touch and we will give you straight answers.
+
+
+ Enjoy!
+
+
+ Pazpar2 is covered by the GNU General Public License (GPL) version 2.
+ See for further information.
+
+
+
+
+ Connectors to non-standard databases
+
+ If you wish to connect to commercial or other databases which do not
+ support open standards, please contact Index Data on
+ info@indexdata.com. We have a
+ proprietary framework for building connectors that enable Pazpar2
+ to access
+ thousands of online databases, in addition to the vast number of catalogs
+ and online services that support the Z39.50/SRU/SRW/SOLR protocols.
+
+
+
+
+ A note on the name Pazpar2
+
+ The name Pazpar2 derives from three sources. One one hand, it is
+ Index Data's second major piece of software that does parallel
+ searching of Z39.50 targets. On the other, it is a near-homophone
+ of Passpartout, the ever-helpful servant in Jules Verne's novel
+ Around the World in Eighty Days (who helpfully uses the language
+ of his master). Finally, "passe par tout" means something like
+ "passes through anything" in French -- on other words, a universal
+ solution, or if you like a MasterKey.
+
+
Installation
- The Pazpar2 package is very small. It includes documentation as well
+ The Pazpar2 package includes documentation as well
as the Pazpar2 server. The package also includes a simple user
- interface test1 which consists of a single HTML page and a single
+ interface called "test1", which consists of a single HTML page and a single
JavaScript file to illustrate the use of Pazpar2.
Pazpar2 depends on the following tools/libraries:
YAZ
-
-
- The popular Z39.50 toolkit for the C language.
- YAZ must be compiled with Libxml2/Libxslt support.
-
-
+
+
+ The popular Z39.50 toolkit for the C language.
+ YAZ must be compiled with Libxml2/Libxslt support.
+
+
International
- Components for Unicode (ICU)
-
-
- ICU provides Unicode support for non-English languages with
- character sets outside the range of 7bit ASCII, like
- Greek, Russian, German and French. Pazpar2 uses the ICU
- Unicode character conversions, Unicode normalization, case
- folding and other fundamental operations needed in
- tokenization, normalization and ranking of records.
-
-
- Compiling, linking, and usage of the ICU libraries is optional,
- but strongly recommended for usage in an international
- environment.
-
-
+ Components for Unicode (ICU)
+
+
+ ICU provides Unicode support for non-English languages with
+ character sets outside the range of 7bit ASCII, like
+ Greek, Russian, German and French. Pazpar2 uses the ICU
+ Unicode character conversions, Unicode normalization, case
+ folding and other fundamental operations needed in
+ tokenization, normalization and ranking of records.
+
+
+ Compiling, linking, and usage of the ICU libraries is optional,
+ but strongly recommended for usage in an international
+ environment.
+
+
@@ -198,28 +226,32 @@
- Installation on Unix (from Source)
+ Installation from source on Unix (including Linux, MacOS, etc.)
The latest source code for Pazpar2 is available from
.
- Only few systems have none of the required
- tools binary packages.
- If, for example, Libxml2/libXSLT libraries
- are already installed as development packages use these.
+ Most Unix-based operating systems have the required
+ tools available as binary packages.
+ For example, if Libxml2/libXSLT libraries
+ are already installed as development packages, use these.
- Ensure that the development libraries + header files are
+ Ensure that the development libraries and header files are
available on your system before compiling Pazpar2. For installation
- of YAZ, refer to the YAZ installation chapter.
+ of YAZ, refer to the Installation chapter of the YAZ manual at
+ .
+
+
+ Once the dependencies are in place, Pazpar2 can be unpacked and
+ installed as follows:
- gunzip -c pazpar2-version.tar.gz|tar xf -
- cd pazpar2-version
+ tar xzf pazpar2-VERSION.tar.gz
+ cd pazpar2-VERSION
./configure
make
- su
- make install
+ sudo make install
The make install will install manpages as well as the
@@ -229,65 +261,69 @@
changed with configure option .
-
+
- Installation on Windows (from Source)
-
- Pazpar2 can be built for Windows using
- Microsoft Visual Studio.
- The support files for building YAZ on Windows are located in the
- win directory. The compilation is performed
- using the win/makefile which is to be
- processed by the NMAKE utility part of Visual Studio.
-
-
- Ensure that the development libraries + header files are
- available on your system before compiling Pazpar2. For installation
- of YAZ, refer to the YAZ installation chapter.
- It is easiest if YAZ and Pazpar2 are unpacked in the same
- directory (side-by-side).
-
-
- The compilation is tuned by editing the makefile of Pazpar2.
- The process is similar to YAZ. Adjust the various directories
- YAZ_DIR, ZLIB_DIR, ..
-
-
- Compile Pazpar2 by invoking nmake in
- the win directory.
- The resulting binaries of the build process are located in the
- bin of the Pazpar2 source
- tree - including the pazpar2.exe and necessary DLLs.
-
-
- The Windows version of Pazpar2 is a console application. It may
- be installed as a Windows Service by adding option
- -install for the pazpar2 program. This will
- register Pazpar2 as a service and use the other options provided
- in the same invocation. For example:
-
- cd \MyPazpar2\etc
- ..\bin\pazpar2 -install -f pazpar2.cfg -l pazpar2.log
-
- The Pazpar2 service may now be controlled via the Service Control
- Panel. It may be unregistered by passing the -remove
- option. Example:
-
- cd \MyPazpar2\etc
- ..\bin\pazpar2 -remove
-
-
+ Installation from source on Windows
+
+ Pazpar2 can be built for Windows using
+ Microsoft Visual Studio.
+ The support files for building YAZ on Windows are located in the
+ win directory. The compilation is performed
+ using the win/makefile which is to be
+ processed by the NMAKE utility part of Visual Studio.
+
+
+ Ensure that the development libraries and header files are
+ available on your system before compiling Pazpar2. For installation
+ of YAZ, refer to
+ the Installation chapter of the YAZ manual at
+ .
+ It is easiest if YAZ and Pazpar2 are unpacked in the same
+ directory (side-by-side).
+
+
+ The compilation is tuned by editing the makefile of Pazpar2.
+ The process is similar to YAZ. Adjust the various directories
+ YAZ_DIR, ZLIB_DIR, etc.,
+ as required.
+
+
+ Compile Pazpar2 by invoking nmake in
+ the win directory.
+ The resulting binaries of the build process are located in the
+ bin of the Pazpar2 source
+ tree - including the pazpar2.exe and necessary DLLs.
+
+
+ The Windows version of Pazpar2 is a console application. It may
+ be installed as a Windows Service by adding option
+ -install for the pazpar2 program. This will
+ register Pazpar2 as a service and use the other options provided
+ in the same invocation. For example:
+
+ cd \MyPazpar2\etc
+ ..\bin\pazpar2 -install -f pazpar2.cfg -l pazpar2.log
+
+ The Pazpar2 service may now be controlled via the Service Control
+ Panel. It may be unregistered by passing the -remove
+ option. Example:
+
+ cd \MyPazpar2\etc
+ ..\bin\pazpar2 -remove
+
+
-
+
- Installation of test1 interface
+ Installation of test interfaces
- In this section we outline how to install a simple interface that
- is part of the Pazpar2 source package. Note that Debian users can
- save time by just installing package pazpar2-test1.
+ In this section we show how to make available the set of simple
+ interfaces that are part of the Pazpar2 source package, and which
+ demonstrate some ways to use Pazpar2. (Note that Debian users can
+ save time by just installing the package pazpar2-test1.)
- A web server must be installed and running on the system, such as Apache.
+ A web server, such as Apache, must be installed and running on the system.
@@ -305,31 +341,51 @@
..\bin\pazpar2 -f pazpar2.cfg
This will start a Pazpar2 listener on port 9004. It will proxy
- HTTP requests to localhost - port 80, which we assume will be the regular
+ HTTP requests to port 80 on localhost, which we assume will be the regular
HTTP server on the system. Inspect and modify pazpar2.cfg as needed
- if this is to be changed. The pazpar2.cfg includes settings from the
+ if this is to be changed. The pazpar2.cfg file includes settings from the
file settings/edu.xml
to use for searches.
+
- Make a new console and move to the other stuff.
- For more information about pazpar2 options refer to the manpage.
+ The test UIs are located in www. Ensure that this
+ directory is available to the web server by copying
+ www to the document root,
+ using Apache's Alias directive, or
+ creating a symbolic link: for example, on a Debian or Ubuntu
+ system with Apache2 installed from the standard package, you might
+ make the link as follows:
+
+ cd .../pazpar2
+ sudo ln -s `pwd`/www /var/www/pazpar2-demo
+
-
+
- The test1 UI is located in www/test1. Ensure this
- directory is available to the web server by either copying
- test1 to the document root, create a symlink or
- use Apache's Alias directive.
+ This makes the test applications visible at
+
+ but they can not be run successfully from that URL, as they submit
+ search requests back to the server form which they were served,
+ and Apache2 doesn't know how to handle them. Instead, the test
+ applications must be accessed from Pazpar2 itself, acting as a
+ proxy to Apache2, at the URL
+
- The interface test1 interface should now be available on port 8004.
+ From here, the demo applications can be
+ accessed: test1, test2 and
+ jsdemo
+ are pure HTML+JavaScript setups, needing no server-side
+ intelligence;
+ demo
+ requires PHP on the server.
- If you don't see the test1 interface. See if test1 is really available
- on the same URL but on port 80. If it's not, the Apache configuration
- (or other) is not correct.
+ If you don't see the test interfaces, check whether they are available
+ on port 80 (i.e. directly from the Apache2 server). If not, the
+ Apache configuration is incorrect.
In order to use Apache as frontend for the interface on port 80
@@ -339,22 +395,27 @@
- Installation on Debian GNU/Linux
+ Installation on Debian GNU/Linux and Ubuntu
- Index Data provides Debian packages for Pazpar2. These are prepared
- for Debian versions Etch and Lenny (as of 2007).
- These packages are available at
- .
+ Index Data provides Debian and Ubuntu packages for Pazpar2.
+ As of February 2010, these
+ are prepared for Debian versions Etch, Lenny and Squeeze; and for
+ Ubuntu versions 8.04 (hardy), 8.10 (intrepid), 9.04 (jaunty) and
+ 9.10 (karmic). These packages are available at
+ and
+ .
-
+
Apache 2 Proxy
Apache 2 has a
-
+
proxy module
- which allows Pazpar2 to become a backend to an Apache 2
+
+ which allows Pazpar2 to become a backend to an Apache 2
based web service. The Apache 2 proxy must operate in the
Reverse Proxy mode.
@@ -363,17 +424,19 @@
On a Debian based Apache 2 system, the relevant modules can
be enabled with:
- sudo a2enmod proxy_http
+ sudo a2enmod proxy_http proxy_balancer
-
+
Traditionally Pazpar2 interprets URL paths with suffix
/search.pz2.
The
- ProxyPass directive of Apache must be used to map a URL path
+
+ ProxyPass
+
+ directive of Apache must be used to map a URL path
the the Pazpar2 server (listening port).
@@ -410,16 +473,16 @@
-
+
-
+
Using Pazpar2
This chapter provides a general introduction to the use and
deployment of Pazpar2.
-
+
Pazpar2 and your systems architecture
@@ -430,11 +493,11 @@
possible to combine Pazpar2 either with your server-side dynamic
website scripting, with scripting or code running in the browser, or
with any combination of the two. Pazpar2 is an excellent tool for
- building advanced, AJAX-based user interfaces for metasearch
+ building advanced, Ajax-based user interfaces for metasearch
functionality, but it isn't a requirement -- you can choose to use
Pazpar2 entirely as a backend to your regular server-side scripting.
When you do use Pazpar2 in conjunction
- with browser scripting (JavaScript/AJAX, Flash, applets,
+ with browser scripting (JavaScript/Ajax, Flash, applets,
etc.), there are special considerations.
@@ -450,7 +513,7 @@
with the server from which the enclosing HTML page or object
originated, Pazpar2 is designed so that it can act as a transparent
proxy in front of an existing webserver (see for details).
+ linkend="pazpar2_conf"/> for details).
In this mode, all regular
HTTP requests are transparently passed through to your webserver,
while Pazpar2 only intercepts search-related webservice requests.
@@ -516,7 +579,7 @@
- The Shining
+ The Shining
King, Stephen
@@ -525,11 +588,11 @@
]]>
-
+
As you can see, there isn't much to it. There are really only a few
important elements to this file.
-
+
Elements should belong to the namespace
http://www.indexdata.com/pazpar2/1.0.
@@ -541,7 +604,8 @@
records are never merged. The 'metadata' elements provide the meat
of the elements -- the content. the 'type' attribute is used to
match each element against processing rules that determine what
- happens to the data element next.
+ happens to the data element next. The attribute, 'rank' specifies
+ specifies a multipler for ranking for this element.
@@ -559,7 +623,7 @@
You can use Pazpar2 from any environment that allows you to use
webservices. The initial goal of the software was to support
- AJAX-based applications, but there literally are no limits to what
+ Ajax-based applications, but there literally are no limits to what
you can do. You can use Pazpar2 from Javascript, Flash, Java, etc.,
on the browser side, and from any development environment on the
server side, and you can pass session tokens and record IDs freely
@@ -571,7 +635,7 @@
The webservice API of Pazpar2 is described in detail in .
-
+
In brief, you use the 'init' command to create a session, a
temporary workspace which carries information about the current
@@ -588,8 +652,8 @@
Connecting to non-standard resources
Pazpar2 uses Z39.50 as its switchboard language -- i.e. as far as it
- is concerned, all resources speak Z39.50, or its webservices derivatives,
- SRU/SRW. It is, however, equipped
+ is concerned, all resources speak Z39.50, its webservices derivatives,
+ SRU/SRW and SOLR servers exposing Lucene indexes. It is, however, equipped
to handle a broad range of different server behavior, through
configurable query mapping and record normalization. If you develop
configuration, stylesheets, etc., for a new type of resources, we
@@ -605,11 +669,12 @@
no effort. Resources that use non-standard record formats will
require a bit of XSLT work, but that's all.
-
+
- But what about resources that don't support Z39.50 at all? Some resources might
- support OpenSearch, private, XML/HTTP-based protocols, or something
- else entirely. Some databases exist only as web user interfaces and
+ But what about resources that don't support Z39.50 at all?
+ Some resources might support OpenSearch, private, XML/HTTP-based
+ protocols, or something else entirely.
+ Some databases exist only as web user interfaces and
will require screen-scraping. Still others exist only as static
files, or perhaps as databases supporting the OAI-PMH protocol.
There is hope! Read on.
@@ -620,12 +685,12 @@
work with database vendors to support standards, so you don't have
to worry about programming against non-standard services. We also
provide tools (see SimpleServer)
+ url="http://www.indexdata.com/simpleserver">SimpleServer)
which make it comparatively easy to build gateways against servers
with non-standard behavior. Again, we encourage you to share any
work you do in this direction.
-
+
But the bottom line is that working with non-standard resources in
metasearching is really, really hard. If you want to build a
@@ -682,9 +747,17 @@
Load balancing
- Just like any web server, Pazpar2, can be load balanced by a standard hardware or software load balancer as long as the session stickiness is ensured. If you are already running the Apache2 web server in front of Pazpar2 and use the apache mod_proxy module to 'relay' client requests to Pazpar2, this set up can be easily extended to include load balancing capabilites. To do so you need to enable the
- mod_proxy_balancer
- module in your Apache2 installation.
+ Just like any web server, Pazpar2, can be load balanced by a standard
+ hardware or software load balancer as long as the session stickiness
+ is ensured. If you are already running the Apache2 web server in front
+ of Pazpar2 and use the apache mod_proxy module to 'relay' client
+ requests to Pazpar2, this set up can be easily extended to include
+ load balancing capabilites.
+ To do so you need to enable the
+
+ mod_proxy_balance
+
+ module in your Apache2 installation.
@@ -696,14 +769,28 @@
- The mod_proxy_balancer can pass all 'sessionsticky' requests to the same backend worker as long as the requests are marked with the originating worker's ID (called 'route'). If the Pazpar2 serverID is configured (by setting an 'id' attribute on the 'server' element in the Pazpar2 configuration file) Pazpar2 will append it to the 'session' element returned during the 'init' in a mod_proxy_balancer compatible manner. Since the 'session' is then re-sent by the client (for all pazpar2 request besides 'init'), the balancer can use the marker to pass the request to the right route. To do so the balancer needs to be configured to inspect the 'session' parameter.
+ The mod_proxy_balancer can pass all 'sessionsticky' requests to the
+ same backend worker as long as the requests are marked with the
+ originating worker's ID (called 'route'). If the Pazpar2 serverID is
+ configured (by setting an 'id' attribute on the 'server' element in
+ the Pazpar2 configuration file) Pazpar2 will append it to the
+ 'session' element returned during the 'init' in a mod_proxy_balancer
+ compatible manner.
+ Since the 'session' is then re-sent by the client (for all pazpar2
+ request besides 'init'), the balancer can use the marker to pass
+ the request to the right route. To do so the balancer needs to be
+ configured to inspect the 'session' parameter.
Apache 2 load balancing configuration
- Having 4 Pazpar2 instances running on the same host, port range of 8004-8007 and serverIDs of: pz1, pz2, pz3 and pz4 respectively we could use the following Apache 2 configuration to expose a single pazpar2 'endpoint' on a standard (/pazpar2/search.pz2) location:
-
+ Having 4 Pazpar2 instances running on the same host, port range of
+ 8004-8007 and serverIDs of: pz1, pz2, pz3 and pz4 respectively we
+ could use the following Apache 2 configuration to expose a single
+ pazpar2 'endpoint' on a standard
+ (/pazpar2/search.pz2) location:
+
AddDefaultCharset off
@@ -723,15 +810,21 @@
# route is resent in the 'session' param which has the form:
# 'sessid.serverid', understandable by the mod_proxy_load_balancer
# this is not going to work if the client tampers with the 'session' param
- ProxyPass /pazpar2/search.pz2 balancer://pz2cluster lbmethod=byrequests stickysession=session nofailover=On]]>
-
- The 'ProxyPass' line sets up a reverse proxy for request â/pazpar2/search.pz2â and delegates all requests to the load balancer (virtual worker) with name âpz2clusterâ. Sticky sessions are enabled and implemented using the âsessionâ parameter. The âProxyâ section lists all the servers (real workers) which the load balancer can use.
-
-
-
-
+ ProxyPass /pazpar2/search.pz2 balancer://pz2cluster lbmethod=byrequests stickysession=session nofailover=On
+ ]]>
+
+ The 'ProxyPass' line sets up a reverse proxy for request
+ â/pazpar2/search.pz2â and delegates all requests to the load balancer
+ (virtual worker) with name âpz2clusterâ.
+ Sticky sessions are enabled and implemented using the âsessionâ parameter.
+ The âProxyâ section lists all the servers (real workers) which the
+ load balancer can use.
+
+
+
+
-
+
@@ -746,51 +839,44 @@
&manref;
- License
-
-
- Pazpar2,
- Copyright © ©right-year; Index Data.
-
-
-
- Pazpar2 is free software; you can redistribute it and/or modify it under
- the terms of the GNU General Public License as published by the Free
- Software Foundation; either version 2, or (at your option) any later
- version.
-
-
-
- Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
- WARRANTY; without even the implied warranty of MERCHANTABILITY or
- FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
- for more details.
-
-
-
- You should have received a copy of the GNU General Public License
- along with Pazpar2; see the file LICENSE. If not, write to the
- Free Software Foundation,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
+
+ License
+
+
+ Pazpar2,
+ Copyright © ©right-year; Index Data.
+
+
+
+ Pazpar2 is free software; you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free
+ Software Foundation; either version 2, or (at your option) any later
+ version.
+
+
+
+ Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
+ WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ for more details.
+
+
+
+ You should have received a copy of the GNU General Public License
+ along with Pazpar2; see the file LICENSE. If not, write to the
+ Free Software Foundation,
+ 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+
&gpl2;
-
+