X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Ffrontend.xml;h=2ff6ed94c938a7374f165a0c053defd4a3e69456;hb=a4c13e5a8035fed703ebcd1580e9dcfdd9929722;hp=cbb533ac2e7c02f615ff3ba68c753978b63302c4;hpb=a4500a53ecbff46db730bcaa8703d2c9a0e6328b;p=yaz-moved-to-github.git diff --git a/doc/frontend.xml b/doc/frontend.xml index cbb533a..2ff6ed9 100644 --- a/doc/frontend.xml +++ b/doc/frontend.xml @@ -1,4 +1,4 @@ - + Generic server Introduction @@ -13,7 +13,7 @@ If you have a database system that you would like to make available by - means of Z39.50 or SRW, &yaz; basically offers your two options. You + means of Z39.50, SRW o SRU, &yaz; basically offers your two options. You can use the APIs provided by the &asn;, &odr;, and &comstack; modules to create and decode PDUs, and exchange them with a client. @@ -232,7 +232,7 @@ statserv_options_block *statserv_getcontrol(void); int idle_timeout; Maximum session idle-time, in minutes. Zero indicates - no (infinite) timeout. Default is 120 minutes. + no (infinite) timeout. Default is 15 minutes. @@ -546,10 +546,10 @@ typedef struct bend_fetch_rr { that holds the reference to the desired record. The number is the offset into the set (with 1 being the first record in the set). The format field - is the record format requested by the client (See section - Object Identifiers). The value - VAL_NONE indicates that the client did not - request a specific format. The stream argument + is the record format requested by the client (See + ). + The value VAL_NONE indicates that the client did + not request a specific format. The stream argument is an &odr; stream which should be used for allocating space for structured data records. The stream will be reset when all records have been assembled, and @@ -729,6 +729,9 @@ typedef struct bend_scan_rr { appname + + + @@ -739,7 +742,8 @@ typedef struct bend_scan_rr { - + + listener-spec @@ -764,7 +768,7 @@ typedef struct bend_scan_rr { hostname | IP-number [: portnumber] - + The port number defaults to 210 (standard Z39.50 port). @@ -774,22 +778,59 @@ typedef struct bend_scan_rr { - For TCP/IP and SSL, the special hostname "@" is mapped to - the address INADDR_ANY, which causes the - server to listen on any local interface. - - - - Examples: - - tcp:@:210 - - ssl:@:3000 - - unix:/tmp/yaz - + For TCP/IP and SSL, the special hostname @ + (at sign) is mapped to the address INADDR_ANY, + which causes the server to listen on any local interface. + Running the GFS on Unix + + Assuming the server application appname is + started as root, the following will make it listen on port 210. + The server will change identity to nobody + and write its log to /var/log/app.log. + + appname -l /var/log/app.log -u nobody tcp:@:210 + + + + The server will accept Z39.50 requests and offer SRW/SRU service + on port 210. + + + Setting up Apache as SRW/SRU Frontend + + If you use Apache + as your public web server and want to offer HTTP port 80 + access to the YAZ server on 210, you can use the + + ProxyPass + directive. + If you have virtual host + srw.mydomain you can use the following directives + in Apache's httpd.conf: + + <VirtualHost *> + ErrorLog /home/srw/logs/error_log + TransferLog /home/srw/logs/access_log + ProxyPass / http://srw.mydomain:210/ + </VirualHost> + + + + The above for the Apache 1.3 series. + + + Running a server with local access only + + Servers that is only being accessed from the local host should listen + on UNIX file socket rather than a Internet socket. To listen on + /tmp/mysocket start the server as follows: + + appname tcp:/tmp/mysocket + + +