X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=doc%2Fzebrasrv-virtual.xml;h=63d4d27610ed984606d20d19d390188ed5143db9;hp=992a43b061f27b370eec5193c0fa90486420a5b1;hb=6c5467571389a21c91196ce1608945633c1cf92a;hpb=47054fae00306e75212a26ee5305f00032c99001 diff --git a/doc/zebrasrv-virtual.xml b/doc/zebrasrv-virtual.xml index 992a43b..63d4d27 100644 --- a/doc/zebrasrv-virtual.xml +++ b/doc/zebrasrv-virtual.xml @@ -1,37 +1,36 @@ - The Virtual hosts mechanism allows a YAZ frontend server to + The Virtual hosts mechanism allows a &yaz; frontend server to support multiple backends. A backend is selected on the basis of - the TCP/IP binding (port+listening adddress) and/or the virtual host. + the TCP/IP binding (port+listening address) and/or the virtual host. A backend can be configured to execute in a particular working - directory. Or the YAZ frontend may perform CQL to RPN conversion, thus - allowing traditional Z39.50 backends to be offered as a SRW/ SRU - service. SRW/ SRU Explain information for a particular backend may also - be specified. + directory. Or the &yaz; frontend may perform &acro.cql; to &acro.rpn; conversion, thus + allowing traditional &acro.z3950; backends to be offered as a +&acro.sru; service. + &acro.sru; Explain information for a particular backend may also be specified. For the HTTP protocol, the virtual host is specified in the Host header. - For the Z39.50 protocol, the virtual host is specified as in the + For the &acro.z3950; protocol, the virtual host is specified as in the Initialize Request in the OtherInfo, OID 1.2.840.10003.10.1000.81.1. - Not all Z39.50 clients allows the VHOST information to be set. + Not all &acro.z3950; clients allows the VHOST information to be set. For those the selection of the backend must rely on the TCP/IP information alone (port and address). - The YAZ frontend server uses XML to describe the backend + The &yaz; frontend server uses &acro.xml; to describe the backend configurations. Command-line option -f - specifies filename of the XML configuration. + specifies filename of the &acro.xml; configuration. The configuration uses the root element yazgfs. @@ -87,7 +86,7 @@ Specifies listener for this server. If this attribute is not given, the server is accessible from all listener. In order - for the server to be used for real, howeever, the virtual host + for the server to be used for real, however, the virtual host must match (if specified in the configuration). @@ -107,7 +106,7 @@ Specifies a working directory for this backend server. If - specifid, the YAZ fronend changes current working directory + specified, the &yaz; frontend changes current working directory to this directory whenever a backend of this type is started (backend handler bend_start), stopped (backend handler hand_stop) and initialized (bend_init). @@ -128,9 +127,9 @@ element cql2rpn (optional) - Specifies a filename that includes CQL to RPN conversion for this - backend server. See CQL section in YAZ manual. - If given, the backend server will only "see" a Type-1/RPN query. + Specifies a filename that includes &acro.cql; to &acro.rpn; conversion for this + backend server. See &acro.cql; section in &yaz; manual. + If given, the backend server will only "see" a Type-1/&acro.rpn; query. @@ -138,15 +137,15 @@ element explain (optional) - Specifies SRW/ SRU ZeeRex content for this server. Copied verbatim - to the client. As things are now, some of the Explain content - seems redundant because host information, etc. is also stored - elsewhere. + Specifies &acro.sru; ZeeRex content for this + server - copied verbatim to the client. + As things are now, some of the Explain content seems redundant + because host information, etc. is also stored elsewhere. The format of the Explain record is described in detail, with - examples, on the file ZeeRex web-site, - . + examples, on the file at the + ZeeRex web-site. @@ -154,7 +153,7 @@ - The XML below configures a server that accepts connections from + The &acro.xml; below configures a server that accepts connections from two ports, TCP/IP port 9900 and a local UNIX file socket. We name the TCP/IP server public and the other server internal. @@ -199,7 +198,8 @@ elements. - For "server2" elements for CQL to RPN conversion + For "server2" elements for +&acro.cql; to &acro.rpn; conversion is supported and explain information has been added (a short one here to keep the example small). @@ -208,9 +208,17 @@ via listener "internal". - -