This is still totally non-functional.
[pazpar2-moved-to-github.git] / doc / pazpar2_conf.xml
index 4e04980..1e7e91b 100644 (file)
@@ -8,7 +8,7 @@
      <!ENTITY % common SYSTEM "common/common.ent">
      %common;
 ]>
-<!-- $Id: pazpar2_conf.xml,v 1.7 2007-01-26 18:53:55 quinn Exp $ -->
+<!-- $Id: pazpar2_conf.xml,v 1.9 2007-03-27 11:25:57 marc Exp $ -->
 <refentry id="pazpar2_conf">
  <refentryinfo>
   <productname>Pazpar2</productname>
              If this item is given, pazpar2 will forward all incoming HTTP
              requests that do not contain the filename 'search.pz2' to the
              host and port specified using the 'host' and 'port'
-             attributes. This functionality is crucial if you wish to use
+             attributes. The 'myurl' attribute is required, and should provide
+             the base URL of the server. Generally, the HTTP URL for the host
+             specified in the 'listen' parameter. This functionality is
+             crucial if you wish to use
              pazpar2 in conjunction with browser-based code (JS, Flash,
              applets, etc.) which operates in a security sandbox. Such code
              can only connect to the same server from which the enclosing
        </varlistentry>
 
        <varlistentry>
+         <term>zproxy</term>
+         <listitem>
+           <para>
+             If this item is given, pazpar2 will send all Z39.50
+             packages through this Z39.50 proxy server.
+              At least one of the 'host' and 'post' attributes is required.
+              The 'host' attribute may contain both host name and port
+             number, seperated by a colon ':', or only the host name.
+              An empty 'host' attribute sets the Z39.50 host address
+             to 'localhost'.  
+           </para>
+         </listitem>
+       </varlistentry>
+
+       <varlistentry>
          <term>service</term>
          <listitem>
            <para>
 
 <server>
   <listen port="9004"/>
-  <proxy host="us1.indexdata.com"/>
+  <proxy host="us1.indexdata.com" myurl="us1.indexdata.com"/>
+
+  <!-- <zproxy host="localhost" port="9000"/> -->
+  <!-- <zproxy host="localhost:9000"/> -->
+  <!-- <zproxy port="9000"/> -->
 
   <service>
     <metadata name="title" brief="yes" sortkey="skiparticle" merge="longest" rank="6"/>