X-Git-Url: http://git.indexdata.com/?p=yazproxy-moved-to-github.git;a=blobdiff_plain;f=doc%2Freference.xml;h=bdbb9e36d6200dc8cf86e582fbeba4d412a8a4b6;hp=3e52ecbe14dde799d9fdd420a55f0459ce885ec8;hb=029fd8c83fa3446b8a11b30017b731c75c3465e9;hpb=ed9164aba11e6999f5af55a015c63649343fe354 diff --git a/doc/reference.xml b/doc/reference.xml index 3e52ecb..bdbb9e3 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,32 +559,6 @@ -
- max-clients - - The element max-clients is the child of element - proxy and specifies the total number of - allowed connections to targets (all targets). If this limit - is reached the proxy will close the least recently used connection. - - - Note, that many Unix systems impose a system on the number of - open files allowed in a single process, typically in the - range 256 (Solaris) to 1024 (Linux). - The proxy uses 2 sockets per session + a few files - for logging. As a rule of thumb, ensure that 2*max-clients + 5 - can be opened by the proxy process. - - - - Using the - bash shell, you can set the limit with - ulimit -nno. - Use ulimit -a to display limits. - - -
-
target-authentication @@ -624,6 +606,46 @@
+
+ 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 + + The element max-clients is the child of element + proxy and specifies the total number of + allowed connections to targets (all targets). If this limit + is reached the proxy will close the least recently used connection. + + + Note, that many Unix systems impose a system on the number of + open files allowed in a single process, typically in the + range 256 (Solaris) to 1024 (Linux). + The proxy uses 2 sockets per session + a few files + for logging. As a rule of thumb, ensure that 2*max-clients + 5 + can be opened by the proxy process. + + + + Using the + bash shell, you can set the limit with + ulimit -nno. + Use ulimit -a to display limits. + + +
+
log @@ -696,6 +718,58 @@
+ +
+ 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. + + + 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. + + + If the maximum number is reached the proxy delay the first operatation + in the session (Thus delaying the connection). + +
+ +
+ 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 @@ -743,7 +817,7 @@