X-Git-Url: http://git.indexdata.com/?p=yazproxy-moved-to-github.git;a=blobdiff_plain;f=doc%2Freference.xml;h=aa5fe2b355ac2bc40fc1fd348b48b75d76c85a57;hp=dde1e4bfbe5c60cd755246992926b119f0bd2be1;hb=2b859f2e51b294bdae9404c97ac25879074b9d87;hpb=3110991d8a797c0e91037e9e615090ec57e22359
diff --git a/doc/reference.xml b/doc/reference.xml
index dde1e4b..aa5fe2b 100644
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -247,7 +247,7 @@
<?xml version="1.0"?>
- <proxy xmlns="http://indexdata.dk/yazproxy/schema/0.8/">
+ <proxy xmlns="http://indexdata.dk/yazproxy/schema/0.9/">
<target name="server1" default="1">
<!-- description of server1 .. -->
</target>
@@ -335,32 +335,37 @@
The proxy records bandwidth/pdu requests during the last 60 seconds
(1 minute). The limit may include the
elements bandwidth, pdu,
- and retrieve. The bandwidth
+ retrieve and search.
+ The bandwidth
measures the number of bytes transferred within the last minute.
The pdu is the number of requests in the last
minute. The retrieve holds the maximum records to
- be retrieved in one Present Request.
+ which may be retrieved in one Present Request.
+ The search is the maximum number of searches
+ within the last minute.
- If a bandwidth/pdu limit is reached the proxy will postpone the
+ If a bandwidth/pdu/search limit is reached the proxy will postpone the
requests to the target and wait one or more seconds. The idea of the
limit is to ensure that clients that downloads hundreds or thousands of
records do not hurt other users.
The following sets maximum number of bytes transferred per minute to
- 500Kbytes and maximum number of requests to 40.
+ 500Kbytes, maximum number of records retrievals to 40
+ and maximum number of searches to 20.
<limit>
<bandwidth>524288</bandwidth>
<retrieve>40</retrieve>
+ <search>20</search>
</limit>
- Typically the limits for keepalive are much higher than
- those for session minute average.
+ Typically the values in the keepalive section are mugh higher
+ than their equivalent limit counterparts (bandwidth, pdu).
@@ -436,6 +441,9 @@
type should be XML. The proxy will use
preferred record syntax USMARC/MARC21 or backendtype
(if given) against the backend target.
+ For the special case where backendtype is
+ opac the proxy will convert the OPAC
+ record to OPACXML.
If attribute backendtype is given, that holds the
@@ -445,8 +453,8 @@
If attribute stylesheet is given, the proxy
will convert XML record from server via XSLT. It is important
that the content from server is XML. If used in conjunction with
- attribute marcxml the MARC to MARCXML conversion
- takes place before the XSLT conversion takes place.
+ attribute marcxml, the MARC to MARCXML/OPACXML
+ conversion takes place before the XSLT conversion takes place.
If attribute identifier is given that is the
@@ -551,6 +559,67 @@
+
+ target-authentication
+
+ The element target-authentication specifies
+ fixed authentication information to be sent to the backend target.
+
+
+ This element takes a an attribute type which is
+ the authenticatin type to be used..
+
+
+ none
+
+
+ No authentication. There is no CDATA associated with this.
+
+
+
+
+ anonymous
+
+
+ Anonymous authentication. There is no CDATA associated with this.
+
+
+
+
+ open
+
+
+ Open authentication. The CDATA consists of the
+ open authentication string.
+
+
+
+
+ idPass
+
+
+ IdPass authentication. The CDATA consists of
+ three terms: user, group and password.
+
+
+
+
+
+
+
+ target-charset
+
+ The element target-charset specifies the
+ native character set that the target uses for queries.
+
+
+ If this is specified the proxy will act as a Z39.50 server
+ supporting character set negotiation. And in SRW/SRU mode
+ it will convert from UTF-8 (UNICODE) to this native character
+ set (if possible).
+
+
+
max-clients
@@ -634,6 +703,13 @@
and the size of the APDU is logged.
+
+ client-ip
+
+ Log the client IP for each log entry. By default, the client IP
+ is only logged when a new session starts.
+
+
@@ -649,6 +725,74 @@
+
+
+ max-connect
+
+ The element max-connect is a child of element
+ proxy and specifies the maximum number
+ of connections to be initiated within the last minute (or
+ value of period-connect.
+
+
+ If the maximum number is reached the proxy will terminate the
+ just initiated session (connection terminated).
+
+
+
+
+ limit-connect
+
+ The element max-connect is a child of element
+ proxy and specifies the limit of number
+ of connections to be initiated within the last minute (or
+ value of period-connect.
+
+
+ If the maximum number is reached the proxy delays the first operation
+ in the session by one second.
+
+
+
+
+ period-connect
+
+ The element period-connect is a child of element
+ proxy and specifies period - in the number of seconds
+ that limit-connect and
+ max-connect
+ should measure connections.
+
+
+ If period-connect is omitted, 60 seconds is used.
+
+
+
+
+ docpath
+
+ The element docpath is a child of element
+ proxy and specifies an allowed HTTP path
+ for local file access. Using docpath the
+ proxy may return static file content.
+
+
+ The value of docpath both serves as a HTTP path prefix
+ and as a local file prefix.
+ If a value of etc is used only URLs with the
+ prefix /etc/ results in a local file access to the
+ directory etc within the working directory
+ of yazproxy.
+
+
+
+ Care has been taken to ensure that hostile URLs are rejected - including
+ strings such as .. and / (absolute
+ file system access).
+
+
+
+
Proxy Manual Pages
@@ -696,7 +840,7 @@